css-modules-flow-types-cli

CLI for creating flow definitions from CSS Modules files

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
css-modules-flow-types-cli
9372.0.03 years ago7 years agoMinified + gzip package size for css-modules-flow-types-cli in KB

Readme

css-modules-flow-types-cli npm version
CLI for creating Flow type definitions based on CSS Modules files.
This gives you:
  • auto-completing for css files in most editors
  • flow type safety showing usage of non existing classes

Example

Given the following css file using CSS Modules:
@value primary: red;

.myClass {
  color: primary;
}

css-modules-flow-types creates the following .flow file next to it:
// @flow
/* This file is automatically generated by css-modules-flow-types */
declare module.exports: {|
  +'myClass': string;
  +'primary': string;
|};

Usage

$ npm install --dev css-modules-flow-types-cli
$ yarn install -D css-modules-flow-types-cli

This installs the runner as css-modules-flow-types.
And run css-modules-flow-types <input directory or glob> command.
For example, if you have .css files under src directory, exec the following:
Running,
css-modules-flow-types src

Creates *.css.flow files next to all css files.
(your project root)
- src/
    | myStyle.css
    | myStyle.css.flow [created]

Inspiration

  • https://github.com/Quramy/typed-css-modules
  • https://github.com/Jimdo/typings-for-css-modules-loader

License

This software is released under the MIT License.