stylelint-config-fluid

Shareable Stylelint configuration for the Fluid Project.

Using

To use the stylelint configuration provided by this module, add it as a dev dependency to your project:

npm install stylelint-config-fluid --save-dev --save-exact

Then, add an extends property to your .stylelintrc.json file.

{
    "extends": "stylelint-config-fluid"
}

Extending or Overriding Configuration

When using the stylelint configuration provided by this module, you may have a case where you'd like to adjust or extend the configuration. To do this, add any additional configuration to your own .stylelintrc.json file, which extends the one held in this project.

In the following example, we want to change the indentation rule to tabs. The default configuration provided by the model sets the indentation rule to 4 (four spaces), so we need to extend the configuration with a supplementary indentation rule which overrides the default.

{
    "extends": "stylelint-config-fluid",
    "rules": {
        "indentation": "tab"
    }
}

See the stylelint user guide for more options.

Developing

See the stylelint user guide for full details on configuration techniques.

Modifying configuration

To modify the stylelint rules provided by this module, update the configuration in the .stylelintrc.json file. See the stylelint user guide for configuration options.

Testing

To test your changes locally, link the package globally on your system.

# Run from the stylelint-config-fluid directory.
# Depending on your system, you may need to use sudo.
npm link

Add your linked module to the package you want to test in.

# Run in the root directory for the package with which you want to test the configuration.
npm link stylelint-config-fluid

Remove the links to clean up the test settings.

# Run from the stylelint-config-fluid directory.
# Depending on your system, you may need to use sudo.
npm unlink

# Run in the root directory for the package with which you tested the configuration.
npm unlink stylelint-config-fluid

# Run the install again to ensure that all the dependencies are properly installed.
npm install

Releasing

This module uses Conventional Commits, enforced with commitlint. This facilitates releasing new versions of the module. Release pull requests are generated using Release Please.

To cut a release, review and merge the release pull request. This will tag an appropriate semantic version based on the nature of the recent commits to the project and update the changelog.

You will then need to publish the updated version to the npm registry. This requires an npm account with appropriate maintainer permissions. To publish the module, run:

npm publish

For more information on publishing to npm, see the npm publish documentation.