feat: add better naming for entity references

BREAKING CHANGE: The entity references have changed
to be more descriptive. `Alphanumeric` is now `named` and
`unicode` is now `numeric` as these actually reflect the
name of the references.

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 14.7
       - name: Cache node modules
         uses: actions/cache@v2
         env:

.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 14.17
       - name: Cache node modules
         uses: actions/cache@v2
         env:

README.md

@@ -4,7 +4,7 @@ Enforce the preferred use of curly quote/apostrophe characters.
 
 **Fixable:** This rule is automatically fixable using the `--fix` flag on the command line.
 
-> This plugin supports converting quotes and apostrophes that have been specified using their `alphanumeric` or `unicode` equivalent into their curly `alphanumeric` or `unicode` values.
+> This plugin supports converting quotes and apostrophes that have been specified using their `numeric` or `named` equivalent into their curly `named` or `numeric` values.
 
 ## Installation
 
@@ -44,12 +44,12 @@ To configure the plugin rules:
 }
 ```
 
-### Convert alphanumeric values into their curly unicode equivalent
+### Convert named values into their curly numeric equivalent
 
 ```json
 {
     "rules": {
-        "prefer-smart-quotes/prefer": ["error", { "inputFormat": "alphanumeric", "outputFormat": "unicode" }]
+        "prefer-smart-quotes/prefer": ["error", { "inputFormat": "named", "outputFormat": "numeric" }]
     }
 }
 ```

docs/rules/prefer.md

@@ -5,7 +5,7 @@
 ## Rule Details
 
 This rule enforces the preferred use of curly quotes/apostrophe characters. To ensure consistency, the plugin can also convert quotes 
-and apostrophes that have been specified using their `alphanumeric` or `unicode` equivalent into curly `alphanumeric` or `unicode` 
+and apostrophes that have been specified using their `named` or `numeric` equivalent into curly `numeric` or `named` 
 values.
 
 ## Options
@@ -14,16 +14,16 @@ This rule has two options, a string option and an object option.
 
 **String option:**
 - `"character"` (default) requires the use of curly characters over straight characters (`'`, `"`)
-- `"alphanumeric"` requires the use of curly alphanumeric values over straight alphanumeric values (`'`, `"`)
-- `"unicode"` requires the use of curly unicode values over straight unicode values (`'`, `"`)
+- `"named"` requires the use of curly named values over straight named values (`'`, `"`)
+- `"numeric"` requires the use of curly numeric values over straight numeric values (`'`, `"`)
 - `"all"` requires the use of all curly entities over straight entities
 
 **Object option:**
 
 - `"inputFormat": "character"` requires the use of curly characters over straight characters
-   - "all", "character", "alphanumeric", "unicode" 
+   - "all", "character", "named", "numeric" 
 - `"outputFormat": "all"` specify the output entity format
-   - "all", "character", "alphanumeric", "unicode"
+   - "all", "character", "named", "numeric"
 
 ## Examples
 
@@ -46,7 +46,7 @@ const Component = () => <>That&rsquo;s a nice boulder!<>
 Examples of **inline** usage for this rule:
 
 ```jsx
-/*eslint smart-quotes: ["error", "alphanumeric"]*/
+/*eslint smart-quotes: ["error", "named"]*/
 
-/*eslint smart-quotes: ["error", { outputFormat: "unicode" }]*/
+/*eslint smart-quotes: ["error", { outputFormat: "numeric" }]*/
 ```

lib/rules/prefer.js

@@ -13,45 +13,45 @@ const matchAll = require("string.prototype.matchall");
 const MAPPINGS = {
   singleQuote: {
     character: "'",
-    unicode: "'",
-    alphanumeric: "'",
+    numeric: "'",
+    named: "'",
     requires: ["curlyLeftQuote", "curlyRightQuote"],
   },
   doubleQuote: {
     character: '"',
-    unicode: """,
-    alphanumeric: """,
+    numeric: """,
+    named: """,
     requires: ["curlyLeftDoubleQuote", "curlyRightDoubleQuote"],
   },
   curlyLeftQuote: {
     character: "‘",
-    unicode: "‘",
-    alphanumeric: "‘",
+    numeric: "‘",
+    named: "‘",
   },
   curlyRightQuote: {
     character: "’",
-    unicode: "’",
-    alphanumeric: "’",
+    numeric: "’",
+    named: "’",
   },
   curlyLeftDoubleQuote: {
     character: "“",
-    unicode: "“",
-    alphanumeric: "“",
+    numeric: "“",
+    named: "“",
   },
   curlyRightDoubleQuote: {
     character: "”",
-    unicode: "”",
-    alphanumeric: "”",
+    numeric: "”",
+    named: "”",
   },
 };
 
 const ENTITY_MAPPINGS = {
   character: [MAPPINGS.singleQuote.character, MAPPINGS.doubleQuote.character],
-  alphanumeric: [
-    MAPPINGS.singleQuote.alphanumeric,
-    MAPPINGS.doubleQuote.alphanumeric,
+  named: [
+    MAPPINGS.singleQuote.named,
+    MAPPINGS.doubleQuote.named,
   ],
-  unicode: [MAPPINGS.singleQuote.unicode, MAPPINGS.doubleQuote.unicode],
+  numeric: [MAPPINGS.singleQuote.numeric, MAPPINGS.doubleQuote.numeric],
 };
 
 const DEFAULT_OPTIONS = {
@@ -75,16 +75,16 @@ module.exports = {
       {
         anyOf: [
           {
-            enum: ["all", "character", "alphanumeric", "unicode"],
+            enum: ["all", "character", "named", "numeric"],
           },
           {
             type: "object",
             properties: {
               inputFormat: {
-                enum: ["all", "character", "alphanumeric", "unicode"],
+                enum: ["all", "character", "named", "numeric"],
               },
               outputFormat: {
-                enum: ["all", "character", "alphanumeric", "unicode"],
+                enum: ["all", "character", "named", "numeric"],
               },
             },
           },
@@ -118,10 +118,10 @@ module.exports = {
       pluginOptions.inputFormat === "character"
         ? ENTITY_MAPPINGS.character
         : null,
-      pluginOptions.inputFormat === "alphanumeric"
-        ? ENTITY_MAPPINGS.alphanumeric
+      pluginOptions.inputFormat === "named"
+        ? ENTITY_MAPPINGS.named
         : null,
-      pluginOptions.inputFormat === "unicode" ? ENTITY_MAPPINGS.unicode : null,
+      pluginOptions.inputFormat === "numeric" ? ENTITY_MAPPINGS.numeric : null,
     ]
       .filter(Boolean)
       .reduce((all, val) => all.concat(val), [])
@@ -144,8 +144,8 @@ module.exports = {
       return (
         [
           MAPPINGS.singleQuote.character,
-          MAPPINGS.singleQuote.unicode,
-          MAPPINGS.singleQuote.alphanumeric,
+          MAPPINGS.singleQuote.numeric,
+          MAPPINGS.singleQuote.named,
         ].indexOf(value) !== -1
       );
     }
@@ -160,8 +160,8 @@ module.exports = {
       return (
         [
           MAPPINGS.doubleQuote.character,
-          MAPPINGS.doubleQuote.unicode,
-          MAPPINGS.doubleQuote.alphanumeric,
+          MAPPINGS.doubleQuote.numeric,
+          MAPPINGS.doubleQuote.named,
         ].indexOf(value) !== -1
       );
     }
@@ -198,17 +198,17 @@ module.exports = {
      */
     function getValueEntity(value, char) {
       if (value.charAt(0) === "&") {
-        const isUnicode = ENTITY_MAPPINGS.unicode.indexOf(value) !== -1;
-        const isAlphanumeric =
-          ENTITY_MAPPINGS.alphanumeric.indexOf(value) !== -1;
+        const isNumeric = ENTITY_MAPPINGS.numeric.indexOf(value) !== -1;
+        const isNamed =
+          ENTITY_MAPPINGS.named.indexOf(value) !== -1;
 
-        if (isUnicode || isAlphanumeric) {
+        if (isNumeric || isNamed) {
           return {
             value: value,
-            type: isUnicode
-              ? "unicode"
-              : isAlphanumeric
-              ? "alphanumeric"
+            type: isNumeric
+              ? "numeric"
+              : isNamed
+              ? "named"
               : null,
           };
         }
@@ -287,14 +287,14 @@ module.exports = {
             isQuote = true;
           }
           if (
-            pluginOptions.inputFormat === "unicode" &&
-            value === MAPPINGS.singleQuote.unicode
+            pluginOptions.inputFormat === "numeric" &&
+            value === MAPPINGS.singleQuote.numeric
           ) {
             isQuote = true;
           }
           if (
-            pluginOptions.inputFormat === "alphanumeric" &&
-            value === MAPPINGS.singleQuote.alphanumeric
+            pluginOptions.inputFormat === "named" &&
+            value === MAPPINGS.singleQuote.named
           ) {
             isQuote = true;
           }