Add jsonc/no-template-literals rule (#9)

* Add ``jsonc/no-template-literals` rule

* Add parallel-finished

* update

Author: ota-meshi

.github/workflows/NodeCI.yml

@@ -52,6 +52,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - uses: actions/setup-node@v1
+      with:
+        node-version: 10.x
     - name: Install Packages
       run: npm install
     - name: Test

README.md

@@ -136,6 +136,7 @@ The rules with the following star :star: are included in the config.
 | Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
 |:--------|:------------|:-------:|:----:|:-----:|:-----:|
 | [jsonc/no-comments](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-comments.html) | disallow comments |  | :star: |  |  |
+| [jsonc/no-template-literals](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-template-literals.html) | disallow template literals | :wrench: | :star: | :star: | :star: |
 | [jsonc/valid-json-number](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/valid-json-number.html) | disallow invalid number for JSON | :wrench: | :star: | :star: |  |
 
 ## Extension Rules

docs/rules/README.md

@@ -14,6 +14,7 @@ The rules with the following star :star: are included in the `plugin:jsonc/recom
 | Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
 |:--------|:------------|:-------:|:----:|:-----:|:-----:|
 | [jsonc/no-comments](./no-comments.md) | disallow comments |  | :star: |  |  |
+| [jsonc/no-template-literals](./no-template-literals.md) | disallow template literals | :wrench: | :star: | :star: | :star: |
 | [jsonc/valid-json-number](./valid-json-number.md) | disallow invalid number for JSON | :wrench: | :star: | :star: |  |
 
 ## Extension Rules

docs/rules/no-template-literals.md

@@ -0,0 +1,42 @@
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "jsonc/no-template-literals"
+description: "disallow template literals"
+---
+# jsonc/no-template-literals
+
+> disallow template literals
+
+- :gear: This rule is included in all of `"plugin:jsonc/recommended-with-json"`, `"plugin:jsonc/recommended-with-json5"` and `"plugin:jsonc/recommended-with-jsonc"`.
+- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+
+## :book: Rule Details
+
+This rule reports the use of template literals.
+
+JSON, JSONC and JSON5 do not allow template literal.
+
+<eslint-code-block fix>
+
+```json5
+/* eslint jsonc/no-template-literals: 'error' */
+{
+    /* ✓ GOOD */
+    "GOOD": "foo",
+
+    /* ✗ BAD */
+    "BAD": `bar`
+}
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+Nothing.
+
+## Implementation
+
+- [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-template-literals.ts)
+- [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-template-literals.js)

lib/configs/recommended-with-json.ts

@@ -10,6 +10,7 @@ export = {
         "jsonc/no-comments": "error",
         "jsonc/no-dupe-keys": "error",
         "jsonc/no-multi-str": "error",
+        "jsonc/no-template-literals": "error",
         "jsonc/no-useless-escape": "error",
         "jsonc/quote-props": "error",
         "jsonc/quotes": "error",

lib/configs/recommended-with-json5.ts

@@ -7,6 +7,7 @@ export = {
     rules: {
         // eslint-plugin-jsonc rules
         "jsonc/no-dupe-keys": "error",
+        "jsonc/no-template-literals": "error",
         "jsonc/no-useless-escape": "error",
     },
 }

lib/configs/recommended-with-jsonc.ts

@@ -8,6 +8,7 @@ export = {
         // eslint-plugin-jsonc rules
         "jsonc/no-dupe-keys": "error",
         "jsonc/no-multi-str": "error",
+        "jsonc/no-template-literals": "error",
         "jsonc/no-useless-escape": "error",
         "jsonc/quote-props": "error",
         "jsonc/quotes": "error",

lib/rules/no-template-literals.ts

@@ -0,0 +1,35 @@
+import type { JSONTemplateLiteral } from "../parser/ast"
+import { createRule } from "../utils"
+
+export default createRule("no-template-literals", {
+    meta: {
+        docs: {
+            description: "disallow template literals",
+            recommended: ["json", "jsonc", "json5"],
+            extensionRule: false,
+        },
+        fixable: "code",
+        schema: [],
+        messages: {
+            unexpected: "The template literals are not allowed.",
+        },
+        type: "problem",
+    },
+    create(context) {
+        return {
+            JSONTemplateLiteral(node: JSONTemplateLiteral) {
+                context.report({
+                    loc: node.loc,
+                    messageId: "unexpected",
+                    fix(fixer) {
+                        const s = node.quasis[0].value.cooked
+                        return fixer.replaceTextRange(
+                            node.range,
+                            JSON.stringify(s),
+                        )
+                    },
+                })
+            },
+        }
+    },
+})

lib/utils/rules.ts

@@ -10,6 +10,7 @@ import noComments from "../rules/no-comments"
 import noDupeKeys from "../rules/no-dupe-keys"
 import noMultiStr from "../rules/no-multi-str"
 import noOctalEscape from "../rules/no-octal-escape"
+import noTemplateLiterals from "../rules/no-template-literals"
 import noUselessEscape from "../rules/no-useless-escape"
 import objectCurlyNewline from "../rules/object-curly-newline"
 import objectCurlySpacing from "../rules/object-curly-spacing"
@@ -31,6 +32,7 @@ export const rules = [
     noDupeKeys,
     noMultiStr,
     noOctalEscape,
+    noTemplateLiterals,
     noUselessEscape,
     objectCurlyNewline,
     objectCurlySpacing,

tests/lib/rules/no-template-literals.ts

@@ -0,0 +1,35 @@
+import { RuleTester } from "eslint"
+import rule from "../../../lib/rules/no-template-literals"
+
+const tester = new RuleTester({
+    parser: require.resolve("../../../lib/parser/json-eslint-parser"),
+    parserOptions: {
+        ecmaVersion: 2020,
+    },
+})
+
+tester.run("no-template-literals", rule as any, {
+    valid: ['{"key": "value"}', '"string"', '["element"]'],
+    invalid: [
+        {
+            code: "`template`",
+            output: '"template"',
+            errors: ["The template literals are not allowed."],
+        },
+        {
+            code: "[`template`]",
+            output: '["template"]',
+            errors: ["The template literals are not allowed."],
+        },
+        {
+            code: '{"foo":`template`}',
+            output: '{"foo":"template"}',
+            errors: ["The template literals are not allowed."],
+        },
+        {
+            code: "`temp\n\nlate`",
+            output: '"temp\\n\\nlate"',
+            errors: ["The template literals are not allowed."],
+        },
+    ],
+})