stylelint-css-modules

Extended ruleset for stylelint on CSS modules

Example usage

1. Install

npm install stylelint-css-modules --save-dev

2. Configure

plugins: [
  'stylelint-css-modules',
],
rules: {
  'css-modules/composed-class-names': true,
  'css-modules/css-variables': true,
},

3. Advanced configuration

The stylelint plugin uses enhanced-resolve to find referenced files. Each rule can configure the resolver with a resolve object. By default, this stylelint plugin is configured with:

{
  resolve: {
    extensions: ['.css'],
  },
}

In order to find SASS files, add an additional extension:

plugins: [
  'stylelint-css-modules',
],
rules: {
  'css-modules/composed-class-names': true,
  'css-modules/css-variables': [true, {
    resolve: {
      extensions: ['.css', '.scss'],
    },
  }],
},

In order to leverage the SASS ~ operator, add an additional module:

plugins: [
  'stylelint-css-modules',
],
rules: {
  'css-modules/composed-class-names': true,
  'css-modules/css-variables': [true, {
    resolve: {
      modules: ['node_modules', 'app/src'],
    },
  }],
},

Contributing

1. Fork
2. Install with a variant of Stylelint
   • npm run test9
   • npm run test10
   • npm run test11
   • npm run test12
   • npm run test13
3. Test: npm test (for running tests without installing Stylelint)
4. Submit a Pull Request

We are looking for simple and tested code. A green build is a requirement.

Ruleset

css-modules/composed-class-names

Ensures each composed class name exists in the targeted file.

Good

.solo-class {}

.nested-root .intermediary-node .nested-child {}

.chained-root.chained-node.chained-child {}

.lots-of-compositions {
  composes: solo-class;
  composes: nested-root;
  composes: intermediary-node;
  composes: nested-child;
  composes: chained-root;
  composes: chained-node;
  composes: chained-child;
  composes: solo-class nested-child;
  composes: global from global;
  composes: baz from './baz.css';
}

where baz.css:

.baz {}

Bad

.lots-of-compositions {
  composes: does-not-exist;
  composes: does-not-exist from './baz.css';
}

where baz.css

.baz {}

css-modules/css-variables

Ensures each CSS variable is defined locally or in some imported file unless it has a fallback.

Good

@import './baz.css';

:root {
  --some-var: 1;
}

.foo {
  margin: var(--some-var);
  padding: var(--baz-some-var);
  padding: var(--bar-some-var, 10px);
}

where baz.css:

:root {
  --bar-some-var: 1;
}

Bad

.foo {
  margin: var(--some-undefined-var);
  padding: var(--baz-some-var);
}

where baz.css:

:root {
  --bar-some-var: 1;
}