Metalsmith plugin to create Atomic CSS automatically from your HTML using Atomizer.
JavaScript
Switch branches/tags
Clone or download

README.md

metalsmith-atomizer

Metalsmith plugin to use Atomizer to build your Atomic CSS.

npm version Build Status Dependencies Dev Dependencies codecov.io

Installation

npm can do this for you.

npm install --save metalsmith-atomizer

Usage

Include this like you would include any other plugin. First, a CLI example that also shows the default options. You don't need to specify any options unless you want to change their values.

{
    "plugins": {
        "metalsmith-atomizer": {
            "acssConfig": {},
            "addRules": {},
            "bufferEncoding": "utf8",
            "destination": "atomic.css",
            "destinationMode": "0644",
            "forget": false,
            "match": "**/*.{html,htm}",
            "matchOptions": {},
            "setOptions": {}
        }
    }
}

And this is a JavaScript example that also includes a brief explanation of the options.

// Load this, just like other plugins.
var atomizer = require("metalsmith-atomizer");

// Then in your list of plugins you use it.
.use(atomizer())

// Alternately, you can specify options.  The values shown here are
// the defaults.  Dig into atomizer's src/atomizer.js to understand
// all of these options in depth.
.use(atomizer({
    // Atomic CSS config passed to Atomizer.  Use this to assign custom
    // values, breakpoints, etc.  It also can be used to force some
    // classes to always be generated.
    acssConfig: {},

    // Another undocumented feature of Atomizer to create custom ACSS
    // "functions".  Calls .addRules() with this configuration.
    addRules: {},

    // When converting file buffers to strings for Atomizer and strings
    // into buffers, which encoding should be used?
    bufferEncoding: "utf8",

    // Name of the generated file.
    destination: "atomic.css",

    // File permissions of the generated CSS file.
    destinationMode: "0644",

    // Set to true if the list of detected CSS rules should be forgotten.
    // Remembering these rules helps the plugin work with
    // metalsmith-watch and similar plugins.
    forget: false,

    // Pattern of files to match
    match: "**/*.{html,htm}",

    // Options for matching files.  See metalsmith-plugin-kit.
    matchOptions: {},

    // Custom CSS generation options to pass to Atomizer's .getCSS()
    // function.  It allows changing things like rtl and namespace.
    setOptions: {}
})

This uses metalsmith-plugin-kit to match files. The .matchOptions object can be filled with options to control how the matching works.

This plugin also can display the classes found by each processed file. Enable debugging by setting the DEBUG environment variable when running your build.

DEBUG=metalsmith-atomizer metalsmith

metalsmith-atomizer remembers the detected CSS rules between runs. This makes it work far better with metalsmith-watch and other plugins that perform the same sort of action. If you add and remove CSS classes, the plugin keeps track of what file added what Atomic CSS rules and updates the result accordingly. This allows for incremental or partial builds of your project. If this is undesirable, set forget to true.

API

metalsmith-atomizer

Metalsmith Atomizer constructs Atomic CSS from HTML markup in your Metalsmith build process.

See

Example

var atomizer = require("metalsmith-atomizer");

// Make the Metalsmith instance and add this plugin as middleware.
metalsmith.use(atomizer({
    // options go here
}));

module.exports(options) ⇒ function

Factory to build middleware for Metalsmith.

Kind: Exported function
Params

  • options Object

module.exports~combineClasses(classesByFile) ⇒ Array.<string>

Builds an array of every mentioned class name inside the classesByFile object.

Kind: inner method of module.exports
Params

  • classesByFile Object.<string, string>

module.exports~options : Object

Options supported by the middleware factory.

Kind: inner typedef of module.exports
See

Properties

  • acssConfig Object - Atomic CSS configuration.
  • addRules false | Object - Additional Atomic CSS rules.
  • bufferEncoding string - Used when parsing file contents.
  • destination string - File to generate.
  • destinationMode string - Permissions for the generated file.
  • forget boolean - If true, previous Atomic rules are forgotten. Must be false when using this plugin with caching or limited builds (eg. metalsmith-watch).
  • match module:metalsmith-plugin-kit~matchList - Files to match. Defaults to *.htm and *.html.
  • matchOptions module:metalsmith-plugin-kit~matchOptions - Options controlling matching behavior.
  • setOptions Object - Used for generating Atomic CSS and can control rtl and namespace.

Development

This uses Jasmine, Istanbul and ESLint for tests.

# Install all of the dependencies
npm install

# Run the tests
npm run test

This plugin is licensed under the MIT License with an additional non-advertising clause. See the full license text for information.