Add jsonc/no-bigint-literals rule (#12)

Author: ota-meshi

README.md

@@ -135,6 +135,7 @@ The rules with the following star :star: are included in the config.
 
 | Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
 |:--------|:------------|:-------:|:----:|:-----:|:-----:|
+| [jsonc/no-bigint-literals](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-bigint-literals.html) | disallow BigInt literals |  | :star: | :star: | :star: |
 | [jsonc/no-comments](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-comments.html) | disallow comments |  | :star: |  |  |
 | [jsonc/no-number-props](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-number-props.html) | disallow number property keys | :wrench: | :star: | :star: | :star: |
 | [jsonc/no-regexp-literals](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-regexp-literals.html) | disallow RegExp literals |  | :star: | :star: | :star: |

docs/rules/README.md

@@ -13,6 +13,7 @@ The rules with the following star :star: are included in the `plugin:jsonc/recom
 
 | Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
 |:--------|:------------|:-------:|:----:|:-----:|:-----:|
+| [jsonc/no-bigint-literals](./no-bigint-literals.md) | disallow BigInt literals |  | :star: | :star: | :star: |
 | [jsonc/no-comments](./no-comments.md) | disallow comments |  | :star: |  |  |
 | [jsonc/no-number-props](./no-number-props.md) | disallow number property keys | :wrench: | :star: | :star: | :star: |
 | [jsonc/no-regexp-literals](./no-regexp-literals.md) | disallow RegExp literals |  | :star: | :star: | :star: |

docs/rules/no-bigint-literals.md

@@ -0,0 +1,41 @@
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "jsonc/no-bigint-literals"
+description: "disallow BigInt literals"
+---
+# jsonc/no-bigint-literals
+
+> disallow BigInt 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"`.
+
+## :book: Rule Details
+
+This rule reports the use of BigInt literals.
+
+JSON, JSONC and JSON5 do not allow BigInt literals.
+
+<eslint-code-block>
+
+```json5
+/* eslint jsonc/no-bigint-literals: 'error' */
+{
+    /* ✓ GOOD */
+    "GOOD": 42,
+
+    /* ✗ BAD */
+    "BAD": 42n
+}
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+Nothing.
+
+## Implementation
+
+- [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-bigint-literals.ts)
+- [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-bigint-literals.js)

lib/configs/recommended-with-json.ts

@@ -7,6 +7,7 @@ export = {
     rules: {
         // eslint-plugin-jsonc rules
         "jsonc/comma-dangle": "error",
+        "jsonc/no-bigint-literals": "error",
         "jsonc/no-comments": "error",
         "jsonc/no-dupe-keys": "error",
         "jsonc/no-multi-str": "error",

lib/configs/recommended-with-json5.ts

@@ -6,6 +6,7 @@ export = {
     extends: [baseExtend],
     rules: {
         // eslint-plugin-jsonc rules
+        "jsonc/no-bigint-literals": "error",
         "jsonc/no-dupe-keys": "error",
         "jsonc/no-number-props": "error",
         "jsonc/no-regexp-literals": "error",

lib/configs/recommended-with-jsonc.ts

@@ -6,6 +6,7 @@ export = {
     extends: [baseExtend],
     rules: {
         // eslint-plugin-jsonc rules
+        "jsonc/no-bigint-literals": "error",
         "jsonc/no-dupe-keys": "error",
         "jsonc/no-multi-str": "error",
         "jsonc/no-number-props": "error",

lib/rules/no-bigint-literals.ts

@@ -0,0 +1,29 @@
+import type { JSONLiteral } from "../parser/ast"
+import { createRule } from "../utils"
+
+export default createRule("no-bigint-literals", {
+    meta: {
+        docs: {
+            description: "disallow BigInt literals",
+            recommended: ["json", "jsonc", "json5"],
+            extensionRule: false,
+        },
+        schema: [],
+        messages: {
+            unexpected: "BigInt literals are not allowed.",
+        },
+        type: "problem",
+    },
+    create(context) {
+        return {
+            JSONLiteral(node: JSONLiteral) {
+                if (node.bigint != null) {
+                    context.report({
+                        loc: node.loc,
+                        messageId: "unexpected",
+                    })
+                }
+            },
+        }
+    },
+})

lib/utils/rules.ts

@@ -6,6 +6,7 @@ import commaDangle from "../rules/comma-dangle"
 import commaStyle from "../rules/comma-style"
 import indent from "../rules/indent"
 import keySpacing from "../rules/key-spacing"
+import noBigintLiterals from "../rules/no-bigint-literals"
 import noComments from "../rules/no-comments"
 import noDupeKeys from "../rules/no-dupe-keys"
 import noMultiStr from "../rules/no-multi-str"
@@ -33,6 +34,7 @@ export const rules = [
     commaStyle,
     indent,
     keySpacing,
+    noBigintLiterals,
     noComments,
     noDupeKeys,
     noMultiStr,

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

@@ -0,0 +1,26 @@
+import { RuleTester } from "eslint"
+import rule from "../../../lib/rules/no-bigint-literals"
+
+const tester = new RuleTester({
+    parser: require.resolve("../../../lib/parser/json-eslint-parser"),
+    parserOptions: {
+        ecmaVersion: 2020,
+    },
+})
+
+tester.run("no-bigint-literals", rule as any, {
+    valid: ['{"key": "value"}', '"string"', '["element"]'],
+    invalid: [
+        {
+            code: "42n",
+            errors: ["BigInt literals are not allowed."],
+        },
+        {
+            code: "[1n, {'2n': 3n}]",
+            errors: [
+                "BigInt literals are not allowed.",
+                "BigInt literals are not allowed.",
+            ],
+        },
+    ],
+})