@dtwojs/stylelint-module NPM

@dtwojs/stylelint-module

Stylelint module for Dtwo.js

Requirements

You need to ensure that you have stylelint installed:

yarn add --dev stylelint # or npm install --save-dev stylelint

Setup

Add @dtwojs/stylelint-module dependency to your project

yarn add --dev @dtwojs/stylelint-module # or npm install --save-dev @dtwojs/stylelint-module

Add @dtwojs/stylelint-module to the buildModules section of dtwo.config.js

export default {
  buildModules: [
    // Simple usage
    '@dtwojs/stylelint-module',

    // With options
    ['@dtwojs/stylelint-module', { /* module options */ }]
  ]
}

:warning: If you are using Dtwo < v2.9 you have to install the module as a dependency (No --dev or --save-dev flags) and use modules section in dtwo.config.js instead of buildModules.

Using top level options

export default {
  buildModules: [
    '@dtwojs/stylelint-module'
  ],
  stylelint: {
    /* module options */
  }
}

Options

See stylelint's options for the complete list of options available. These options are passed through to the stylelint directly.

`configFile`

Type: String
Default: undefined

Specify the config file location to be used by stylelint.

Note: By default this is handled by stylelint.

`context`

Type: String
Default: srcDir

A string indicating the root of your files.

`files`

Type: String|Array[String]
Default: ['assets/**/*.{s?(a|c)ss,less,stylus}', '{components,layouts,pages}/**/*.kdu']

Specify the glob pattern for finding files. Must be relative to options.context.

`fix`

Type: Boolean
Default: false

If true, stylelint will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See Autofixing errors docs.

`formatter`

Type: Function
Default: require('stylelint').formatters.string

Specify the formatter that you would like to use to format your results.

`lintDirtyModulesOnly`

Type: Boolean
Default: false

Lint only changed files, skip lint on start.

`stylelintPath`

Type: String
Default: stylelint

Path to stylelint instance that will be used for linting.

Errors and Warning

By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts. You can still force this behavior by using emitError or emitWarning options: