@shopify/stylelint-polaris/plugins/coverage/index.test.js

Polaris Design System Stylelint tooling

const path = require('path');

const {ruleName} = require('.');

const config = {
  colors: [
    {
      'color-named': 'never',
      'color-no-hex': [
        true,
        {message: 'Appended Stylelint rule config message'},
      ],
    },
    {
      message: 'Appended category rule config message',
    },
  ],
  motion: {
    'at-rule-disallowed-list': [['keyframes'], {severity: 'warning'}],
  },
  legacy: {
    // Test case for calling `checkAgainstRule` with custom rules
    'polaris/global-disallowed-list': [/--p-legacy-var/],
  },
};

testRule({
  ruleName,
  plugins: [__dirname, path.resolve(__dirname, '../global-disallowed-list')],
  config,
  customSyntax: 'postcss-scss',
  accept: [
    {
      code: '@media (min-width: 320px) {}',
      description: 'Uses allowed at-rule',
    },
  ],

  reject: [
    {
      code: '.class {color: #bad;}',
      description: 'Overrides appended category rule warning text (string)',
      message:
        'Unexpected hex color "#bad" - Appended Stylelint rule config message - https://polaris.shopify.com/tools/stylelint-polaris/rules/colors-color-no-hex',
    },
    {
      code: '.class {color: red;}',
      description: 'Appends message to category rule warning text',
      message:
        'Unexpected named color "red" - Appended category rule config message - https://polaris.shopify.com/tools/stylelint-polaris/rules/colors-color-named',
    },
    {
      code: '@keyframes foo {}',
      description: 'Uses disallowed at-rule (built-in rule)',
      message:
        'Unexpected at-rule "keyframes" - https://polaris.shopify.com/tools/stylelint-polaris/rules/motion-at-rule-disallowed-list',
    },
    {
      code: '.class {color: var(--p-legacy-var);}',
      description: 'Uses disallowed legacy variable (custom rule)',
      message:
        'Unexpected disallowed value "--p-legacy-var" - https://polaris.shopify.com/tools/stylelint-polaris/rules/legacy-global-disallowed-list',
    },
  ],
});