The compiler is a small autonomous Node.js module that can be used programmatically from JavaScript or directly from the CLI.
To use the module is enough to invoke it passing a source folder, the folder will be traversed and all the CSS files will be compiled as css-modules
, all the generated CSS files will be merged, deduped and optimized into a single CSS file. All the es2015
modules will be checked using an AST parser and all the css
import declaration will be substituted with a static object containing the generated CSS class names.
The compile command accepts several options: the postcss plugins to be used when compiling css files, a blacklist of patterns used to avoid compilation of non-css-modules
files, a target folder to duplicate the source and avoid changing the original sources and more.
See the official documentation
css-modules-compiler
is available as npm
module, to use it on your project run:
npm install --save-dev css-modules-compiler
npm test
To try the module clone the repository, install npm
dependencies and then run the following commands to see it in action.
npm run examples:basic
npm run examples:advanced