eslint-plugin-toml 0.1.0 → 0.3.1

package/README.md

@@ -40,7 +40,7 @@ npm install --save-dev eslint eslint-plugin-toml
 > **Requirements**
 >
 > - ESLint v6.0.0 and above
-> - Node.js v8.10.0 and above
+> - Node.js v12.22.x, v14.17.x, v16.x and above
 
 <!--DOCS_IGNORE_END-->
 
@@ -82,7 +82,7 @@ For example, the following style rules can also be used in TOML.
 {
     "rules": {
         "comma-spacing": "error",
-        "no-multi-spaces": "error",
+        "no-multi-spaces": ["error", { "exceptions": { "TOMLKeyValue": true } }],
         "no-multiple-empty-lines": "error",
         "no-trailing-spaces": "error"
     }
@@ -91,6 +91,29 @@ For example, the following style rules can also be used in TOML.
 
 See [the rule list](https://ota-meshi.github.io/eslint-plugin-toml/rules/) to get the `rules` that this plugin provides.
 
+#### Parser Configuration
+
+If you have specified a parser, you need to configure a parser for `.toml`.
+
+For example, if you are using the `"@babel/eslint-parser"`, configure it as follows:
+
+```js
+module.exports = {
+  // ...
+  extends: ["plugin:toml/standard"],
+  // ...
+  parser: "@babel/eslint-parser",
+  // Add an `overrides` section to add a parser configuration for TOML.
+  overrides: [
+    {
+      files: ["*.toml"],
+      parser: "toml-eslint-parser",
+    },
+  ],
+  // ...
+};
+```
+
 ### Running ESLint from the command line
 
 If you want to run `eslint` from the command line, make sure you include the `.toml` 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.
@@ -149,7 +172,6 @@ The rules with the following star :star: are included in the configs.
 | [toml/precision-of-fractional-seconds](https://ota-meshi.github.io/eslint-plugin-toml/rules/precision-of-fractional-seconds.html) | disallow precision of fractional seconds greater than the specified value. |  | :star: | :star: |
 | [toml/precision-of-integer](https://ota-meshi.github.io/eslint-plugin-toml/rules/precision-of-integer.html) | disallow precision of integer greater than the specified value. |  | :star: | :star: |
 | [toml/quoted-keys](https://ota-meshi.github.io/eslint-plugin-toml/rules/quoted-keys.html) | require or disallow quotes around keys | :wrench: |  | :star: |
-| [toml/space-eq-sign](https://ota-meshi.github.io/eslint-plugin-toml/rules/space-eq-sign.html) | require spacing around equals sign | :wrench: |  | :star: |
 | [toml/tables-order](https://ota-meshi.github.io/eslint-plugin-toml/rules/tables-order.html) | disallow defining tables out-of-order | :wrench: |  | :star: |
 | [toml/vue-custom-block/no-parsing-error](https://ota-meshi.github.io/eslint-plugin-toml/rules/vue-custom-block/no-parsing-error.html) | disallow parsing errors in Vue custom blocks |  | :star: | :star: |
 
@@ -162,9 +184,19 @@ The rules with the following star :star: are included in the configs.
 | [toml/array-element-newline](https://ota-meshi.github.io/eslint-plugin-toml/rules/array-element-newline.html) | enforce line breaks between array elements | :wrench: |  | :star: |
 | [toml/comma-style](https://ota-meshi.github.io/eslint-plugin-toml/rules/comma-style.html) | enforce consistent comma style in array | :wrench: |  | :star: |
 | [toml/inline-table-curly-spacing](https://ota-meshi.github.io/eslint-plugin-toml/rules/inline-table-curly-spacing.html) | enforce consistent spacing inside braces | :wrench: |  | :star: |
+| [toml/key-spacing](https://ota-meshi.github.io/eslint-plugin-toml/rules/key-spacing.html) | enforce consistent spacing between keys and values in key/value pairs | :wrench: |  | :star: |
 | [toml/spaced-comment](https://ota-meshi.github.io/eslint-plugin-toml/rules/spaced-comment.html) | enforce consistent spacing after the `#` in a comment | :wrench: |  | :star: |
 | [toml/table-bracket-spacing](https://ota-meshi.github.io/eslint-plugin-toml/rules/table-bracket-spacing.html) | enforce consistent spacing inside table brackets | :wrench: |  | :star: |
 
+## Deprecated
+
+- :warning: We're going to remove deprecated rules in the next major release. Please migrate to successor/new rules.
+- :innocent: We don't fix bugs which are in deprecated rules since we don't have enough resources.
+
+| Rule ID | Replaced by |
+|:--------|:------------|
+| [toml/space-eq-sign](https://ota-meshi.github.io/eslint-plugin-toml/rules/space-eq-sign.html) | [toml/key-spacing](https://ota-meshi.github.io/eslint-plugin-toml/rules/key-spacing.html.md) |
+
 <!--RULES_TABLE_END-->
 <!--RULES_SECTION_END-->
 
@@ -191,6 +223,7 @@ This plugin uses [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-p
 
 - [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
 - [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
+- [eslint-plugin-json-schema-validator](https://github.com/ota-meshi/eslint-plugin-json-schema-validator) ... ESLint plugin that validates data using JSON Schema Validator.
 - [jsonc-eslint-parser](https://github.com/ota-meshi/jsonc-eslint-parser) ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
 - [yaml-eslint-parser](https://github.com/ota-meshi/yaml-eslint-parser) ... YAML parser for use with ESLint plugins.
 - [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-parser) ... TOML parser for use with ESLint plugins.

package/lib/configs/standard.d.ts

@@ -7,6 +7,7 @@ declare const _default: {
         "toml/comma-style": string;
         "toml/indent": string;
         "toml/inline-table-curly-spacing": string;
+        "toml/key-spacing": string;
         "toml/keys-order": string;
         "toml/no-space-dots": string;
         "toml/no-unreadable-number-separator": string;
@@ -15,7 +16,6 @@ declare const _default: {
         "toml/precision-of-fractional-seconds": string;
         "toml/precision-of-integer": string;
         "toml/quoted-keys": string;
-        "toml/space-eq-sign": string;
         "toml/spaced-comment": string;
         "toml/table-bracket-spacing": string;
         "toml/tables-order": string;

package/lib/configs/standard.js

@@ -14,6 +14,7 @@ module.exports = {
         "toml/comma-style": "error",
         "toml/indent": "error",
         "toml/inline-table-curly-spacing": "error",
+        "toml/key-spacing": "error",
         "toml/keys-order": "error",
         "toml/no-space-dots": "error",
         "toml/no-unreadable-number-separator": "error",
@@ -22,7 +23,6 @@ module.exports = {
         "toml/precision-of-fractional-seconds": "error",
         "toml/precision-of-integer": "error",
         "toml/quoted-keys": "error",
-        "toml/space-eq-sign": "error",
         "toml/spaced-comment": "error",
         "toml/table-bracket-spacing": "error",
         "toml/tables-order": "error",

package/lib/index.d.ts

@@ -30,6 +30,7 @@ declare const _default: {
                 "toml/comma-style": string;
                 "toml/indent": string;
                 "toml/inline-table-curly-spacing": string;
+                "toml/key-spacing": string;
                 "toml/keys-order": string;
                 "toml/no-space-dots": string;
                 "toml/no-unreadable-number-separator": string;
@@ -38,7 +39,6 @@ declare const _default: {
                 "toml/precision-of-fractional-seconds": string;
                 "toml/precision-of-integer": string;
                 "toml/quoted-keys": string;
-                "toml/space-eq-sign": string;
                 "toml/spaced-comment": string;
                 "toml/table-bracket-spacing": string;
                 "toml/tables-order": string;

package/lib/rules/array-bracket-newline.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const coreRule = utils_1.getCoreRule("array-bracket-newline");
-exports.default = utils_1.createRule("array-bracket-newline", {
+const coreRule = (0, utils_1.getCoreRule)("array-bracket-newline");
+exports.default = (0, utils_1.createRule)("array-bracket-newline", {
     meta: {
         docs: {
             description: "enforce linebreaks after opening and before closing array brackets",
@@ -10,17 +10,18 @@ exports.default = utils_1.createRule("array-bracket-newline", {
             extensionRule: "array-bracket-newline",
         },
         fixable: coreRule.meta.fixable,
+        hasSuggestions: coreRule.meta.hasSuggestions,
         schema: coreRule.meta.schema,
         messages: coreRule.meta.messages,
         type: coreRule.meta.type,
     },
     create(context) {
-        return utils_1.defineWrapperListener(coreRule, context, {
+        return (0, utils_1.defineWrapperListener)(coreRule, context, {
             options: context.options,
             createListenerProxy(listener) {
                 return {
                     TOMLArray(node) {
-                        listener.ArrayExpression(utils_1.convertESNode(node));
+                        listener.ArrayExpression((0, utils_1.convertESNode)(node));
                     },
                 };
             },

package/lib/rules/array-bracket-spacing.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const coreRule = utils_1.getCoreRule("array-bracket-spacing");
-exports.default = utils_1.createRule("array-bracket-spacing", {
+const coreRule = (0, utils_1.getCoreRule)("array-bracket-spacing");
+exports.default = (0, utils_1.createRule)("array-bracket-spacing", {
     meta: {
         docs: {
             description: "enforce consistent spacing inside array brackets",
@@ -10,12 +10,13 @@ exports.default = utils_1.createRule("array-bracket-spacing", {
             extensionRule: "array-bracket-spacing",
         },
         fixable: coreRule.meta.fixable,
+        hasSuggestions: coreRule.meta.hasSuggestions,
         schema: coreRule.meta.schema,
         messages: coreRule.meta.messages,
         type: coreRule.meta.type,
     },
     create(context) {
-        return utils_1.defineWrapperListener(coreRule, context, {
+        return (0, utils_1.defineWrapperListener)(coreRule, context, {
             options: [
                 context.options[0] || "always",
                 ...context.options.slice(1),
@@ -23,7 +24,7 @@ exports.default = utils_1.createRule("array-bracket-spacing", {
             createListenerProxy(listener) {
                 return {
                     TOMLArray(node) {
-                        listener.ArrayExpression(utils_1.convertESNode(node));
+                        listener.ArrayExpression((0, utils_1.convertESNode)(node));
                     },
                 };
             },

package/lib/rules/array-element-newline.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const coreRule = utils_1.getCoreRule("array-element-newline");
-exports.default = utils_1.createRule("array-element-newline", {
+const coreRule = (0, utils_1.getCoreRule)("array-element-newline");
+exports.default = (0, utils_1.createRule)("array-element-newline", {
     meta: {
         docs: {
             description: "enforce line breaks between array elements",
@@ -10,17 +10,18 @@ exports.default = utils_1.createRule("array-element-newline", {
             extensionRule: "array-element-newline",
         },
         fixable: coreRule.meta.fixable,
+        hasSuggestions: coreRule.meta.hasSuggestions,
         schema: coreRule.meta.schema,
         messages: coreRule.meta.messages,
         type: coreRule.meta.type,
     },
     create(context) {
-        return utils_1.defineWrapperListener(coreRule, context, {
+        return (0, utils_1.defineWrapperListener)(coreRule, context, {
             options: context.options,
             createListenerProxy(listener) {
                 return {
                     TOMLArray(node) {
-                        listener.ArrayExpression(utils_1.convertESNode(node));
+                        listener.ArrayExpression((0, utils_1.convertESNode)(node));
                     },
                 };
             },

package/lib/rules/comma-style.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const coreRule = utils_1.getCoreRule("comma-style");
-exports.default = utils_1.createRule("comma-style", {
+const coreRule = (0, utils_1.getCoreRule)("comma-style");
+exports.default = (0, utils_1.createRule)("comma-style", {
     meta: {
         docs: {
             description: "enforce consistent comma style in array",
@@ -10,6 +10,7 @@ exports.default = utils_1.createRule("comma-style", {
             extensionRule: "comma-style",
         },
         fixable: coreRule.meta.fixable,
+        hasSuggestions: coreRule.meta.hasSuggestions,
         schema: coreRule.meta.schema,
         messages: coreRule.meta.messages,
         type: coreRule.meta.type,
@@ -18,12 +19,12 @@ exports.default = utils_1.createRule("comma-style", {
         if (!context.parserServices.isTOML) {
             return {};
         }
-        return utils_1.defineWrapperListener(coreRule, context, {
+        return (0, utils_1.defineWrapperListener)(coreRule, context, {
             options: [context.options[0]],
             createListenerProxy(listener) {
                 return {
                     TOMLArray(node) {
-                        listener.ArrayExpression(utils_1.convertESNode(node));
+                        listener.ArrayExpression((0, utils_1.convertESNode)(node));
                     },
                 };
             },

package/lib/rules/indent.js

@@ -18,7 +18,7 @@ function buildIndentUtility(optionValue) {
     };
 }
 exports.buildIndentUtility = buildIndentUtility;
-exports.default = utils_1.createRule("indent", {
+exports.default = (0, utils_1.createRule)("indent", {
     meta: {
         docs: {
             description: "enforce consistent indentation",
@@ -159,7 +159,7 @@ exports.default = utils_1.createRule("indent", {
                         }
                     }
                     if (body.type === "TOMLTable") {
-                        const keys = toml_eslint_parser_1.getStaticTOMLValue(body.key);
+                        const keys = (0, toml_eslint_parser_1.getStaticTOMLValue)(body.key);
                         const offset = getTableOffset(keys);
                         tableKeyStack.push({ keys, offset });
                         if (bodyFirstToken !== first) {
@@ -293,7 +293,7 @@ exports.default = utils_1.createRule("indent", {
                     continue;
                 }
                 const line = lineIndent.line;
-                if (ast_utils_1.isCommentToken(lineIndent.firstToken)) {
+                if ((0, ast_utils_1.isCommentToken)(lineIndent.firstToken)) {
                     const last = commentLines[commentLines.length - 1];
                     if (last && last.range[1] === line - 1) {
                         last.range[1] = line;

package/lib/rules/inline-table-curly-spacing.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const coreRule = utils_1.getCoreRule("object-curly-spacing");
-exports.default = utils_1.createRule("inline-table-curly-spacing", {
+const coreRule = (0, utils_1.getCoreRule)("object-curly-spacing");
+exports.default = (0, utils_1.createRule)("inline-table-curly-spacing", {
     meta: {
         docs: {
             description: "enforce consistent spacing inside braces",
@@ -10,12 +10,13 @@ exports.default = utils_1.createRule("inline-table-curly-spacing", {
             extensionRule: "object-curly-spacing",
         },
         fixable: coreRule.meta.fixable,
+        hasSuggestions: coreRule.meta.hasSuggestions,
         schema: coreRule.meta.schema,
         messages: coreRule.meta.messages,
         type: coreRule.meta.type,
     },
     create(context) {
-        return utils_1.defineWrapperListener(coreRule, context, {
+        return (0, utils_1.defineWrapperListener)(coreRule, context, {
             options: [
                 context.options[0] || "always",
                 ...context.options.slice(1),
@@ -23,7 +24,7 @@ exports.default = utils_1.createRule("inline-table-curly-spacing", {
             createListenerProxy(listener) {
                 return {
                     TOMLInlineTable(node) {
-                        listener.ObjectExpression(utils_1.convertESNode(node));
+                        listener.ObjectExpression((0, utils_1.convertESNode)(node));
                     },
                 };
             },

package/lib/rules/key-spacing.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../types").RuleModule;
+export default _default;