Have ideas to improve npm?Join in the discussion! »

    metadata-filter
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    metadata-filter Test NPM Codacy Coverage

    A module for cleaning up artist, album, and song names.

    Installation

    Install using npm

    npm i metadata-filter
    

    Include via CDN

    <script src="https://unpkg.com/metadata-filter@latest/dist/filter.min.js"></script>

    Usage

    If you want to use this module in a project which is built with a bundler (e.g. webpack), you can use CommonJS-like or ES6 imports:

    // CommonJS style
    const MetadataFilter = require('metadata-filter');
    
    // ES6 style
    import * as MetadataFilter from 'metadata-filter';
    
    MetadataFilter.removeRemastered(yourInput);

    In a browser you can access to the module by using the global MetadataFilter object:

    <!-- Assume you have `metadata-filter` module included with `script` tag -->
    <script lang="javascript">
    	MetadataFilter.removeRemastered(yourInput);
    </script>

    Single filter functions

    You can call filter functions for basic, one-line filter functionality. These filter functions are intended to be used on a single field, such as an artist, album, or track.

    However, it is possible (not officially supported) to use some of these on combined fields ("Artist - Song", "Artist - Album"), as in the third example below.

    console.log(MetadataFilter.removeRemastered('Jane Doe (Remastered)')); // Jane Doe
    console.log(MetadataFilter.removeVersion('Get Lucky (Album Version)')); // Get Lucky
    console.log(
    	MetadataFilter.youtube(
    		'Car Bomb - Scattered Sprites (Official Music Video)'
    	)
    ); // Car Bomb - Scattered Sprites

    See src/functions.ts for more details.

    Combine filter functions

    You can also use multiple filter functions on a string at once by creating a MetadataFilter object which combines multiple functions from above, or by using one of the pre-existing filter objects.

    First, create a filter set. This is a set of filter functions for different fields.

    const filterSet = {
    	track: [
    		MetadataFilter.removeRemastered,
    		MetadataFilter.fixTrackSuffix,
    		MetadataFilter.removeLive,
    	],
    	album: [
    		MetadataFilter.removeRemastered,
    		MetadataFilter.fixTrackSuffix,
    		MetadataFilter.removeLive,
    	],
    };

    Then, construct a MetadataFilter using this filter set.

    const filter = MetadataFilter.createFilter(filterSet);
    console.log(filter.filterField('album', 'Nevermind (Remastered)')); // Nevermind
    console.log(filter.filterField('track', 'In Bloom - Nevermind Version')); // In Bloom (Nevermind Version)

    Predefined filters

    There are also predefined filters available for easy access. For example, the above filter set can be acquired using createSpotifyFilter() function:

    const filter = MetadataFilter.createSpotifyFilter();

    See src/filters.ts for more details.

    Extending filters

    Finally, you can take existing MetadataFilter objects and extend them with another filter. This is done by providing the .extend() method with another MetadataFilter object.

    const filter = MetadataFilter.createSpotifyFilter();
    
    filter.extend(MetadataFilter.createAmazonFilter());
    // This would also work: filter.extend(MetadataFilter.createFilter(filterSet));
    
    console.log(
    	filter.filterField('track', 'Seasons in the Abyss (Album Version)')
    ); // Seasons in the Abyss

    As an alternative, you can use the .append() method to apply a filter set to an existing MetadataFilter object.

    const filter = MetadataFilter.createFilter({ track: filterTrack });
    
    filter.append({ artist: filterArtist });

    Since these methods return a MetadataFilter instance, you can chain method calls.

    const filter = MetadataFilter.createFilter({ track: filterTrack }).append({
    	artist: filterArtist,
    });

    Development

    # Install dev dependencies
    > npm install
    
    # Build the dist file
    > npm run build
    
    # Format files
    > npm run format
    
    # Lint source files
    > npm run lint
    
    # Run tests
    > npm test
    
    # Run tests with a coverage report
    > npm run test-with-coverage

    License

    Licensed under the MIT License.

    Install

    npm i metadata-filter

    DownloadsWeekly Downloads

    58

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    76.3 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar