@shopify/stylelint-polaris/plugins/at-rule-disallowed-list/index.test.js

Polaris Design System Stylelint tooling

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

const disallowedIncludeRegExp = /^([\w-]+\.)?disallowed-include($|\()/;
const disallowedMixinRegExp = /^disallowed-mixin($|\()/;

testRule({
  ruleName,
  plugins: [__dirname],
  config: {
    // Using a RegExp ensures we disallow `@mixin id` and `@mixin id()`
    // https://regex101.com/r/PJYwuP/1
    mixin: [disallowedMixinRegExp],
    include: [
      disallowedIncludeRegExp,
      /^prefix-.+/,
      'disallowed-include-literal',
    ],
    // Nifty pattern to disallow the usage of a given at-rule.
    disallowedAtRuleName: [/.*/],
  },
  accept: [
    {
      code: '@mixin allowed-mixin {}',
      description: 'Defining an allowed mixin name',
    },
    {
      code: '@mixin allowed-mixin($value) {}',
      description: 'Defining an allowed mixin name with parameters',
    },
    {
      code: '@include allowed-include {}',
      description: 'Defining an allowed include name',
    },
    {
      code: '@include allowed-include() {}',
      description: 'Defining an allowed include name with parameters',
    },
    {
      code: '@include disallowed-mixin-not {}',
      description: 'Defining an allowed include name',
    },
    {
      code: '@include disallowed-mixin-not() {}',
      description: 'Defining an allowed include name with parameters',
    },
    {
      code: '@include valid-prefix-mixin {}',
      description: 'Defining an allowed include name with a valid prefix',
    },
  ],
  reject: [
    {
      code: `@include disallowed-include-literal {}`,
      description: 'Defining a disallowed include name as a string literal',
      message: messages.rejected(
        'include',
        'disallowed-include-literal',
        'disallowed-include-literal',
      ),
    },
    {
      code: `@include namespace.disallowed-include {}`,
      description: 'Defining a disallowed include name with a namespace',
      message: messages.rejected(
        'include',
        'namespace.disallowed-include',
        disallowedIncludeRegExp.source,
      ),
    },
    {
      code: '@mixin disallowed-mixin {}',
      description: 'Defining a disallowed mixin name',
      message: messages.rejected(
        'mixin',
        'disallowed-mixin',
        disallowedMixinRegExp.source,
      ),
    },
    {
      code: '@mixin disallowed-mixin($value) {}',
      description: 'Defining a disallowed mixin name with parameters',
      message: messages.rejected(
        'mixin',
        'disallowed-mixin($value)',
        disallowedMixinRegExp.source,
      ),
    },
    {
      code: '@include prefix-mixin {}',
      description: 'Defining an include name with a disallowed prefix',
      message: messages.rejected('include', 'prefix-mixin', '^prefix-.+'),
    },
    {
      code: '@disallowedAtRuleName {}',
      description: 'Defining a disallowed at-rule',
      message: messages.rejected('disallowedAtRuleName', '', '.*'),
    },
    {
      code: '@disallowedAtRuleName at-rule-id {}',
      description: 'Defining a disallowed at-rule with a custom at-rule-id',
      message: messages.rejected('disallowedAtRuleName', 'at-rule-id', '.*'),
    },
  ],
});