chore: add JSON schema for test fixture runner

babel · Jan 12, 2021 · e254a38 · e254a38
1 parent b705e7f
commit e254a38
Show file tree

Hide file tree

Showing 4 changed files with 287 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,18 @@
+{
+  "editor.formatOnSave": true,
+  "json.schemas": [
+    {
+      "fileMatch": [
+        "/**/fixtures/*/options.json",
+        "!/packages/babel-parser/test/fixtures/**/options.json"
+      ],
+      "url": "./packages/babel-helper-fixtures/data/schema.json"
+    },
+    {
+      "fileMatch": [
+        "/packages/babel-parser/test/fixtures/**/options.json"
+      ],
+      "url": "./packages/babel-parser/test/schema.json"
+    }
+  ]
+}
diff --git a/packages/babel-helper-fixtures/data/schema.json b/packages/babel-helper-fixtures/data/schema.json
@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Options",
+  "description": "JSON schema for Babel Fixture Test Runner",
+  "allOf": [
+    { "$ref": "#/definitions/TaskOption" },
+    { "$ref": "https://json.schemastore.org/babelrc", "$comment": "Todo: switch to our inhouse schema" }
+  ],
+  "definitions": {
+    "OS": {
+      "type":"string",
+      "description": "The possible values of `process.platform`. See https://nodejs.org/api/process.html#process_process_platform",
+      "enum": ["aix", "darwin", "freebsd", "linux", "openbsd", "sunos", "win32"]
+    },
+    "TaskOption": {
+      "type": "object",
+      "properties": {
+        "BABEL_8_BREAKING": {
+          "description": "Whether this test should run when BABEL_8_BREAKING is enabled",
+          "type":"boolean"
+        },
+        "ignoreOutput": {
+          "description": "Whether the test should generate and compare with output.js",
+          "type": "boolean"
+        },
+        "minNodeVersion": {
+          "description": "The minimum Node.js version this test should run on",
+          "type": "string",
+          "pattern": "^\\d+(\\.\\d+){0,2}$"
+        },
+        "os": {
+          "description": "The OS this test should run on",
+          "anyOf": [
+            { "type": "array", "items": { "$ref": "#/definitions/OS" } },
+            {
+              "$ref": "#/definitions/OS"
+            }
+          ]
+        },
+        "throws": {
+          "description": "Expected thrown error message",
+          "type":"string",
+          "default": ""
+        },
+        "validateLogs": {
+          "description": "Whether this test should validate the stdout and stderr",
+          "type":"boolean",
+          "default": false
+        }
+      }
+    }
+  }
+}
diff --git a/packages/babel-parser/data/schema.json b/packages/babel-parser/data/schema.json
@@ -0,0 +1,195 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "DecoratorsPluginOptions": {
+      "properties": {
+        "decoratorsBeforeExport": {
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "FlowPluginOptions": {
+      "properties": {
+        "all": {
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "PipelineOperatorPluginOptions": {
+      "properties": {
+        "proposal": {
+          "enum": ["fsharp", "minimal", "smart"],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "RecordAndTuplePluginOptions": {
+      "properties": {
+        "syntaxType": {
+          "enum": ["bar", "hash"],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "properties": {
+    "allowAwaitOutsideFunction": {
+      "description": "By default, await use is not allowed outside of an async function.\nSet this to true to accept such code.",
+      "type": "boolean"
+    },
+    "allowImportExportEverywhere": {
+      "description": "By default, import and export declarations can only appear at a program's top level.\nSetting this option to true allows them anywhere where a statement is allowed.",
+      "type": "boolean"
+    },
+    "allowReturnOutsideFunction": {
+      "description": "By default, a return statement at the top level raises an error.\nSet this to true to accept such code.",
+      "type": "boolean"
+    },
+    "allowSuperOutsideMethod": {
+      "type": "boolean"
+    },
+    "allowUndeclaredExports": {
+      "description": "By default, exported identifiers must refer to a declared variable.\nSet this to true to allow export statements to reference undeclared variables.",
+      "type": "boolean"
+    },
+    "createParenthesizedExpressions": {
+      "description": "By default, the parser adds information about parentheses by setting\n`extra.parenthesized` to `true` as needed.\nWhen this option is `true` the parser creates `ParenthesizedExpression`\nAST nodes instead of using the `extra` property.",
+      "type": "boolean"
+    },
+    "errorRecovery": {
+      "description": "By default, Babel always throws an error when it finds some invalid code.\nWhen this option is set to true, it will store the parsing error and\ntry to continue parsing the invalid input file.",
+      "type": "boolean"
+    },
+    "plugins": {
+      "description": "Array containing the plugins that you want to enable.",
+      "items": {
+        "anyOf": [
+          {
+            "items": [
+              {
+                "enum": ["decorators"],
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/DecoratorsPluginOptions"
+              }
+            ],
+            "additionalItems": false,
+            "type": "array"
+          },
+          {
+            "items": [
+              {
+                "enum": ["pipelineOperator"],
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/PipelineOperatorPluginOptions"
+              }
+            ],
+            "additionalItems": false,
+            "type": "array"
+          },
+          {
+            "items": [
+              {
+                "enum": ["recordAndTuple"],
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/RecordAndTuplePluginOptions"
+              }
+            ],
+            "additionalItems": false,
+            "type": "array"
+          },
+          {
+            "items": [
+              {
+                "enum": ["flow"],
+                "type": "string"
+              },
+              {
+                "$ref": "#/definitions/FlowPluginOptions"
+              }
+            ],
+            "additionalItems": false,
+            "type": "array"
+          },
+          {
+            "enum": [
+              "asyncGenerators",
+              "bigInt",
+              "classPrivateMethods",
+              "classPrivateProperties",
+              "classProperties",
+              "classStaticBlock",
+              "decimal",
+              "decorators",
+              "decorators-legacy",
+              "doExpressions",
+              "dynamicImport",
+              "estree",
+              "exportDefaultFrom",
+              "exportNamespaceFrom",
+              "flow",
+              "flowComments",
+              "functionBind",
+              "functionSent",
+              "importAssertions",
+              "importMeta",
+              "jsx",
+              "logicalAssignment",
+              "moduleStringNames",
+              "nullishCoalescingOperator",
+              "numericSeparator",
+              "objectRestSpread",
+              "optionalCatchBinding",
+              "optionalChaining",
+              "partialApplication",
+              "pipelineOperator",
+              "placeholders",
+              "privateIn",
+              "throwExpressions",
+              "topLevelAwait",
+              "typescript",
+              "v8intrinsic"
+            ],
+            "type": "string"
+          }
+        ]
+      },
+      "type": "array"
+    },
+    "ranges": {
+      "description": "Adds a ranges property to each node: [node.start, node.end]",
+      "type": "boolean"
+    },
+    "sourceFilename": {
+      "description": "Correlate output AST nodes with their source filename.\nUseful when generating code and source maps from the ASTs of multiple input files.",
+      "type": "string"
+    },
+    "sourceType": {
+      "description": "Indicate the mode the code should be parsed in.\nCan be one of \"script\", \"module\", or \"unambiguous\". Defaults to \"script\".\n\"unambiguous\" will make @babel/parser attempt to guess, based on the presence\nof ES6 import or export statements.\nFiles with ES6 imports and exports are considered \"module\" and are otherwise \"script\".",
+      "enum": ["module", "script", "unambiguous"],
+      "type": "string"
+    },
+    "startLine": {
+      "description": "By default, the first line of code parsed is treated as line 1.\nYou can provide a line number to alternatively start with.\nUseful for integration with other source tools.",
+      "type": "number"
+    },
+    "strictMode": {
+      "description": "Should the parser work in strict mode.\nDefaults to true if sourceType === 'module'. Otherwise, false.",
+      "type": "boolean"
+    },
+    "tokens": {
+      "description": "Adds all parsed tokens to a tokens property on the File node.",
+      "type": "boolean"
+    }
+  },
+  "type": "object"
+}
diff --git a/packages/babel-parser/test/schema.json b/packages/babel-parser/test/schema.json
@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Options",
+  "description": "JSON schema for Babel Parser Fixture Test Runner",
+  "allOf": [
+    { "$ref": "#/definitions/TaskOption" },
+    { "$ref": "../data/schema.json" }
+  ],
+  "definitions": {
+    "TaskOption": {
+      "type": "object",
+      "properties": {
+        "throws": {
+          "description": "Expected thrown error message",
+          "type":"string",
+          "default": ""
+        }
+      }
+    }
+  }
+}