eslint-plugin-toml 0.9.2 → 0.11.0

package/README.md

@@ -51,7 +51,38 @@ npm install --save-dev eslint eslint-plugin-toml
 
 ### Configuration
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+#### New Config (`eslint.config.js`)
+
+Use `eslint.config.js` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/configuration-files-new>.
+
+Example **eslint.config.js**:
+
+```mjs
+import eslintPluginToml from 'eslint-plugin-toml';
+export default [
+  // add more generic rule sets here, such as:
+  // js.configs.recommended,
+  ...eslintPluginToml.configs['flat/recommended'],
+  {
+    rules: {
+      // override/add rules settings here, such as:
+    // 'toml/rule-name': 'error'
+    }
+  }
+];
+```
+
+This plugin provides configs:
+
+- `*.configs['flat/base']` ... Configuration to enable correct TOML parsing.
+- `*.configs['flat/recommended']` ... Above, plus rules to prevent errors or unintended behavior.
+- `*.configs['flat/standard']` ... Above, plus rules to enforce the common stylistic conventions.
+
+See [the rule list](https://ota-meshi.github.io/eslint-plugin-toml/rules/) to get the `rules` that this plugin provides.
+
+#### Legacy Config (`.eslintrc`)
+
+Use `.eslintrc.*` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/>.
 
 Example **.eslintrc.js**:
 

package/lib/configs/flat/base.d.ts

@@ -0,0 +1,21 @@
+import type { ESLint } from "eslint";
+import * as parser from "toml-eslint-parser";
+declare const _default: ({
+    plugins: {
+        readonly toml: ESLint.Plugin;
+    };
+    files?: undefined;
+    languageOptions?: undefined;
+    rules?: undefined;
+} | {
+    files: string[];
+    languageOptions: {
+        parser: typeof parser;
+    };
+    rules: {
+        "no-irregular-whitespace": "off";
+        "spaced-comment": "off";
+    };
+    plugins?: undefined;
+})[];
+export default _default;

package/lib/configs/flat/base.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const parser = __importStar(require("toml-eslint-parser"));
+exports.default = [
+    {
+        plugins: {
+            get toml() {
+                return require("../../index");
+            },
+        },
+    },
+    {
+        files: ["*.toml", "**/*.toml"],
+        languageOptions: {
+            parser,
+        },
+        rules: {
+            "no-irregular-whitespace": "off",
+            "spaced-comment": "off",
+        },
+    },
+];

package/lib/configs/flat/recommended.d.ts

@@ -0,0 +1,26 @@
+declare const _default: ({
+    plugins: {
+        readonly toml: import("eslint").ESLint.Plugin;
+    };
+    files?: undefined;
+    languageOptions?: undefined;
+    rules?: undefined;
+} | {
+    files: string[];
+    languageOptions: {
+        parser: typeof import("toml-eslint-parser");
+    };
+    rules: {
+        "no-irregular-whitespace": "off";
+        "spaced-comment": "off";
+    };
+    plugins?: undefined;
+} | {
+    rules: {
+        "toml/no-unreadable-number-separator": "error";
+        "toml/precision-of-fractional-seconds": "error";
+        "toml/precision-of-integer": "error";
+        "toml/vue-custom-block/no-parsing-error": "error";
+    };
+})[];
+export default _default;

package/lib/configs/flat/recommended.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = __importDefault(require("./base"));
+exports.default = [
+    ...base_1.default,
+    {
+        rules: {
+            "toml/no-unreadable-number-separator": "error",
+            "toml/precision-of-fractional-seconds": "error",
+            "toml/precision-of-integer": "error",
+            "toml/vue-custom-block/no-parsing-error": "error",
+        },
+    },
+];

package/lib/configs/flat/standard.d.ts

@@ -0,0 +1,41 @@
+declare const _default: ({
+    plugins: {
+        readonly toml: import("eslint").ESLint.Plugin;
+    };
+    files?: undefined;
+    languageOptions?: undefined;
+    rules?: undefined;
+} | {
+    files: string[];
+    languageOptions: {
+        parser: typeof import("toml-eslint-parser");
+    };
+    rules: {
+        "no-irregular-whitespace": "off";
+        "spaced-comment": "off";
+    };
+    plugins?: undefined;
+} | {
+    rules: {
+        "toml/array-bracket-newline": "error";
+        "toml/array-bracket-spacing": "error";
+        "toml/array-element-newline": "error";
+        "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";
+        "toml/padding-line-between-pairs": "error";
+        "toml/padding-line-between-tables": "error";
+        "toml/precision-of-fractional-seconds": "error";
+        "toml/precision-of-integer": "error";
+        "toml/quoted-keys": "error";
+        "toml/spaced-comment": "error";
+        "toml/table-bracket-spacing": "error";
+        "toml/tables-order": "error";
+        "toml/vue-custom-block/no-parsing-error": "error";
+    };
+})[];
+export default _default;

package/lib/configs/flat/standard.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = __importDefault(require("./base"));
+exports.default = [
+    ...base_1.default,
+    {
+        rules: {
+            "toml/array-bracket-newline": "error",
+            "toml/array-bracket-spacing": "error",
+            "toml/array-element-newline": "error",
+            "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",
+            "toml/padding-line-between-pairs": "error",
+            "toml/padding-line-between-tables": "error",
+            "toml/precision-of-fractional-seconds": "error",
+            "toml/precision-of-integer": "error",
+            "toml/quoted-keys": "error",
+            "toml/spaced-comment": "error",
+            "toml/table-bracket-spacing": "error",
+            "toml/tables-order": "error",
+            "toml/vue-custom-block/no-parsing-error": "error",
+        },
+    },
+];

package/lib/index.d.ts

@@ -47,6 +47,89 @@ declare const _default: {
                 "toml/vue-custom-block/no-parsing-error": string;
             };
         };
+        "flat/base": ({
+            plugins: {
+                readonly toml: import("eslint").ESLint.Plugin;
+            };
+            files?: undefined;
+            languageOptions?: undefined;
+            rules?: undefined;
+        } | {
+            files: string[];
+            languageOptions: {
+                parser: typeof import("toml-eslint-parser");
+            };
+            rules: {
+                "no-irregular-whitespace": "off";
+                "spaced-comment": "off";
+            };
+            plugins?: undefined;
+        })[];
+        "flat/recommended": ({
+            plugins: {
+                readonly toml: import("eslint").ESLint.Plugin;
+            };
+            files?: undefined;
+            languageOptions?: undefined;
+            rules?: undefined;
+        } | {
+            files: string[];
+            languageOptions: {
+                parser: typeof import("toml-eslint-parser");
+            };
+            rules: {
+                "no-irregular-whitespace": "off";
+                "spaced-comment": "off";
+            };
+            plugins?: undefined;
+        } | {
+            rules: {
+                "toml/no-unreadable-number-separator": "error";
+                "toml/precision-of-fractional-seconds": "error";
+                "toml/precision-of-integer": "error";
+                "toml/vue-custom-block/no-parsing-error": "error";
+            };
+        })[];
+        "flat/standard": ({
+            plugins: {
+                readonly toml: import("eslint").ESLint.Plugin;
+            };
+            files?: undefined;
+            languageOptions?: undefined;
+            rules?: undefined;
+        } | {
+            files: string[];
+            languageOptions: {
+                parser: typeof import("toml-eslint-parser");
+            };
+            rules: {
+                "no-irregular-whitespace": "off";
+                "spaced-comment": "off";
+            };
+            plugins?: undefined;
+        } | {
+            rules: {
+                "toml/array-bracket-newline": "error";
+                "toml/array-bracket-spacing": "error";
+                "toml/array-element-newline": "error";
+                "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";
+                "toml/padding-line-between-pairs": "error";
+                "toml/padding-line-between-tables": "error";
+                "toml/precision-of-fractional-seconds": "error";
+                "toml/precision-of-integer": "error";
+                "toml/quoted-keys": "error";
+                "toml/spaced-comment": "error";
+                "toml/table-bracket-spacing": "error";
+                "toml/tables-order": "error";
+                "toml/vue-custom-block/no-parsing-error": "error";
+            };
+        })[];
     };
     rules: {
         [key: string]: RuleModule;

package/lib/index.js

@@ -29,11 +29,17 @@ const rules_1 = require("./utils/rules");
 const base_1 = __importDefault(require("./configs/base"));
 const recommended_1 = __importDefault(require("./configs/recommended"));
 const standard_1 = __importDefault(require("./configs/standard"));
+const base_2 = __importDefault(require("./configs/flat/base"));
+const recommended_2 = __importDefault(require("./configs/flat/recommended"));
+const standard_2 = __importDefault(require("./configs/flat/standard"));
 const meta = __importStar(require("./meta"));
 const configs = {
     base: base_1.default,
     recommended: recommended_1.default,
     standard: standard_1.default,
+    "flat/base": base_2.default,
+    "flat/recommended": recommended_2.default,
+    "flat/standard": standard_2.default,
 };
 const rules = rules_1.rules.reduce((obj, r) => {
     obj[r.meta.docs.ruleName] = r;

package/lib/meta.d.ts

@@ -1,2 +1,2 @@
 export declare const name: "eslint-plugin-toml";
-export declare const version: "0.9.2";
+export declare const version: "0.11.0";

package/lib/meta.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = exports.name = void 0;
 exports.name = "eslint-plugin-toml";
-exports.version = "0.9.2";
+exports.version = "0.11.0";

package/lib/rules/indent.d.ts

@@ -1,6 +1,2 @@
-export declare function buildIndentUtility(optionValue?: number | "tab" | null): {
-    getIndentText: (offset: number) => string;
-    outdent: (indent: string) => string;
-};
 declare const _default: import("../types").RuleModule;
 export default _default;

package/lib/rules/indent.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildIndentUtility = void 0;
 const toml_eslint_parser_1 = require("toml-eslint-parser");
 const utils_1 = require("../utils");
 const ast_utils_1 = require("../utils/ast-utils");
@@ -18,7 +17,6 @@ function buildIndentUtility(optionValue) {
         },
     };
 }
-exports.buildIndentUtility = buildIndentUtility;
 exports.default = (0, utils_1.createRule)("indent", {
     meta: {
         docs: {

package/lib/rules/precision-of-integer.d.ts

@@ -1,10 +1,2 @@
-type MaxValues = {
-    "+": string;
-    "-": string;
-    "0x": string;
-    "0o": string;
-    "0b": string;
-};
-export declare function maxBitToMaxValues(maxBit: number): MaxValues;
 declare const _default: import("../types").RuleModule;
 export default _default;

package/lib/rules/precision-of-integer.js

@@ -1,55 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.maxBitToMaxValues = void 0;
 const utils_1 = require("../utils");
 const compat_1 = require("../utils/compat");
+const bit_1 = require("../utils/bit");
 const cacheMaxValues = {};
-function maxBitToMaxValues(maxBit) {
-    const binaryMax = [];
-    const minusMax = [0];
-    const plusMax = [0];
-    const hexMax = [0];
-    const octalMax = [0];
-    for (let index = 0; index < maxBit; index++) {
-        const binaryNum = index === 0 ? 1 : 0;
-        binaryMax.push(binaryNum);
-        processDigits(minusMax, binaryNum, 10);
-        processDigits(hexMax, binaryNum, 16);
-        processDigits(octalMax, binaryNum, 8);
-        if (index > 0) {
-            processDigits(plusMax, 1, 10);
-        }
-    }
-    return {
-        "+": plusMax.reverse().join(""),
-        "-": minusMax.reverse().join(""),
-        "0x": hexMax
-            .map((i) => i.toString(16))
-            .reverse()
-            .join("")
-            .toLowerCase(),
-        "0o": octalMax.reverse().join(""),
-        "0b": binaryMax.join(""),
-    };
-    function processDigits(digits, binaryNum, radix) {
-        let num = binaryNum;
-        for (let place = 0; place < digits.length; place++) {
-            num = digits[place] * 2 + num;
-            digits[place] = num % radix;
-            num = Math.floor(num / radix);
-        }
-        while (num > 0) {
-            digits.push(num % radix);
-            num = Math.floor(num / radix);
-        }
-    }
-}
-exports.maxBitToMaxValues = maxBitToMaxValues;
 function getMaxValues(bit) {
     if (cacheMaxValues[bit]) {
         return cacheMaxValues[bit];
     }
-    return (cacheMaxValues[bit] = maxBitToMaxValues(bit));
+    return (cacheMaxValues[bit] = (0, bit_1.maxBitToMaxValues)(bit));
 }
 exports.default = (0, utils_1.createRule)("precision-of-integer", {
     meta: {

package/lib/utils/bit.d.ts

@@ -0,0 +1,8 @@
+export type MaxValues = {
+    "+": string;
+    "-": string;
+    "0x": string;
+    "0o": string;
+    "0b": string;
+};
+export declare function maxBitToMaxValues(maxBit: number): MaxValues;

package/lib/utils/bit.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maxBitToMaxValues = void 0;
+function maxBitToMaxValues(maxBit) {
+    const binaryMax = [];
+    const minusMax = [0];
+    const plusMax = [0];
+    const hexMax = [0];
+    const octalMax = [0];
+    for (let index = 0; index < maxBit; index++) {
+        const binaryNum = index === 0 ? 1 : 0;
+        binaryMax.push(binaryNum);
+        processDigits(minusMax, binaryNum, 10);
+        processDigits(hexMax, binaryNum, 16);
+        processDigits(octalMax, binaryNum, 8);
+        if (index > 0) {
+            processDigits(plusMax, 1, 10);
+        }
+    }
+    return {
+        "+": plusMax.reverse().join(""),
+        "-": minusMax.reverse().join(""),
+        "0x": hexMax
+            .map((i) => i.toString(16))
+            .reverse()
+            .join("")
+            .toLowerCase(),
+        "0o": octalMax.reverse().join(""),
+        "0b": binaryMax.join(""),
+    };
+    function processDigits(digits, binaryNum, radix) {
+        let num = binaryNum;
+        for (let place = 0; place < digits.length; place++) {
+            num = digits[place] * 2 + num;
+            digits[place] = num % radix;
+            num = Math.floor(num / radix);
+        }
+        while (num > 0) {
+            digits.push(num % radix);
+            num = Math.floor(num / radix);
+        }
+    }
+}
+exports.maxBitToMaxValues = maxBitToMaxValues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-toml",
-  "version": "0.9.2",
+  "version": "0.11.0",
   "description": "This ESLint plugin provides linting rules for TOML.",
   "main": "lib/index.js",
   "files": [
@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "debug": "^4.1.1",
-    "eslint-compat-utils": "^0.4.0",
+    "eslint-compat-utils": "^0.5.0",
     "lodash": "^4.17.19",
     "toml-eslint-parser": "^0.9.0"
   },
@@ -69,7 +69,7 @@
     "@types/debug": "^4.1.5",
     "@types/eslint": "^8.0.0",
     "@types/eslint-scope": "^3.7.0",
-    "@types/eslint-visitor-keys": "^1.0.0",
+    "@types/eslint-visitor-keys": "^3.0.0",
     "@types/estree": "^1.0.0",
     "@types/lodash": "^4.14.158",
     "@types/mocha": "^10.0.0",
@@ -79,20 +79,21 @@
     "@typescript-eslint/parser": "^6.19.0",
     "cross-env": "^7.0.2",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.19.3",
+    "esbuild": "^0.20.0",
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",
-    "eslint-plugin-json-schema-validator": "^4.6.1",
+    "eslint-plugin-json-schema-validator": "^5.0.0",
     "eslint-plugin-jsonc": "^2.0.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-regexp": "^2.0.0",
+    "eslint-plugin-toml": "^0.10.0",
     "eslint-plugin-vue": "^9.0.0",
     "eslint-plugin-yml": "^1.0.0",
-    "espree": "^9.0.0",
+    "espree": "^10.0.0",
     "events": "^3.3.0",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",