cef62 / css-modules-compiler

Compile CSS Modules to static CSS and remove non-standard code from the JavaScript files

Hi there 👋

css-modules-compiler's Issues

Add docs and examples

Add documentation for the API in the readme and some usage examples.

Support blacklisting for css files

Often the source folder contains both local and global css files. The module should be able to ignore css files based on user defined patterns.

For example: ignore all css files matching *.global.
Also should be possible to request to copy without modification all the filtered css.

Cleaner file names

Wouldn't it be better to rename the files in the following way?

src/css-modules-compiler.js => src/compiler.js
src/css-modules-extractor.js => src/extractor.js
src/update-css-modules-imports.js => src/update-imports.js (or just src/updater.js for consistency)
bin/css-module-compiler.js => bin/css-modules-compiler.js

What do you think @cef62?

Remane default 'style.css' to 'styles.css'

I don't have a strong opinion on it, but I feel that 'styles.css' sounds better :)
What do you think?

Make <source> the default param

I was about to start writing the docs for the cli when I realised that we should accept the source folder as the first parameter (without any flag), like:

css-modules-compiler compile <source> [options]

What do you think @cef62?

Remove console.*

We should avoid using console.* and use a proper logger library that gets activated by a verbose or debug flag.

Split the compiler into smaller modules

The compiler is supposed to only compose the submodules but at the moment it has some logic inside and it counts more than 100 lines.
We should split it into smaller (and more testable) submodules.

My idea:

transformer
convertCssMapToAst
convertCssMapToAstMap

utils
updateFilesystem
cleanCss
concatenateCss
copySourceFolder

optimizer
clearJsonMap

Any thoughts @cef62?
More than happy to do it but I want your ok to proceed : )

Remove unused css classes from json map

If a class only composes other classes (without adding any styles) it gets compiled as an empty class.
It would be nice to remove those empty classes from the json map.

Module Requirements

This thread will be used to discuss initial goals and requirements for the compiler. The list of features will be used to design the compiler.

Error On Compilation

I'm guessing this project is abandoned, but in case it isn't, I'm getting the following errors when running:

css-modules-compiler compile ./src -t ./lib

Error Message (One for every js file)

(node:95993) Warning: a promise was rejected with a non-error: [object Undefined]

The CSS file is successfully generated, but the JS files are just copied to the output directory - no styles object is added.

Version 1.0.0
Node v6.9.5

Improve test assertions

Should we add power-assert to improve the messages for errors with the tests assertions?

Support postcss plugins configuration from CLI

Currently it's possibile to configure postcss plugins only using the javascript API of the module. We should support it also for the CLI.