@primer/stylelint-config 13.0.0-rc.99be5f2 → 13.0.0-rc.ad6cbda

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/stylelint-config",
-  "version": "13.0.0-rc.99be5f2",
+  "version": "13.0.0-rc.ad6cbda",
   "description": "Sharable stylelint config used by GitHub's CSS",
   "author": "GitHub, Inc.",
   "license": "MIT",
@@ -45,7 +45,7 @@
   "dependencies": {
     "@github/browserslist-config": "^1.0.0",
     "@primer/css": "^21.0.8",
-    "@primer/primitives": "^7.17.1",
+    "@primer/primitives": "^8.2.0",
     "anymatch": "^3.1.1",
     "postcss-scss": "^4.0.2",
     "postcss-styled-syntax": "^0.6.4",

package/plugins/README.md

@@ -13,7 +13,6 @@ This directory contains all of our custom stylelint plugins, each of which provi
   - [`primer/borders`](#primerborders)
   - [`primer/box-shadow`](#primerbox-shadow)
   - [`primer/responsive-widths`](#primerresponsive-widths)
-  - [`primer/utilities`](#primerutilities)
   - [Variable rules](#variable-rules)
     - [Variable rule options](#variable-rule-options)
 
@@ -84,31 +83,6 @@ This [variable rule](#variable-rules) enforces the use of `$box-shadow*` variabl
 
 This plugin checks for `width` and `min-width` declarations that use a value less than the minimum browser size. `320px`
 
-## `primer/utilities`
-
-Checks for selectors with single declarations that can be replaced with [primer/css utilities](https://primer.style/css/utilities/).
-
-```scss
-.foo {
-  color: var(--color-fg-default);
-}
-/**          ↑
- *           FAIL: --color-fg-default can be replaced with .color-fg-default */
-
-.foo {
-  color: #custom;
-}
-/**          ↑
- *           OK: Color value doesn't match a utility. */
-
-.foo {
-  color: var(--color-fg-default);
-  padding: 0;
-}
-/**          ↑
- *           OK: Has more than one declaration, not considered */
-```
-
 ## Variable rules
 
 Variable rules are created using a general-purpose helper that can validate constraints for matching CSS properties and values. In general, the Primer CSS variable rules enforce two basic principles for custom CSS:

package/plugins/lib/primitives.js

@@ -19,8 +19,11 @@ export async function primitivesVariables(type) {
     for (const key of Object.keys(data)) {
       const size = data[key]
       const values = size['value']
-      values.push(`${parseInt(size['original']['value']) + 1}px`)
-      values.push(`${parseInt(size['original']['value']) - 1}px`)
+      const intValue = parseInt(size['original']['value'])
+      if (![2, 6].includes(intValue)) {
+        values.push(`${intValue + 1}px`)
+        values.push(`${intValue - 1}px`)
+      }
 
       variables.push({
         name: `--${size['name']}`,

package/plugins/lib/primer-utilities.js

@@ -1,526 +0,0 @@
-// Meant as temp until we can move to primitives or css
-const colorTypes = ['accent', 'success', 'attention', 'severe', 'danger', 'open', 'closed', 'done', 'sponsors']
-
-export default {
-  color: [
-    {
-      value: 'var(--color-fg-default)',
-      utilityClass: 'color-fg-default',
-    },
-    {
-      value: 'var(--color-fg-muted)',
-      utilityClass: 'color-fg-muted',
-    },
-    {
-      value: 'var(--color-fg-subtle)',
-      utilityClass: 'color-fg-subtle',
-    },
-  ].concat(
-    colorTypes.map(type => {
-      return {
-        value: `var(--color-${type}-fg)`,
-        utilityClass: `color-fg-${type}`,
-      }
-    }),
-  ),
-  'background-color': [
-    {
-      value: 'var(--color-canvas-default)',
-      utilityClass: 'color-bg-default',
-    },
-    {
-      value: 'var(--color-canvas-overlay)',
-      utilityClass: 'color-bg-overlay',
-    },
-    {
-      value: 'var(--color-canvas-inset)',
-      utilityClass: 'color-bg-inset',
-    },
-    {
-      value: 'var(--color-canvas-subtle)',
-      utilityClass: 'color-bg-subtle',
-    },
-    {
-      value: 'transparent',
-      utilityClass: 'color-bg-transparent',
-    },
-  ]
-    .concat(
-      colorTypes.map(type => {
-        return {
-          value: `var(--color-${type}-subtle)`,
-          utilityClass: `color-bg-${type}`,
-        }
-      }),
-    )
-    .concat(
-      colorTypes.map(type => {
-        return {
-          value: `var(--color-${type}-emphasis)`,
-          utilityClass: `color-bg-${type}-emphasis`,
-        }
-      }),
-    ),
-  'border-color': [
-    {
-      value: 'var(--color-border-default',
-      utilityClass: 'color-border-default',
-    },
-    {
-      value: 'var(--color-border-muted',
-      utilityClass: 'color-border-muted',
-    },
-    {
-      value: 'var(--color-border-subtle',
-      utilityClass: 'color-border-subtle',
-    },
-  ]
-    .concat(
-      colorTypes.map(type => {
-        return {
-          value: `var(--color-${type}-muted)`,
-          utilityClass: `color-border-${type}`,
-        }
-      }),
-    )
-    .concat(
-      colorTypes.map(type => {
-        return {
-          value: `var(--color-${type}-emphasis)`,
-          utilityClass: `color-border-${type}-emphasis`,
-        }
-      }),
-    ),
-  margin: Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `m-${i + 1}`,
-    }
-  }),
-  'margin-top': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `mt-${i + 1}`,
-    }
-  }),
-  'margin-right': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `mr-${i + 1}`,
-    }
-  }),
-  'margin-bottom': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `mb-${i + 1}`,
-    }
-  }),
-  'margin-left': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `ml-${i + 1}`,
-    }
-  }),
-  padding: Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `p-${i + 1}`,
-    }
-  }),
-  'padding-top': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `pt-${i + 1}`,
-    }
-  }),
-  'padding-right': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `pr-${i + 1}`,
-    }
-  }),
-  'padding-bottom': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `pb-${i + 1}`,
-    }
-  }),
-  'padding-left': Array.from(new Array(6)).map((_, i) => {
-    return {
-      value: `$spacer-${i + 1}`,
-      utilityClass: `pl-${i + 1}`,
-    }
-  }),
-  'line-height': [
-    {
-      value: '$lh-condensed-ultra',
-      utilityClass: 'lh-condensed-ultra',
-    },
-    {
-      value: '$lh-condensed',
-      utilityClass: 'lh-condensed',
-    },
-    {
-      value: '$lh-default',
-      utilityClass: 'lh-default',
-    },
-    {
-      value: '0',
-      utilityClass: 'lh-0',
-    },
-  ],
-  'text-align': [
-    {
-      value: 'left',
-      utilityClass: 'text-left',
-    },
-    {
-      value: 'right',
-      utilityClass: 'text-right',
-    },
-    {
-      value: 'center',
-      utilityClass: 'text-center',
-    },
-  ],
-  'font-style': [
-    {
-      value: 'italic',
-      utilityClass: 'text-italic',
-    },
-  ],
-  'text-transform': [
-    {
-      value: 'uppercase',
-      utilityClass: 'text-uppercase',
-    },
-  ],
-  'text-decoration': [
-    {
-      value: 'underline',
-      utilityClass: 'text-underline',
-    },
-    {
-      value: 'none',
-      utilityClass: 'no-underline',
-    },
-  ],
-  'white-space': [
-    {
-      value: 'nowrap',
-      utilityClass: 'no-wrap',
-    },
-    {
-      value: 'normal',
-      utilityClass: 'ws-normal',
-    },
-  ],
-  'word-break': [
-    {
-      value: 'break-all',
-      utilityClass: 'wb-break-all',
-    },
-  ],
-  width: [
-    {
-      value: '100%',
-      utilityClass: 'width-full',
-    },
-    {
-      value: 'auto%',
-      utilityClass: 'width-auto',
-    },
-  ],
-  overflow: [
-    {
-      value: 'visible',
-      utilityClass: 'overflow-visible',
-    },
-    {
-      value: 'hidden',
-      utilityClass: 'overflow-hidden',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'overflow-auto',
-    },
-    {
-      value: 'scroll',
-      utilityClass: 'overflow-scroll',
-    },
-  ],
-  'overflow-x': [
-    {
-      value: 'visible',
-      utilityClass: 'overflow-x-visible',
-    },
-    {
-      value: 'hidden',
-      utilityClass: 'overflow-x-hidden',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'overflow-x-auto',
-    },
-    {
-      value: 'scroll',
-      utilityClass: 'overflow-x-scroll',
-    },
-  ],
-  'overflow-y': [
-    {
-      value: 'visible',
-      utilityClass: 'overflow-y-visible',
-    },
-    {
-      value: 'hidden',
-      utilityClass: 'overflow-y-hidden',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'overflow-y-auto',
-    },
-    {
-      value: 'scroll',
-      utilityClass: 'overflow-y-scroll',
-    },
-  ],
-  height: [
-    {
-      value: '100%',
-      utilityClass: 'height-full',
-    },
-  ],
-  'max-width': [
-    {
-      value: '100%',
-      utilityClass: 'width-fit',
-    },
-  ],
-  'max-height': [
-    {
-      value: '100%',
-      utilityClass: 'height-fit',
-    },
-  ],
-  'min-width': [
-    {
-      value: '0',
-      utilityClass: 'min-width-0',
-    },
-  ],
-  float: [
-    {
-      value: 'left',
-      utilityClass: 'float-left',
-    },
-    {
-      value: 'right',
-      utilityClass: 'float-right',
-    },
-    {
-      value: 'none',
-      utilityClass: 'float-none',
-    },
-  ],
-  'list-style': [
-    {
-      value: 'none',
-      utilityClass: 'list-style-none',
-    },
-  ],
-  'user-select': [
-    {
-      value: 'none',
-      utilityClass: 'user-select-none',
-    },
-  ],
-  visibility: [
-    {
-      value: 'hidden',
-      utilityClass: 'v-hidden',
-    },
-    {
-      value: 'visible',
-      utilityClass: 'v-visible',
-    },
-  ],
-  'vertical-align': [
-    {
-      value: 'middle',
-      utilityClass: 'v-align-middle',
-    },
-    {
-      value: 'top',
-      utilityClass: 'v-align-top',
-    },
-    {
-      value: 'bottom',
-      utilityClass: 'v-align-bottom',
-    },
-    {
-      value: 'text-top',
-      utilityClass: 'v-align-text-top',
-    },
-    {
-      value: 'text-bottom',
-      utilityClass: 'v-align-text-bottom',
-    },
-    {
-      value: 'text-baseline',
-      utilityClass: 'v-align-baseline',
-    },
-  ],
-  'font-weight': [
-    {
-      value: '$font-weight-normal',
-      utilityClass: 'text-normal',
-    },
-    {
-      value: '$font-weight-bold',
-      utilityClass: 'text-bold',
-    },
-    {
-      value: '$font-weight-semibold',
-      utilityClass: 'text-semibold',
-    },
-    {
-      value: '$font-weight-light',
-      utilityClass: 'text-light',
-    },
-  ],
-  top: [
-    {
-      value: '0',
-      utilityClass: 'top-0',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'top-auto',
-    },
-  ],
-  right: [
-    {
-      value: '0',
-      utilityClass: 'right-0',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'right-auto',
-    },
-  ],
-  bottom: [
-    {
-      value: '0',
-      utilityClass: 'bottom-0',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'bottom-auto',
-    },
-  ],
-  left: [
-    {
-      value: '0',
-      utilityClass: 'left-0',
-    },
-    {
-      value: 'auto',
-      utilityClass: 'left-auto',
-    },
-  ],
-  position: [
-    {
-      value: 'static',
-      utilityClass: 'position-static',
-    },
-    {
-      value: 'relative',
-      utilityClass: 'position-relative',
-    },
-    {
-      value: 'absolute',
-      utilityClass: 'position-absolute',
-    },
-    {
-      value: 'fixed',
-      utilityClass: 'position-fixed',
-    },
-    {
-      value: 'sticky',
-      utilityClass: 'position-sticky',
-    },
-  ],
-  'box-shadow': [
-    {
-      value: 'none',
-      utilityClass: 'box-shadow-none',
-    },
-    {
-      value: 'var(--color-shadow-small)',
-      utilityClass: 'box-shadow-small',
-    },
-    {
-      value: 'var(--color-shadow-medium)',
-      utilityClass: 'box-shadow-medium',
-    },
-    {
-      value: 'var(--color-shadow-large)',
-      utilityClass: 'box-shadow-large',
-    },
-    {
-      value: 'var(--color-shadow-extra-large)',
-      utilityClass: 'box-shadow-extra-large',
-    },
-  ],
-  border: [
-    {
-      value: '$border',
-      utilityClass: 'border',
-    },
-    {
-      value: '0',
-      utilityClass: 'border-0',
-    },
-  ],
-  'border-top': [
-    {
-      value: '$border',
-      utilityClass: 'border-top',
-    },
-    {
-      value: '0',
-      utilityClass: 'border-top-0',
-    },
-  ],
-  'border-right': [
-    {
-      value: '$border',
-      utilityClass: 'border-right',
-    },
-    {
-      value: '0',
-      utilityClass: 'border-right-0',
-    },
-  ],
-  'border-bottom': [
-    {
-      value: '$border',
-      utilityClass: 'border-bottom',
-    },
-    {
-      value: '0',
-      utilityClass: 'border-bottom-0',
-    },
-  ],
-  'border-left': [
-    {
-      value: '$border',
-      utilityClass: 'border-left',
-    },
-    {
-      value: '0',
-      utilityClass: 'border-left-0',
-    },
-  ],
-}

package/plugins/utilities.js

@@ -1,52 +0,0 @@
-import stylelint from 'stylelint'
-import utilities from './lib/primer-utilities.js'
-
-export const ruleName = 'primer/utilities'
-
-export const messages = stylelint.utils.ruleMessages(ruleName, {
-  rejected: (selector, utilityClass) => {
-    return `Consider using the Primer utility '.${utilityClass}' instead of the selector '${selector}' in your html. https://primer.style/css/utilities`
-  },
-})
-
-// eslint-disable-next-line no-unused-vars
-export default stylelint.createPlugin(ruleName, (enabled, options = {}, context) => {
-  if (!enabled) {
-    return noop
-  }
-
-  const utilityReplacement = (declaration, value) => {
-    const declarationUtilities = utilities[declaration]
-    if (declarationUtilities) {
-      return declarationUtilities.find(utility => {
-        return utility.value === value
-      })
-    }
-  }
-
-  const lintResult = (root, result) => {
-    root.walkRules(rule => {
-      if (!/^\.[\w\-_]+$/.exec(rule.selector)) {
-        return
-      }
-      const decls = rule.nodes.filter(decl => decl.type === 'decl')
-
-      if (decls.length === 1) {
-        const replacement = utilityReplacement(decls[0].prop, decls[0].value)
-        if (replacement) {
-          stylelint.utils.report({
-            index: rule.sourceIndex,
-            message: messages.rejected(rule.selector, replacement.utilityClass),
-            node: rule,
-            result,
-            ruleName,
-          })
-        }
-      }
-    })
-  }
-
-  return lintResult
-})
-
-function noop() {}