Change parser (#6)

* Change parser

- Change parser to allow static template literals.
- Change parser to allow undefined identifier.
- Change parser to allow empty slots in array literals.
- Change parser to allow spaces after `-`/`+` sign.
- Change parser to allow number property key.
- Change parser to allow regexp literal.
- Change parser to allow bigint literal.
- Change parser to parse all extensions (not only `.json`).

* fix lint error

* fix bigint test

* fix test

Author: ota-meshi

README.md

@@ -29,7 +29,7 @@ Also, [JSONC] and [JSON5], which are variants of [JSON], are more similar to Jav
 
 ### How does `eslint-plugin-jsonc` work?
 
-This plugin parses `.json` with its own parser, but this parser just converts AST parsed by `espree` (ESLint standard parser) into AST with another name. However, AST that does not exist in [JSON] and [JSON5] will be reported as a parse error. By converting the AST to another name, we prevent false positives from ESLint standard rules.  
+This plugin parses `.json` with its own parser, but this parser just converts AST parsed by `espree` (ESLint standard parser) into AST with another name. However, ASTs that do not exist in [JSON] and JSON-superset syntaxes are reported as parsing errors. By converting the AST to another name, we prevent false positives from ESLint core rules.  
 Moreover, You can do the same linting using the extended rules of the ESLint core rules provided by this plugin.
 
 <!--DOCS_IGNORE_START-->
@@ -54,8 +54,11 @@ npm install --save-dev eslint eslint-plugin-jsonc
 ## Usage
 
 <!--USAGE_SECTION_START-->
+<!--USAGE_GUIDE_START-->
 
-Create `.eslintrc.*` file to configure rules. See also: [http://eslint.org/docs/user-guide/configuring](http://eslint.org/docs/user-guide/configuring).
+### Configuration
+
+Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
 
 Example **.eslintrc.js**:
 
@@ -73,8 +76,6 @@ module.exports = {
 }
 ```
 
-## Configs
-
 This plugin provides configs:
 
 - `plugin:jsonc/base` ... Configuration to enable correct JSON parsing.
@@ -83,7 +84,9 @@ This plugin provides configs:
 - `plugin:jsonc/recommended-with-json5` ... Recommended configuration for JSON5.
 - `plugin:jsonc/auto-config` ... Automatically apply jsonc rules similar to your configured ESLint core rules to JSON.
 
-## Running ESLint from the command line
+See [the rule list](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/) to get the `rules` that this plugin provides.
+
+### Running ESLint from the command line
 
 If you want to run `eslint` from the command line, make sure you include the `.json` extension using [the `--ext` option](https://eslint.org/docs/user-guide/configuring#specifying-file-extensions-to-lint) or a glob pattern, because ESLint targets only `.js` files by default.
 
@@ -116,6 +119,7 @@ Example **.vscode/settings.json**:
 }
 ```
 
+<!--USAGE_GUIDE_END-->
 <!--USAGE_SECTION_END-->
 
 ## Rules

docs/.vuepress/components/components/EslintPluginEditor.vue

@@ -87,7 +87,7 @@ export default {
                 parser: "json-eslint-parser",
                 parserOptions: {
                     sourceType: "script",
-                    ecmaVersion: 2019,
+                    ecmaVersion: 2020,
                 },
             }
         },
@@ -121,7 +121,6 @@ export default {
         // Load linter asynchronously.
         const [{ default: eslint4b }, { parseForESLint }] = await Promise.all([
             import("eslint4b"),
-            // eslint-disable-next-line @mysticatea/node/no-extraneous-import
             import("espree").then(() =>
                 import("../../../../dist/parser/json-eslint-parser")
             ),

docs/README.md

@@ -29,7 +29,7 @@ Also, [JSONC] and [JSON5], which are variants of [JSON], are more similar to Jav
 
 ### How does `eslint-plugin-jsonc` work?
 
-This plugin parses `.json` with its own parser, but this parser just converts AST parsed by `espree` (ESLint standard parser) into AST with another name. However, AST that does not exist in [JSON] and [JSON5] will be reported as a parse error. By converting the AST to another name, we prevent false positives from ESLint standard rules.  
+This plugin parses `.json` with its own parser, but this parser just converts AST parsed by `espree` (ESLint standard parser) into AST with another name. However, ASTs that do not exist in [JSON] and JSON-superset syntaxes are reported as parsing errors. By converting the AST to another name, we prevent false positives from ESLint core rules.  
 Moreover, You can do the same linting using the extended rules of the ESLint core rules provided by this plugin.
 
 ## Usage

docs/user-guide/README.md

@@ -13,6 +13,8 @@ npm install --save-dev eslint eslint-plugin-jsonc
 
 ## Usage
 
+<!--USAGE_GUIDE_START-->
+
 ### Configuration
 
 Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
@@ -75,3 +77,42 @@ Example **.vscode/settings.json**:
   ]
 }
 ```
+
+<!--USAGE_GUIDE_END-->
+
+## :question: FAQ
+
+### How to parse files other than `.json` and `.json5`?
+
+This plugin will parse `.json` and `.json5` using the configuration provided by the plugin.
+To parse other extensions, you need to add a setting to your configuration.
+
+Example **.eslintrc.js**:
+
+```js
+module.exports = {
+  // ...
+  // Add the following settings.
+  overrides: [
+    {
+      files: ["*.json6"], // If you want to parse `.json6`
+      parser: "eslint-plugin-jsonc", // Set this plugin as a parser.
+    },
+  ],
+}
+```
+
+If you want to apply `plugin:jsonc/auto-config` to files with this extension, add the following settings.
+
+```diff
+module.exports = {
+  // ...
+  overrides: [
+    {
+      files: ["*.json6"],
+      parser: "eslint-plugin-jsonc",
++     processor: "jsonc/auto-config",
+    },
+  ],
+}
+```

lib/index.ts

@@ -8,6 +8,7 @@ import recommendedWithJsonc from "./configs/recommended-with-jsonc"
 import recommendedWithJson5 from "./configs/recommended-with-json5"
 import { parseForESLint } from "./parser/json-eslint-parser"
 import { traverseNodes } from "./parser/traverse"
+import { getStaticJSONValue } from "./utils/ast"
 
 const configs = {
     base,
@@ -32,4 +33,5 @@ export = {
 
     // tools
     traverseNodes,
+    getStaticJSONValue,
 }

lib/parser/ast.ts

@@ -28,6 +28,8 @@ export type JSONNode =
     | JSONExpression
     | JSONProperty
     | JSONIdentifier
+    | JSONTemplateLiteral
+    | JSONTemplateElement
 export interface JSONProgram extends BaseJSONNode {
     type: "Program"
     body: [JSONExpressionStatement]
@@ -48,10 +50,12 @@ export type JSONExpression =
     | JSONLiteral
     | JSONUnaryExpression
     | JSONNumberIdentifier
+    | JSONUndefinedIdentifier
+    | JSONTemplateLiteral
 
 export interface JSONArrayExpression extends BaseJSONNode {
     type: "JSONArrayExpression"
-    elements: JSONExpression[]
+    elements: (JSONExpression | null)[]
     parent?: JSONArrayExpression | JSONProperty | JSONExpressionStatement
 }
 
@@ -63,7 +67,7 @@ export interface JSONObjectExpression extends BaseJSONNode {
 
 export interface JSONProperty extends BaseJSONNode {
     type: "JSONProperty"
-    key: JSONIdentifier | JSONLiteral
+    key: JSONIdentifier | JSONStringLiteral | JSONNumberLiteral
     value: JSONExpression
     kind: "init"
     method: false
@@ -86,9 +90,11 @@ export interface JSONNumberIdentifier extends JSONIdentifier {
     name: "Infinity" | "NaN"
 }
 
-export interface JSONLiteral extends BaseJSONNode {
+export interface JSONUndefinedIdentifier extends JSONIdentifier {
+    name: "undefined"
+}
+interface JSONLiteralBase extends BaseJSONNode {
     type: "JSONLiteral"
-    value: string | boolean | number | null
     raw: string
     parent?:
         | JSONArrayExpression
@@ -97,16 +103,63 @@ export interface JSONLiteral extends BaseJSONNode {
         | JSONUnaryExpression
 }
 
-export interface JSONNumberLiteral extends JSONLiteral {
-    type: "JSONLiteral"
+export interface JSONStringLiteral extends JSONLiteralBase {
+    value: string
+    regex: null
+    bigint: null
+}
+export interface JSONNumberLiteral extends JSONLiteralBase {
     value: number
-    raw: string
+    regex: null
+    bigint: null
+}
+export interface JSONKeywordLiteral extends JSONLiteralBase {
+    value: boolean | null
+    regex: null
+    bigint: null
+}
+export interface JSONRegExpLiteral extends JSONLiteralBase {
+    value: null
+    regex: {
+        pattern: string
+        flags: string
+    }
+    bigint: null
+}
+export interface JSONBigIntLiteral extends JSONLiteralBase {
+    value: null
+    regex: null
+    bigint: string
 }
 
+export type JSONLiteral =
+    | JSONStringLiteral
+    | JSONNumberLiteral
+    | JSONKeywordLiteral
+    | JSONRegExpLiteral
+    | JSONBigIntLiteral
+
 export interface JSONUnaryExpression extends BaseJSONNode {
     type: "JSONUnaryExpression"
     operator: "-" | "+"
     prefix: true
     argument: JSONNumberLiteral | JSONNumberIdentifier
     parent?: JSONArrayExpression | JSONProperty | JSONExpressionStatement
 }
+
+export interface JSONTemplateLiteral extends BaseJSONNode {
+    type: "JSONTemplateLiteral"
+    quasis: [JSONTemplateElement]
+    expressions: []
+    parent?: JSONArrayExpression | JSONProperty | JSONExpressionStatement
+}
+
+export interface JSONTemplateElement extends BaseJSONNode {
+    type: "JSONTemplateElement"
+    tail: boolean
+    value: {
+        cooked: string
+        raw: string
+    }
+    parent?: JSONTemplateLiteral
+}