metalsmith-collections-filter

A plugin to filter items in a Metalsmith collection.

Features

filters out items from a collection using predicate test
supports filters defined as a Function
supports filters defined as an Object
supports filters defined as an Array
supports filters defined as a String

Installation

$ npm install --save-dev metalsmith-collections-filter

Usage

Configure your build

import filterCollections from 'metalsmith-collections-filter'

metalsmith
  .use(collections())
  .use(filterCollections({
    articles: function(article) {
      return article.featured
    }
  }))

Optionally define simple filters with an object

metalsmith.use(filterCollections({
  articles: { featured: true }
}))

Or as an array

metalsmith.use(filterCollections({
  articles: ['featured', true]
}))

Filters matching a boolean value can also be defined as a string

metalsmith.use(filterCollections({
  articles: 'featured'
}))

Dedicated collections can be defined and then filtered

metalsmith
  .use(collections({ featuredArticles: '*.md' }))
  .use(filterCollections({
    featuredArticles: function(article) {
      return article.collection.contains('articles') &&
        article.featured
    }
  }))

CLI Usage

Filters cannot be defined as functions in the Metalsmith CLI

{
  "plugins": {
    "metalsmith-collections-filter": {
      "articles": { "featured": true }
    }
  }
}

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.