eslint-plugin-yml 1.6.0 → 1.8.0

package/lib/index.d.ts

@@ -1,5 +1,7 @@
 import type { RuleModule } from "./types";
+import * as meta from "./meta";
 declare const _default: {
+    meta: typeof meta;
     configs: {
         base: {
             plugins: string[];

package/lib/index.js

@@ -1,4 +1,27 @@
 "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;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,6 +30,7 @@ const base_1 = __importDefault(require("./configs/base"));
 const recommended_1 = __importDefault(require("./configs/recommended"));
 const standard_1 = __importDefault(require("./configs/standard"));
 const prettier_1 = __importDefault(require("./configs/prettier"));
+const meta = __importStar(require("./meta"));
 const configs = {
     base: base_1.default,
     recommended: recommended_1.default,
@@ -18,6 +42,7 @@ const rules = rules_1.rules.reduce((obj, r) => {
     return obj;
 }, {});
 module.exports = {
+    meta,
     configs,
     rules,
 };

package/lib/meta.d.ts

@@ -0,0 +1,2 @@
+export declare const name: "eslint-plugin-yml";
+export declare const version: "1.8.0";

package/lib/meta.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = exports.name = void 0;
+exports.name = "eslint-plugin-yml";
+exports.version = "1.8.0";

package/lib/rules/plain-scalar.js

@@ -1,4 +1,8 @@
 "use strict";
+var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cooked, raw) {
+    if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
+    return cooked;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const yaml_eslint_parser_1 = require("yaml-eslint-parser");
 const utils_1 = require("../utils");
@@ -61,7 +65,7 @@ exports.default = (0, utils_1.createRule)("plain-scalar", {
         const option = context.options[0] || "always";
         const ignorePatterns = toRegExps((_b = (_a = context.options[1]) === null || _a === void 0 ? void 0 : _a.ignorePatterns) !== null && _b !== void 0 ? _b : (option === "always"
             ? [
-                String.raw `[\v\f\u0085\u00a0\u1680\u180e\u2000-\u200b\u2028\u2029\u202f\u205f\u3000\ufeff]`,
+                String.raw(templateObject_1 || (templateObject_1 = __makeTemplateObject(["[\v\f\u0085\u00A0\u1680\u180E\u2000-\u200B\u2028\u2029\u202F\u205F\u3000\uFEFF]"], ["[\\v\\f\\u0085\\u00a0\\u1680\\u180e\\u2000-\\u200b\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]"]))),
             ]
             : []));
         const sourceCode = context.getSourceCode();
@@ -166,3 +170,4 @@ exports.default = (0, utils_1.createRule)("plain-scalar", {
         };
     },
 });
+var templateObject_1;

package/lib/rules/sort-keys.js

@@ -39,6 +39,10 @@ class YAMLPairData {
         var _a;
         return ((_a = this.cachedName) !== null && _a !== void 0 ? _a : (this.cachedName = getPropertyName(this.node, this.mapping.sourceCode)));
     }
+    getPrev() {
+        const prevIndex = this.index - 1;
+        return prevIndex >= 0 ? this.mapping.pairs[prevIndex] : null;
+    }
 }
 class YAMLMappingData {
     constructor(node, sourceCode, anchorAliasMap) {
@@ -51,6 +55,32 @@ class YAMLMappingData {
         var _a;
         return ((_a = this.cachedProperties) !== null && _a !== void 0 ? _a : (this.cachedProperties = this.node.pairs.map((e, index) => new YAMLPairData(this, e, index, this.anchorAliasMap.get(e)))));
     }
+    getPath(sourceCode) {
+        let path = "";
+        let curr = this.node;
+        let p = curr.parent;
+        while (p) {
+            if (p.type === "YAMLPair") {
+                const name = getPropertyName(p, sourceCode);
+                if (/^[$_a-z][\w$]*$/iu.test(name)) {
+                    path = `.${name}${path}`;
+                }
+                else {
+                    path = `[${JSON.stringify(name)}]${path}`;
+                }
+            }
+            else if (p.type === "YAMLSequence") {
+                const index = p.entries.indexOf(curr);
+                path = `[${index}]${path}`;
+            }
+            curr = p;
+            p = curr.parent;
+        }
+        if (path.startsWith(".")) {
+            path = path.slice(1);
+        }
+        return path;
+    }
 }
 function isCompatibleWithESLintOptions(options) {
     if (options.length === 0) {
@@ -83,12 +113,14 @@ function parseOptions(options, sourceCode) {
         const insensitive = obj.caseSensitive === false;
         const natural = Boolean(obj.natural);
         const minKeys = (_c = obj.minKeys) !== null && _c !== void 0 ? _c : 2;
+        const allowLineSeparatedGroups = obj.allowLineSeparatedGroups || false;
         return [
             {
                 isTargetMapping: (data) => data.node.pairs.length >= minKeys,
                 ignore: () => false,
                 isValidOrder: buildValidatorFromType(type, insensitive, natural),
                 orderText: `${natural ? "natural " : ""}${insensitive ? "insensitive " : ""}${type}ending`,
+                allowLineSeparatedGroups,
             },
         ];
     }
@@ -98,6 +130,7 @@ function parseOptions(options, sourceCode) {
         const pathPattern = new RegExp(opt.pathPattern);
         const hasProperties = (_a = opt.hasProperties) !== null && _a !== void 0 ? _a : [];
         const minKeys = (_b = opt.minKeys) !== null && _b !== void 0 ? _b : 2;
+        const allowLineSeparatedGroups = opt.allowLineSeparatedGroups || false;
         if (!Array.isArray(order)) {
             const type = (_c = order.type) !== null && _c !== void 0 ? _c : "asc";
             const insensitive = order.caseSensitive === false;
@@ -107,6 +140,7 @@ function parseOptions(options, sourceCode) {
                 ignore: () => false,
                 isValidOrder: buildValidatorFromType(type, insensitive, natural),
                 orderText: `${natural ? "natural " : ""}${insensitive ? "insensitive " : ""}${type}ending`,
+                allowLineSeparatedGroups,
             };
         }
         const parsedOrder = [];
@@ -150,6 +184,7 @@ function parseOptions(options, sourceCode) {
                 return false;
             },
             orderText: "specified",
+            allowLineSeparatedGroups,
         };
         function isTargetMapping(data) {
             if (data.node.pairs.length < minKeys) {
@@ -161,30 +196,7 @@ function parseOptions(options, sourceCode) {
                     return false;
                 }
             }
-            let path = "";
-            let curr = data.node;
-            let p = curr.parent;
-            while (p) {
-                if (p.type === "YAMLPair") {
-                    const name = getPropertyName(p, sourceCode);
-                    if (/^[$_a-z][\w$]*$/iu.test(name)) {
-                        path = `.${name}${path}`;
-                    }
-                    else {
-                        path = `[${JSON.stringify(name)}]${path}`;
-                    }
-                }
-                else if (p.type === "YAMLSequence") {
-                    const index = p.entries.indexOf(curr);
-                    path = `[${index}]${path}`;
-                }
-                curr = p;
-                p = curr.parent;
-            }
-            if (path.startsWith(".")) {
-                path = path.slice(1);
-            }
-            return pathPattern.test(path);
+            return pathPattern.test(data.getPath(sourceCode));
         }
     });
 }
@@ -253,6 +265,9 @@ exports.default = (0, utils_1.createRule)("sort-keys", {
                                 type: "integer",
                                 minimum: 2,
                             },
+                            allowLineSeparatedGroups: {
+                                type: "boolean",
+                            },
                         },
                         required: ["pathPattern", "order"],
                         additionalProperties: false,
@@ -278,6 +293,9 @@ exports.default = (0, utils_1.createRule)("sort-keys", {
                                     type: "integer",
                                     minimum: 2,
                                 },
+                                allowLineSeparatedGroups: {
+                                    type: "boolean",
+                                },
                             },
                             additionalProperties: false,
                         },
@@ -323,10 +341,20 @@ exports.default = (0, utils_1.createRule)("sort-keys", {
             if (ignore(data, option)) {
                 return;
             }
-            const prevList = data.mapping.pairs
-                .slice(0, data.index)
-                .reverse()
-                .filter((d) => !ignore(d, option));
+            const prevList = [];
+            let currTarget = data;
+            let prevTarget;
+            while ((prevTarget = currTarget.getPrev())) {
+                if (option.allowLineSeparatedGroups) {
+                    if (hasBlankLine(prevTarget, currTarget)) {
+                        break;
+                    }
+                }
+                if (!ignore(prevTarget, option)) {
+                    prevList.push(prevTarget);
+                }
+                currTarget = prevTarget;
+            }
             if (prevList.length === 0) {
                 return;
             }
@@ -360,6 +388,23 @@ exports.default = (0, utils_1.createRule)("sort-keys", {
                 });
             }
         }
+        function hasBlankLine(prev, next) {
+            const tokenOrNodes = [
+                ...sourceCode.getTokensBetween(prev.node, next.node, {
+                    includeComments: true,
+                }),
+                next.node,
+            ];
+            let prevLoc = prev.node.loc;
+            for (const t of tokenOrNodes) {
+                const loc = t.loc;
+                if (loc.start.line - prevLoc.end.line > 1) {
+                    return true;
+                }
+                prevLoc = loc;
+            }
+            return false;
+        }
         let pairStack = {
             upper: null,
             anchors: new Set(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-yml",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "This ESLint plugin provides linting rules for YAML.",
   "main": "lib/index.js",
   "files": [
@@ -11,7 +11,8 @@
   },
   "scripts": {
     "prebuild": "npm run -s clean",
-    "build": "npm run build:ts",
+    "build": "npm run build:meta && npm run build:ts",
+    "build:meta": "npm run ts -- ./tools/update-meta.ts",
     "build:ts": "tsc --project ./tsconfig.build.json",
     "clean": "rimraf .nyc_output dist coverage",
     "lint": "eslint . --ext .js,.vue,.ts,.json,.md,.yml,.yaml",
@@ -81,7 +82,7 @@
     "@typescript-eslint/parser": "^5.0.0",
     "cross-env": "^7.0.2",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.17.0",
+    "esbuild": "^0.18.0",
     "esbuild-register": "^3.2.0",
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^8.0.0",
@@ -91,7 +92,7 @@
     "eslint-plugin-jsonc": "^2.0.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-node-dependencies": "^0.10.0",
+    "eslint-plugin-node-dependencies": "^0.11.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-regexp": "^1.0.0",
     "eslint-plugin-vue": "^9.0.0",
@@ -99,7 +100,7 @@
     "eslint4b": "^7.3.1",
     "espree": "^9.0.0",
     "mocha": "^10.0.0",
-    "monaco-editor": "^0.38.0",
+    "monaco-editor": "^0.39.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "raw-loader": "^4.0.1",
@@ -108,7 +109,7 @@
     "stylelint-config-recommended-vue": "^1.0.0",
     "stylelint-config-standard": "^33.0.0",
     "stylelint-stylus": "^0.18.0",
-    "typescript": "~5.0.0",
+    "typescript": "~5.1.0",
     "vue-eslint-editor": "^1.1.0",
     "vue-eslint-parser": "^9.0.0",
     "vuepress": "^1.5.2",