eslint-plugin-yml 0.11.0 → 0.12.0

package/README.md

@@ -188,6 +188,7 @@ The rules with the following star :star: are included in the config.
 | [yml/flow-sequence-bracket-spacing](https://ota-meshi.github.io/eslint-plugin-yml/rules/flow-sequence-bracket-spacing.html) | enforce consistent spacing inside flow sequence brackets | :wrench: |  | :star: |
 | [yml/key-spacing](https://ota-meshi.github.io/eslint-plugin-yml/rules/key-spacing.html) | enforce consistent spacing between keys and values in mapping pairs | :wrench: |  | :star: |
 | [yml/no-irregular-whitespace](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-irregular-whitespace.html) | disallow irregular whitespace |  | :star: | :star: |
+| [yml/no-multiple-empty-lines](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-multiple-empty-lines.html) | disallow multiple empty lines | :wrench: |  |  |
 | [yml/sort-keys](https://ota-meshi.github.io/eslint-plugin-yml/rules/sort-keys.html) | require mapping keys to be sorted | :wrench: |  |  |
 | [yml/spaced-comment](https://ota-meshi.github.io/eslint-plugin-yml/rules/spaced-comment.html) | enforce consistent spacing after the `#` in a comment | :wrench: |  | :star: |
 

package/lib/configs/prettier.d.ts

@@ -9,6 +9,7 @@ declare const _default: {
         "yml/flow-sequence-bracket-spacing": string;
         "yml/indent": string;
         "yml/key-spacing": string;
+        "yml/no-multiple-empty-lines": string;
         "yml/quotes": string;
     };
 };

package/lib/configs/prettier.js

@@ -16,6 +16,7 @@ module.exports = {
         "yml/flow-sequence-bracket-spacing": "off",
         "yml/indent": "off",
         "yml/key-spacing": "off",
+        "yml/no-multiple-empty-lines": "off",
         "yml/quotes": "off",
     },
 };

package/lib/index.d.ts

@@ -60,6 +60,7 @@ declare const _default: {
                 "yml/flow-sequence-bracket-spacing": string;
                 "yml/indent": string;
                 "yml/key-spacing": string;
+                "yml/no-multiple-empty-lines": string;
                 "yml/quotes": string;
             };
         };

package/lib/rules/no-multiple-empty-lines.d.ts

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

package/lib/rules/no-multiple-empty-lines.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+exports.default = (0, utils_1.createRule)("no-multiple-empty-lines", {
+    meta: {
+        docs: {
+            description: "disallow multiple empty lines",
+            categories: null,
+            extensionRule: "no-multiple-empty-lines",
+            layout: true,
+        },
+        fixable: "whitespace",
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    max: {
+                        type: "integer",
+                        minimum: 0,
+                    },
+                    maxEOF: {
+                        type: "integer",
+                        minimum: 0,
+                    },
+                    maxBOF: {
+                        type: "integer",
+                        minimum: 0,
+                    },
+                },
+                required: ["max"],
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            blankBeginningOfFile: "Too many blank lines at the beginning of file. Max of {{max}} allowed.",
+            blankEndOfFile: "Too many blank lines at the end of file. Max of {{max}} allowed.",
+            consecutiveBlank: "More than {{max}} blank {{pluralizedLines}} not allowed.",
+        },
+        type: "layout",
+    },
+    create(context) {
+        var _a, _b, _c, _d, _e, _f;
+        if (!context.parserServices.isYAML) {
+            return {};
+        }
+        const maxOption = (_b = (_a = context.options[0]) === null || _a === void 0 ? void 0 : _a.max) !== null && _b !== void 0 ? _b : 2;
+        const options = {
+            max: maxOption,
+            maxEOF: (_d = (_c = context.options[0]) === null || _c === void 0 ? void 0 : _c.maxEOF) !== null && _d !== void 0 ? _d : maxOption,
+            maxBOF: (_f = (_e = context.options[0]) === null || _e === void 0 ? void 0 : _e.maxBOF) !== null && _f !== void 0 ? _f : maxOption,
+        };
+        const sourceCode = context.getSourceCode();
+        const allLines = [...sourceCode.lines];
+        if (allLines[allLines.length - 1] === "") {
+            allLines.pop();
+        }
+        const ignoreLineIndexes = new Set();
+        function verifyEmptyLines(startLineIndex, endLineIndex) {
+            const emptyLineCount = endLineIndex - startLineIndex;
+            let messageId, max;
+            if (startLineIndex === 0) {
+                messageId = "blankBeginningOfFile";
+                max = options.maxBOF;
+            }
+            else if (endLineIndex === allLines.length) {
+                messageId = "blankEndOfFile";
+                max = options.maxEOF;
+            }
+            else {
+                messageId = "consecutiveBlank";
+                max = options.max;
+            }
+            if (emptyLineCount > max) {
+                context.report({
+                    loc: {
+                        start: {
+                            line: startLineIndex + max + 1,
+                            column: 0,
+                        },
+                        end: { line: endLineIndex + 1, column: 0 },
+                    },
+                    messageId,
+                    data: {
+                        max: String(max),
+                        pluralizedLines: max === 1 ? "line" : "lines",
+                    },
+                    fix(fixer) {
+                        const rangeStart = sourceCode.getIndexFromLoc({
+                            line: startLineIndex + max + 1,
+                            column: 0,
+                        });
+                        const rangeEnd = endLineIndex < allLines.length
+                            ? sourceCode.getIndexFromLoc({
+                                line: endLineIndex + 1,
+                                column: 0,
+                            })
+                            : sourceCode.text.length;
+                        return fixer.removeRange([rangeStart, rangeEnd]);
+                    },
+                });
+            }
+        }
+        return {
+            YAMLScalar(node) {
+                for (let lineIndex = node.loc.start.line - 1; lineIndex < node.loc.end.line; lineIndex++) {
+                    ignoreLineIndexes.add(lineIndex);
+                }
+            },
+            "Program:exit"() {
+                let startEmptyLineIndex = null;
+                for (let lineIndex = 0; lineIndex < allLines.length; lineIndex++) {
+                    const line = allLines[lineIndex];
+                    const isEmptyLine = !line.trim() && !ignoreLineIndexes.has(lineIndex);
+                    if (isEmptyLine) {
+                        startEmptyLineIndex !== null && startEmptyLineIndex !== void 0 ? startEmptyLineIndex : (startEmptyLineIndex = lineIndex);
+                    }
+                    else {
+                        if (startEmptyLineIndex != null) {
+                            verifyEmptyLines(startEmptyLineIndex, lineIndex);
+                        }
+                        startEmptyLineIndex = null;
+                    }
+                }
+                if (startEmptyLineIndex != null) {
+                    verifyEmptyLines(startEmptyLineIndex, allLines.length);
+                }
+            },
+        };
+    },
+});

package/lib/utils/rules.js

@@ -20,6 +20,7 @@ const no_empty_key_1 = __importDefault(require("../rules/no-empty-key"));
 const no_empty_mapping_value_1 = __importDefault(require("../rules/no-empty-mapping-value"));
 const no_empty_sequence_entry_1 = __importDefault(require("../rules/no-empty-sequence-entry"));
 const no_irregular_whitespace_1 = __importDefault(require("../rules/no-irregular-whitespace"));
+const no_multiple_empty_lines_1 = __importDefault(require("../rules/no-multiple-empty-lines"));
 const no_tab_indent_1 = __importDefault(require("../rules/no-tab-indent"));
 const plain_scalar_1 = __importDefault(require("../rules/plain-scalar"));
 const quotes_1 = __importDefault(require("../rules/quotes"));
@@ -44,6 +45,7 @@ exports.rules = [
     no_empty_mapping_value_1.default,
     no_empty_sequence_entry_1.default,
     no_irregular_whitespace_1.default,
+    no_multiple_empty_lines_1.default,
     no_tab_indent_1.default,
     plain_scalar_1.default,
     quotes_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eslint-plugin-yml",
-    "version": "0.11.0",
+    "version": "0.12.0",
     "description": "This ESLint plugin provides linting rules for YAML.",
     "main": "lib/index.js",
     "files": [
@@ -59,7 +59,7 @@
     "devDependencies": {
         "@ota-meshi/eslint-plugin": "^0.10.0",
         "@types/debug": "^4.1.5",
-        "@types/eslint": "^7.2.0",
+        "@types/eslint": "^8.0.0",
         "@types/eslint-scope": "^3.7.0",
         "@types/eslint-visitor-keys": "^1.0.0",
         "@types/estree": "^0.0.50",
@@ -84,7 +84,7 @@
         "eslint-plugin-prettier": "^4.0.0",
         "eslint-plugin-regexp": "^1.0.0",
         "eslint-plugin-vue": "^8.0.0",
-        "eslint-plugin-yml": "^0.10.0",
+        "eslint-plugin-yml": "^0.11.0",
         "eslint4b": "^7.3.1",
         "espree": "^9.0.0",
         "mocha": "^9.0.0",
@@ -95,10 +95,10 @@
         "semver": "^7.3.2",
         "stylelint": "^14.0.0",
         "stylelint-config-recommended-vue": "^1.0.0",
-        "stylelint-config-standard": "^23.0.0",
+        "stylelint-config-standard": "^24.0.0",
         "stylelint-plugin-stylus": "^0.13.0",
         "ts-node": "^10.0.0",
-        "typescript": "~4.4.3",
+        "typescript": "~4.5.0",
         "vue-eslint-editor": "^1.1.0",
         "vue-eslint-parser": "^8.0.0",
         "vuepress": "^1.5.2"