Stylelint plugin

Stylelint plugin for use with the Atlassian Design System.

Usage Code Configuration and setup Changelog

This plugin contains rules that should be used with the Atlassian Design System.

You can read more about configuring Stylelint in their documentation, (opens new window).

Configuration

Add the plugin to your Stylelint configuration file.

// .stylelintrc.js

module.exports = {
  plugins: [
+    '@atlaskit/stylelint-design-system',
  ],
};

Enable any desired rules. The rules and options shown below are strongly recommended.

module.exports = {
  rules: {
+    'design-system/ensure-design-token-usage': { color: true, spacing: true },
+    'design-system/no-deprecated-design-token-usage': true,
+    'design-system/no-unsafe-design-token-usage': [true, { shouldEnsureFallbackUsage: true }]
  },
};

Was this page helpful?

We use this feedback to improve our documentation.