@primer/stylelint-config 13.0.0-rc.fe9ab86 → 13.0.1-rc.5358628

package/dist/index.cjs

@@ -7,7 +7,7 @@ var valueParser = require('postcss-value-parser');
 var node_module = require('node:module');
 var anymatch = require('anymatch');
 var TapMap = require('tap-map');
-var variables$1 = require('@primer/css/dist/variables.json');
+var variables$3 = require('@primer/css/dist/variables.json');
 var matchAll = require('string.prototype.matchall');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
@@ -197,6 +197,14 @@ function primitivesVariables(type) {
     case 'border':
       files.push('functional/size/border.json');
       break
+    case 'typography':
+      files.push('base/typography/typography.json');
+      files.push('functional/typography/typography.json');
+      break
+    case 'box-shadow':
+      files.push('functional/themes/light.json');
+      files.push('functional/size/border.json');
+      break
   }
 
   for (const file of files) {
@@ -229,12 +237,12 @@ function walkGroups$1(root, validate) {
 }
 
 const {
-  createPlugin: createPlugin$1,
-  utils: {report: report$1, ruleMessages: ruleMessages$1, validateOptions: validateOptions$1},
+  createPlugin: createPlugin$3,
+  utils: {report: report$3, ruleMessages: ruleMessages$3, validateOptions: validateOptions$3},
 } = stylelint;
 
-const ruleName$3 = 'primer/borders';
-const messages$3 = ruleMessages$1(ruleName$3, {
+const ruleName$5 = 'primer/borders';
+const messages$5 = ruleMessages$3(ruleName$5, {
   rejected: (value, replacement, propName) => {
     if (propName && propName.includes('radius') && value.includes('borderWidth')) {
       return `Border radius variables can not be used for border widths`
@@ -252,19 +260,19 @@ const messages$3 = ruleMessages$1(ruleName$3, {
   },
 });
 
-const variables = primitivesVariables('border');
+const variables$2 = primitivesVariables('border');
 const sizes$1 = [];
 const radii = [];
 
 // Props that we want to check
-const propList$1 = ['border', 'border-width', 'border-radius'];
+const propList$2 = ['border', 'border-width', 'border-radius'];
 // Values that we want to ignore
 const valueList$1 = ['${'];
 
 const borderShorthand = prop =>
   /^border(-(top|right|bottom|left|block-start|block-end|inline-start|inline-end))?$/.test(prop);
 
-for (const variable of variables) {
+for (const variable of variables$2) {
   const name = variable['name'];
 
   if (name.includes('borderWidth')) {
@@ -284,9 +292,9 @@ for (const variable of variables) {
 }
 
 /** @type {import('stylelint').Rule} */
-const ruleFunction$1 = (primary, secondaryOptions, context) => {
+const ruleFunction$3 = (primary, secondaryOptions, context) => {
   return (root, result) => {
-    const validOptions = validateOptions$1(result, ruleName$3, {
+    const validOptions = validateOptions$3(result, ruleName$5, {
       actual: primary,
       possible: [true],
     });
@@ -296,7 +304,7 @@ const ruleFunction$1 = (primary, secondaryOptions, context) => {
     root.walkDecls(declNode => {
       const {prop, value} = declNode;
 
-      if (!propList$1.some(borderProp => prop.startsWith(borderProp))) return
+      if (!propList$2.some(borderProp => prop.startsWith(borderProp))) return
       if (/^border(-(top|right|bottom|left|block-start|block-end|inline-start|inline-end))?-color$/.test(prop)) return
       if (valueList$1.some(valueToIgnore => value.includes(valueToIgnore))) return
 
@@ -386,7 +394,7 @@ const ruleFunction$1 = (primary, secondaryOptions, context) => {
           problems.push({
             index: declarationValueIndex(declNode) + node.sourceIndex,
             endIndex: declarationValueIndex(declNode) + node.sourceIndex + node.value.length,
-            message: messages$3.rejected(node.value, replacement, prop),
+            message: messages$5.rejected(node.value, replacement, prop),
           });
         }
 
@@ -399,13 +407,13 @@ const ruleFunction$1 = (primary, secondaryOptions, context) => {
 
       if (problems.length) {
         for (const err of problems) {
-          report$1({
+          report$3({
             index: err.index,
             endIndex: err.endIndex,
             message: err.message,
             node: declNode,
             result,
-            ruleName: ruleName$3,
+            ruleName: ruleName$5,
           });
         }
       }
@@ -413,13 +421,108 @@ const ruleFunction$1 = (primary, secondaryOptions, context) => {
   }
 };
 
-ruleFunction$1.ruleName = ruleName$3;
-ruleFunction$1.messages = messages$3;
-ruleFunction$1.meta = {
+ruleFunction$3.ruleName = ruleName$5;
+ruleFunction$3.messages = messages$5;
+ruleFunction$3.meta = {
   fixable: true,
 };
 
-var borders = createPlugin$1(ruleName$3, ruleFunction$1);
+var borders = createPlugin$3(ruleName$5, ruleFunction$3);
+
+const {
+  createPlugin: createPlugin$2,
+  utils: {report: report$2, ruleMessages: ruleMessages$2, validateOptions: validateOptions$2},
+} = stylelint;
+
+const ruleName$4 = 'primer/box-shadow';
+const messages$4 = ruleMessages$2(ruleName$4, {
+  rejected: (value, replacement) => {
+    if (!replacement) {
+      return `Please use a Primer box-shadow variable instead of '${value}'. Consult the primer docs for a suitable replacement. https://primer.style/foundations/primitives/color#shadow or https://primer.style/foundations/primitives/size#border-size`
+    }
+
+    return `Please replace '${value}' with a Primer box-shadow variable '${replacement['name']}'. https://primer.style/foundations/primitives/color#shadow or https://primer.style/foundations/primitives/size#border-size`
+  },
+});
+
+const variables$1 = primitivesVariables('box-shadow');
+const shadows = [];
+
+for (const variable of variables$1) {
+  const name = variable['name'];
+
+  // TODO: Decide if this is safe. Someday we might have variables that
+  // have 'shadow' in the name but aren't full box-shadows.
+  if (name.includes('shadow') || name.includes('boxShadow')) {
+    shadows.push(variable);
+  }
+}
+
+/** @type {import('stylelint').Rule} */
+const ruleFunction$2 = (primary, secondaryOptions, context) => {
+  return (root, result) => {
+    const validOptions = validateOptions$2(result, ruleName$4, {
+      actual: primary,
+      possible: [true],
+    });
+    const validValues = shadows;
+
+    if (!validOptions) return
+
+    root.walkDecls(declNode => {
+      const {prop, value} = declNode;
+
+      if (prop !== 'box-shadow') return
+
+      if (value === 'none') return
+
+      const problems = [];
+
+      const checkForVariable = (vars, nodeValue) => {
+        return vars.some(variable =>
+          new RegExp(`${variable['name'].replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}\\b`).test(nodeValue),
+        )
+      };
+
+      if (checkForVariable(validValues, value)) {
+        return
+      }
+
+      const replacement = validValues.find(variable => variable.values.includes(value));
+
+      if (replacement && context.fix) {
+        declNode.value = value.replace(value, `var(${replacement['name']})`);
+      } else {
+        problems.push({
+          index: declarationValueIndex(declNode),
+          endIndex: declarationValueIndex(declNode) + value.length,
+          message: messages$4.rejected(value, replacement),
+        });
+      }
+
+      if (problems.length) {
+        for (const err of problems) {
+          report$2({
+            index: err.index,
+            endIndex: err.endIndex,
+            message: err.message,
+            node: declNode,
+            result,
+            ruleName: ruleName$4,
+          });
+        }
+      }
+    });
+  }
+};
+
+ruleFunction$2.ruleName = ruleName$4;
+ruleFunction$2.messages = messages$4;
+ruleFunction$2.meta = {
+  fixable: true,
+};
+
+var boxShadow = createPlugin$2(ruleName$4, ruleFunction$2);
 
 const SKIP_VALUE_NODE_TYPES = new Set(['space', 'div']);
 const SKIP_AT_RULE_NAMES = new Set(['each', 'for', 'function', 'mixin']);
@@ -665,18 +768,18 @@ function createVariableRule(ruleName, rules, url) {
     let actualRules = rules;
     let overrides = options.rules;
     if (typeof rules === 'function') {
-      actualRules = rules({variables: variables$1, options, ruleName});
+      actualRules = rules({variables: variables$3, options, ruleName});
     } else {
       actualRules = Object.assign({}, rules);
     }
     if (typeof overrides === 'function') {
       delete options.rules;
-      overrides = overrides({rules: actualRules, options, ruleName, variables: variables$1});
+      overrides = overrides({rules: actualRules, options, ruleName, variables: variables$3});
     }
     if (overrides) {
       Object.assign(actualRules, overrides);
     }
-    const validate = declarationValidator(actualRules, {variables: variables$1});
+    const validate = declarationValidator(actualRules, {variables: variables$3});
 
     // The stylelint docs suggest respecting a "disableFix" rule option that
     // overrides the "global" context.fix (--fix) linting option.
@@ -710,10 +813,9 @@ function createVariableRule(ruleName, rules, url) {
               const message = stylelint.utils
                 .ruleMessages(ruleName, {
                   rejected: m => {
-                    if (url) {
+                    {
                       return `${m}. See ${url}.`
                     }
-                    return `${m}.`
                   },
                 })
                 .rejected(error);
@@ -738,27 +840,6 @@ function createVariableRule(ruleName, rules, url) {
 
 function noop$2() {}
 
-var boxShadow = createVariableRule(
-  'primer/box-shadow',
-  {
-    'box shadow': {
-      expects: 'a box-shadow variable',
-      props: 'box-shadow',
-      values: [
-        '$box-shadow*',
-        '$*-shadow',
-        'none',
-        // Match variables in any of the following formats: --color-shadow-*, --color-*-shadow-*, --color-*-shadow, --shadow-*, *shadow*
-        /var\(--color-(.+-)*shadow(-.+)*\)/,
-        /var\(--shadow(-.+)*\)/,
-        /var\((.+-)*shadow(-.+)*\)/,
-      ],
-      singular: true,
-    },
-  },
-  'https://primer.style/css/utilities/box-shadow',
-);
-
 const bgVars = [
   '$bg-*',
   '$tooltip-background-color',
@@ -801,9 +882,9 @@ var colors = createVariableRule(
   'https://primer.style/primitives/colors',
 );
 
-const ruleName$2 = 'primer/responsive-widths';
+const ruleName$3 = 'primer/responsive-widths';
 
-const messages$2 = stylelint.utils.ruleMessages(ruleName$2, {
+const messages$3 = stylelint.utils.ruleMessages(ruleName$3, {
   rejected: value => {
     return `A value larger than the smallest viewport could break responsive pages. Use a width value smaller than ${value}. https://primer.style/css/support/breakpoints`
   },
@@ -823,7 +904,7 @@ const walkGroups = (root, validate) => {
 };
 
 // eslint-disable-next-line no-unused-vars
-var responsiveWidths = stylelint.createPlugin(ruleName$2, (enabled, options = {}, context) => {
+var responsiveWidths = stylelint.createPlugin(ruleName$3, (enabled, options = {}, context) => {
   if (!enabled) {
     return noop$1
   }
@@ -859,7 +940,7 @@ var responsiveWidths = stylelint.createPlugin(ruleName$2, (enabled, options = {}
             if (parseInt(valueUnit.number) > 320) {
               problems.push({
                 index: declarationValueIndex(decl) + node.sourceIndex,
-                message: messages$2.rejected(node.value),
+                message: messages$3.rejected(node.value),
               });
             }
             break
@@ -867,7 +948,7 @@ var responsiveWidths = stylelint.createPlugin(ruleName$2, (enabled, options = {}
             if (parseInt(valueUnit.number) > 100) {
               problems.push({
                 index: declarationValueIndex(decl) + node.sourceIndex,
-                message: messages$2.rejected(node.value),
+                message: messages$3.rejected(node.value),
               });
             }
             break
@@ -881,7 +962,7 @@ var responsiveWidths = stylelint.createPlugin(ruleName$2, (enabled, options = {}
             message: err.message,
             node: decl,
             result,
-            ruleName: ruleName$2,
+            ruleName: ruleName$3,
           });
         }
       }
@@ -894,12 +975,12 @@ var responsiveWidths = stylelint.createPlugin(ruleName$2, (enabled, options = {}
 function noop$1() {}
 
 const {
-  createPlugin,
-  utils: {report, ruleMessages, validateOptions},
+  createPlugin: createPlugin$1,
+  utils: {report: report$1, ruleMessages: ruleMessages$1, validateOptions: validateOptions$1},
 } = stylelint;
 
-const ruleName$1 = 'primer/spacing';
-const messages$1 = ruleMessages(ruleName$1, {
+const ruleName$2 = 'primer/spacing';
+const messages$2 = ruleMessages$1(ruleName$2, {
   rejected: (value, replacement) => {
     if (!replacement) {
       return `Please use a primer size variable instead of '${value}'. Consult the primer docs for a suitable replacement. https://primer.style/foundations/primitives/size`
@@ -910,7 +991,7 @@ const messages$1 = ruleMessages(ruleName$1, {
 });
 
 // Props that we want to check
-const propList = ['padding', 'margin', 'top', 'right', 'bottom', 'left'];
+const propList$1 = ['padding', 'margin', 'top', 'right', 'bottom', 'left'];
 // Values that we want to ignore
 const valueList = ['${'];
 
@@ -927,9 +1008,9 @@ for (const size of sizes) {
 }
 
 /** @type {import('stylelint').Rule} */
-const ruleFunction = (primary, secondaryOptions, context) => {
+const ruleFunction$1 = (primary, secondaryOptions, context) => {
   return (root, result) => {
-    const validOptions = validateOptions(result, ruleName$1, {
+    const validOptions = validateOptions$1(result, ruleName$2, {
       actual: primary,
       possible: [true],
     });
@@ -939,7 +1020,7 @@ const ruleFunction = (primary, secondaryOptions, context) => {
     root.walkDecls(declNode => {
       const {prop, value} = declNode;
 
-      if (!propList.some(spacingProp => prop.startsWith(spacingProp))) return
+      if (!propList$1.some(spacingProp => prop.startsWith(spacingProp))) return
       if (valueList.some(valueToIgnore => value.includes(valueToIgnore))) return
 
       const problems = [];
@@ -984,7 +1065,7 @@ const ruleFunction = (primary, secondaryOptions, context) => {
           problems.push({
             index: declarationValueIndex(declNode) + node.sourceIndex,
             endIndex: declarationValueIndex(declNode) + node.sourceIndex + node.value.length,
-            message: messages$1.rejected(node.value, replacement),
+            message: messages$2.rejected(node.value, replacement),
           });
         }
 
@@ -995,6 +1076,189 @@ const ruleFunction = (primary, secondaryOptions, context) => {
         declNode.value = parsedValue.toString();
       }
 
+      if (problems.length) {
+        for (const err of problems) {
+          report$1({
+            index: err.index,
+            endIndex: err.endIndex,
+            message: err.message,
+            node: declNode,
+            result,
+            ruleName: ruleName$2,
+          });
+        }
+      }
+    });
+  }
+};
+
+ruleFunction$1.ruleName = ruleName$2;
+ruleFunction$1.messages = messages$2;
+ruleFunction$1.meta = {
+  fixable: true,
+};
+
+var spacing = createPlugin$1(ruleName$2, ruleFunction$1);
+
+const {
+  createPlugin,
+  utils: {report, ruleMessages, validateOptions},
+} = stylelint;
+
+const ruleName$1 = 'primer/typography';
+const messages$1 = ruleMessages(ruleName$1, {
+  rejected: (value, replacement) => {
+    // no possible replacement
+    if (!replacement) {
+      return `Please use a Primer typography variable instead of '${value}'. Consult the primer docs for a suitable replacement. https://primer.style/foundations/primitives/typography`
+    }
+
+    // multiple possible replacements
+    if (replacement.length) {
+      return `Please use one of the following Primer typography variables instead of '${value}': ${replacement.map(replacementObj => `'${replacementObj.name}'`).join(', ')}. https://primer.style/foundations/primitives/typography`
+    }
+
+    // one possible replacement
+    return `Please replace '${value}' with Primer typography variable '${replacement['name']}'. https://primer.style/foundations/primitives/typography`
+  },
+});
+
+const fontWeightKeywordMap = {
+  normal: 400,
+  bold: 700,
+  bolder: 600,
+  lighter: 300,
+};
+const getClosestFontWeight = (goalWeightNumber, fontWeightsTokens) => {
+  return fontWeightsTokens.reduce((prev, curr) =>
+    Math.abs(curr.values - goalWeightNumber) < Math.abs(prev.values - goalWeightNumber) ? curr : prev,
+  ).values
+};
+
+const variables = primitivesVariables('typography');
+const fontSizes = [];
+const fontWeights = [];
+const lineHeights = [];
+const fontStacks = [];
+const fontShorthands = [];
+
+// Props that we want to check for typography variables
+const propList = ['font-size', 'font-weight', 'line-height', 'font-family', 'font'];
+
+for (const variable of variables) {
+  const name = variable['name'];
+
+  if (name.includes('size')) {
+    fontSizes.push(variable);
+  }
+
+  if (name.includes('weight')) {
+    fontWeights.push(variable);
+  }
+
+  if (name.includes('lineHeight')) {
+    lineHeights.push(variable);
+  }
+
+  if (name.includes('fontStack')) {
+    fontStacks.push(variable);
+  }
+
+  if (name.includes('shorthand')) {
+    fontShorthands.push(variable);
+  }
+}
+
+/** @type {import('stylelint').Rule} */
+const ruleFunction = primary => {
+  return (root, result) => {
+    const validOptions = validateOptions(result, ruleName$1, {
+      actual: primary,
+      possible: [true],
+    });
+    let validValues = [];
+
+    if (!validOptions) return
+
+    root.walkDecls(declNode => {
+      const {prop, value} = declNode;
+
+      if (!propList.some(typographyProp => prop === typographyProp)) return
+
+      const problems = [];
+
+      const checkForVariable = (vars, nodeValue) =>
+        vars.some(variable =>
+          new RegExp(`${variable['name'].replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}\\b`).test(nodeValue),
+        );
+
+      // Exact values to ignore.
+      if (value === 'inherit') {
+        return
+      }
+
+      switch (prop) {
+        case 'font-size':
+          validValues = fontSizes;
+          break
+        case 'font-weight':
+          validValues = fontWeights;
+          break
+        case 'line-height':
+          validValues = lineHeights;
+          break
+        case 'font-family':
+          validValues = fontStacks;
+          break
+        case 'font':
+          validValues = fontShorthands;
+          break
+        default:
+          validValues = [];
+      }
+
+      if (checkForVariable(validValues, value)) {
+        return
+      }
+
+      const getReplacements = () => {
+        const replacementTokens = validValues.filter(variable => {
+          if (!(variable.values instanceof Array)) {
+            let nodeValue = value;
+
+            if (prop === 'font-weight') {
+              nodeValue = getClosestFontWeight(fontWeightKeywordMap[value] || value, fontWeights);
+            }
+
+            return variable.values.toString() === nodeValue.toString()
+          }
+
+          return variable.values.includes(value.replace('-', ''))
+        });
+
+        if (!replacementTokens.length) {
+          return
+        }
+
+        return replacementTokens[0]
+      };
+      const replacement = getReplacements();
+      const fixable = replacement && !replacement.length;
+      let fixedValue = '';
+      if (fixable) {
+        fixedValue = value.replace(value, `var(${replacement['name']})`);
+      }
+
+      problems.push({
+        index: declarationValueIndex(declNode),
+        endIndex: declarationValueIndex(declNode) + value.length,
+        message: messages$1.rejected(value, replacement, prop),
+        fix: () => {
+          if (!fixable) return
+          declNode.value = fixedValue;
+        },
+      });
+
       if (problems.length) {
         for (const err of problems) {
           report({
@@ -1004,6 +1268,7 @@ const ruleFunction = (primary, secondaryOptions, context) => {
             node: declNode,
             result,
             ruleName: ruleName$1,
+            fix: err.fix,
           });
         }
       }
@@ -1017,30 +1282,7 @@ ruleFunction.meta = {
   fixable: true,
 };
 
-var spacing = createPlugin(ruleName$1, ruleFunction);
-
-var typography = createVariableRule(
-  'primer/typography',
-  {
-    'font-size': {
-      expects: 'a font-size variable',
-      values: ['$body-font-size', '$h{000,00,0,1,2,3,4,5,6}-size', '$font-size-*', '1', '1em', 'inherit'],
-    },
-    'font-weight': {
-      props: 'font-weight',
-      values: ['$font-weight-*', 'inherit'],
-      replacements: {
-        bold: '$font-weight-bold',
-        normal: '$font-weight-normal',
-      },
-    },
-    'line-height': {
-      props: 'line-height',
-      values: ['$body-line-height', '$lh-*', '0', '1', '1em', 'inherit'],
-    },
-  },
-  'https://primer.style/css/utilities/typography',
-);
+var typography = createPlugin(ruleName$1, ruleFunction);
 
 const ruleName = 'primer/no-display-colors';
 const messages = stylelint.utils.ruleMessages(ruleName, {
@@ -1144,7 +1386,6 @@ var index = {
     'declaration-property-value-disallowed-list': {
       '/^transition/': ['/all/'],
       '/^background/': ['http:', 'https:'],
-      '/^border/': ['none'],
       '/.+/': ['initial'],
     },
     'function-calc-no-unspaced-operator': true,
@@ -1225,8 +1466,6 @@ var index = {
         'length-zero-no-unit': null,
         'selector-max-type': null,
         'primer/colors': null,
-        'primer/typography': null,
-        'primer/box-shadow': null,
       },
     },
     {
@@ -1251,7 +1490,6 @@ var index = {
     },
     {
       files: ['**/*.module.css'],
-      plugins: ['stylelint-css-modules-no-global-scoped-selector'],
       rules: {
         'property-no-unknown': [
           true,
@@ -1276,10 +1514,6 @@ var index = {
             ignoreFunctions: ['global'],
           },
         ],
-        'css-modules/no-global-scoped-selector': true,
-        // temporarily disabiling Primer plugins while we work on upgrades https://github.com/github/primer/issues/3165
-        'primer/typography': null,
-        'primer/box-shadow': null,
       },
     },
   ],