Initial commit

node_modules/stylelint/lib/rules/font-family-name-quotes/README.md

@@ -0,0 +1,140 @@
+# font-family-name-quotes
+
+Specify whether or not quotation marks should be used around font family names.
+
+```css
+a { font-family: "Times New Roman", 'Ancient Runes', serif; }
+/**              ↑               ↑  ↑             ↑
+ *               These quotation marks and this one */
+```
+
+This rule checks the `font` and `font-family` properties.
+
+This rule ignores `$sass`, `@less`, and `var(--custom-property)` variable syntaxes.
+
+## Options
+
+`string`: `"always-where-required"|"always-where-recommended"|"always-unless-keyword"`
+
+*Please read the following to understand these options*:
+
+-   The `font` and `font-family` properties accept a short list of special **keywords**: `inherit`, `serif`, `sans-serif`, `cursive`, `fantasy`, and `monospace`. If you wrap these words in quotes, the browser will not interpret them as keywords, but will instead look for a font by that name (e.g. will look for a `"sans-serif"` font) -- which is almost *never* what you want. Instead, you use these keywords to point to the built-in, generic fallbacks (right?). Therefore, *all of the options below enforce no quotes around these keywords*. (If you actually want to use a font named `"sans-serif"`, turn this rule off.)
+-   Quotes are **recommended** [in the spec](https://www.w3.org/TR/CSS2/fonts.html#font-family-prop) with "font family names that contain white space, digits, or punctuation characters other than hyphens".
+-   Quotes are **required** around font-family names when they are not [valid CSS identifiers](https://www.w3.org/TR/CSS2/syndata.html#value-def-identifier). For example, a font family name requires quotes around it if it contains `$`, `!`, or `/`, but does not require quotes just because it contains spaces or a (non-initial) number or underscore. *You can probably bet that almost every font family name you use **will** be a valid CSS identifier*.
+-   Quotes should **never** be used around vendor prefixed system fonts such as `-apple-system` and `BlinkMacSystemFont`.
+
+For more on these subtleties, read ["Unquoted font family names in CSS"](https://mathiasbynens.be/notes/unquoted-font-family), by Mathias Bynens.
+
+**Caveat:** This rule does not currently understand escape sequences such as those described by Mathias. If you want to use the font family name "Hawaii 5-0" you will need to wrap it in quotes, instead of escaping it as `Hawaii \35 -0` or `Hawaii\ 5-0`.
+
+### `"always-unless-keyword"`
+
+Expect quotes around every font family name that is not a keyword.
+
+The following patterns are considered warnings:
+
+```css
+a { font-family: Arial, sans-serif; }
+```
+
+```css
+a { font-family: Times New Roman, Times, serif; }
+```
+
+```css
+a { font: 1em Arial, sans-serif; }
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a { font-family: 'Arial', sans-serif; }
+```
+
+```css
+a { font-family: "Times New Roman", "Times", serif; }
+```
+
+```css
+a { font: 1em 'Arial', sans-serif; }
+```
+
+### `"always-where-required"`
+
+Expect quotes only when quotes are *required* according to the criteria above, and disallow quotes in all other cases.
+
+The following patterns are considered warnings:
+
+```css
+a { font-family: "Arial", sans-serif; }
+```
+
+```css
+a { font-family: 'Times New Roman', Times, serif; }
+```
+
+```css
+a { font: 1em "Arial", sans-serif; }
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a { font-family: Arial, sans-serif; }
+```
+
+```css
+a { font-family: Arial, sans-serif; }
+```
+
+```css
+a { font-family: Times New Roman, Times, serif; }
+```
+
+```css
+a { font-family: "Hawaii 5-0"; }
+```
+
+```css
+a { font: 1em Arial, sans-serif; }
+```
+
+### `"always-where-recommended"`
+
+Expect quotes only when quotes are *recommended* according to the criteria above, and disallow quotes in all other cases. (This includes all cases where quotes are *required*, as well.)
+
+The following patterns are considered warnings:
+
+```css
+a { font-family: Times New Roman, Times, serif; }
+```
+
+```css
+a { font-family: MyFontVersion6, sake_case_font; }
+```
+
+```css
+a { font-family: 'Arial', sans-serif; }
+```
+
+```css
+a { font: 1em Times New Roman, Times, serif; }
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a { font-family: 'Times New Roman', Times, serif; }
+```
+
+```css
+a { font-family: "MyFontVersion6", "sake_case_font"; }
+```
+
+```css
+a { font-family: Arial, sans-serif; }
+```
+
+```css
+a { font: 1em 'Times New Roman', Times, serif; }
+```

node_modules/stylelint/lib/rules/font-family-name-quotes/index.js

@@ -0,0 +1,142 @@
+"use strict"
+
+const findFontFamily = require("../../utils/findFontFamily")
+const isStandardSyntaxValue = require("../../utils/isStandardSyntaxValue")
+const isVariable = require("../../utils/isVariable")
+const report = require("../../utils/report")
+const ruleMessages = require("../../utils/ruleMessages")
+const validateOptions = require("../../utils/validateOptions")
+const keywordSets = require("../../reference/keywordSets")
+
+const ruleName = "font-family-name-quotes"
+
+const messages = ruleMessages(ruleName, {
+  expected: family => `Expected quotes around "${family}"`,
+  rejected: family => `Unexpected quotes around "${family}"`,
+})
+
+function isSystemFontKeyword(font) {
+  if (font.indexOf("-apple-") === 0) {
+    return true
+  }
+  if (font === "BlinkMacSystemFont") {
+    return true
+  }
+  return false
+}
+
+// "To avoid mistakes in escaping, it is recommended to quote font family names
+// that contain white space, digits, or punctuation characters other than hyphens"
+// (https://www.w3.org/TR/CSS2/fonts.html#font-family-prop)
+function quotesRecommended(family) {
+  return !/^[-a-zA-Z]+$/.test(family)
+}
+
+// Quotes are required if the family is not a valid CSS identifier
+// (regexes from https://mathiasbynens.be/notes/unquoted-font-family)
+function quotesRequired(family) {
+  return family.split(/\s+/).some(word => {
+    return (/^(-?\d|--)/.test(word) || !/^[-_a-zA-Z0-9\u00A0-\u10FFFF]+$/.test(word)
+    )
+  })
+}
+
+const rule = function (expectation) {
+  return (root, result) => {
+    const validOptions = validateOptions(result, ruleName, {
+      actual: expectation,
+      possible: [
+        "always-where-required",
+        "always-where-recommended",
+        "always-unless-keyword",
+      ],
+    })
+    if (!validOptions) {
+      return
+    }
+
+    root.walkDecls(/^font(-family)?$/i, decl => {
+      const fontFamilies = findFontFamily(decl.value)
+
+      if (fontFamilies.length === 0) {
+        return
+      }
+
+      fontFamilies.forEach(fontFamilyNode => {
+        let rawFamily = fontFamilyNode.value
+
+        if (fontFamilyNode.quote) {
+          rawFamily = fontFamilyNode.quote + rawFamily + fontFamilyNode.quote
+        }
+
+        checkFamilyName(rawFamily, decl)
+      })
+    })
+
+    function checkFamilyName(rawFamily, decl) {
+      if (!isStandardSyntaxValue(rawFamily)) {
+        return
+      }
+      if (isVariable(rawFamily)) {
+        return
+      }
+
+      const hasQuotes = rawFamily[0] === "'" || rawFamily[0] === "\""
+
+      // Clean the family of its quotes
+      const family = rawFamily.replace(/^['"]|['"]$/g, "")
+
+      // Disallow quotes around (case-insensitive) keywords
+      // and system font keywords in all cases
+      if (keywordSets.fontFamilyKeywords.has(family.toLowerCase()) || isSystemFontKeyword(family)) {
+        if (hasQuotes) {
+          return complain(messages.rejected(family), family, decl)
+        }
+        return
+      }
+
+      const required = quotesRequired(family)
+      const recommended = quotesRecommended(family)
+
+      switch (expectation) {
+        case "always-unless-keyword":
+          if (!hasQuotes) {
+            return complain(messages.expected(family), family, decl)
+          }
+          return
+
+        case "always-where-recommended":
+          if (!recommended && hasQuotes) {
+            return complain(messages.rejected(family), family, decl)
+          }
+          if (recommended && !hasQuotes) {
+            return complain(messages.expected(family), family, decl)
+          }
+          return
+
+        case "always-where-required":
+          if (!required && hasQuotes) {
+            return complain(messages.rejected(family), family, decl)
+          }
+          if (required && !hasQuotes) {
+            return complain(messages.expected(family), family, decl)
+          }
+          return
+      }
+    }
+
+    function complain(message, family, decl) {
+      report({
+        result,
+        ruleName,
+        message,
+        node: decl,
+        word: family,
+      })
+    }
+  }
+}
+
+rule.ruleName = ruleName
+rule.messages = messages
+module.exports = rule