eslint-plugin-yml 1.2.0 → 1.3.0

package/lib/rules/indent.js

@@ -6,6 +6,20 @@ const ast_utils_1 = require("../utils/ast-utils");
 const ITERATION_OPTS = Object.freeze({
     includeComments: true,
 });
+function parseOptions(context) {
+    const [indentOption, objectOptions] = context.options;
+    const numOfIndent = (0, yaml_1.getNumOfIndent)(context, indentOption);
+    let indentBlockSequences = true;
+    if (objectOptions) {
+        if (objectOptions.indentBlockSequences === false) {
+            indentBlockSequences = false;
+        }
+    }
+    return {
+        numOfIndent,
+        indentBlockSequences,
+    };
+}
 exports.default = (0, utils_1.createRule)("indent", {
     meta: {
         docs: {
@@ -20,6 +34,13 @@ exports.default = (0, utils_1.createRule)("indent", {
                 type: "integer",
                 minimum: 2,
             },
+            {
+                type: "object",
+                properties: {
+                    indentBlockSequences: { type: "boolean" },
+                },
+                additionalProperties: false,
+            },
         ],
         messages: {
             wrongIndentation: "Expected indentation of {{expected}} spaces but found {{actual}} spaces.",
@@ -33,7 +54,7 @@ exports.default = (0, utils_1.createRule)("indent", {
         if ((0, yaml_1.hasTabIndent)(context)) {
             return {};
         }
-        const numOfIndent = (0, yaml_1.getNumOfIndent)(context, context.options[0]);
+        const { numOfIndent, indentBlockSequences } = parseOptions(context);
         const sourceCode = context.getSourceCode();
         const offsets = new Map();
         const marks = new Set();
@@ -89,6 +110,15 @@ exports.default = (0, utils_1.createRule)("indent", {
                 setOffset(right, 0, left);
             }
         }
+        function calcMappingPairValueIndentOffset(node) {
+            if (indentBlockSequences || !node) {
+                return 1;
+            }
+            if (node.type === "YAMLSequence" && node.style === "block") {
+                return 0;
+            }
+            return 1;
+        }
         const documents = [];
         return {
             YAMLDocument(node) {
@@ -138,36 +168,14 @@ exports.default = (0, utils_1.createRule)("indent", {
             },
             YAMLPair(node) {
                 const pairFirst = sourceCode.getFirstToken(node);
-                let questionToken = null;
-                let keyToken = null;
-                let colonToken = null;
-                let valueToken = null;
-                if ((0, ast_utils_1.isQuestion)(pairFirst)) {
-                    questionToken = pairFirst;
+                const keyToken = node.key && sourceCode.getFirstToken(node.key);
+                const colonToken = findColonToken();
+                const valueToken = node.value && sourceCode.getFirstToken(node.value);
+                const questionToken = (0, ast_utils_1.isQuestion)(pairFirst) ? pairFirst : null;
+                if (questionToken) {
                     marks.add(questionToken);
-                }
-                if (node.value) {
-                    valueToken = sourceCode.getFirstToken(node.value);
-                    colonToken = sourceCode.getTokenBefore(node.value, ast_utils_1.isColon);
-                }
-                if (node.key) {
-                    keyToken = sourceCode.getFirstToken(node.key);
-                    if (!colonToken) {
-                        const token = sourceCode.getTokenAfter(node.key, ast_utils_1.isColon);
-                        if (token && token.range[0] < node.range[1]) {
-                            colonToken = token;
-                        }
-                    }
-                }
-                if (!colonToken) {
-                    const tokens = sourceCode.getTokens(node, ast_utils_1.isColon);
-                    if (tokens.length) {
-                        colonToken = tokens[0];
-                    }
-                }
-                if (keyToken) {
-                    if (questionToken) {
-                        setOffset(keyToken, 1, questionToken);
+                    if (keyToken) {
+                        setOffset(keyToken, calcMappingPairValueIndentOffset(node.key), questionToken);
                     }
                 }
                 if (colonToken) {
@@ -183,12 +191,28 @@ exports.default = (0, utils_1.createRule)("indent", {
                 }
                 if (valueToken) {
                     if (colonToken) {
-                        setOffset(valueToken, 1, colonToken);
+                        setOffset(valueToken, calcMappingPairValueIndentOffset(node.value), colonToken);
                     }
                     else if (keyToken) {
                         setOffset(valueToken, 1, keyToken);
                     }
                 }
+                function findColonToken() {
+                    if (node.value) {
+                        return sourceCode.getTokenBefore(node.value, ast_utils_1.isColon);
+                    }
+                    if (node.key) {
+                        const token = sourceCode.getTokenAfter(node.key, ast_utils_1.isColon);
+                        if (token && token.range[0] < node.range[1]) {
+                            return token;
+                        }
+                    }
+                    const tokens = sourceCode.getTokens(node, ast_utils_1.isColon);
+                    if (tokens.length) {
+                        return tokens[0];
+                    }
+                    return null;
+                }
             },
             YAMLWithMeta(node) {
                 const anchorToken = node.anchor && sourceCode.getFirstToken(node.anchor);

package/lib/rules/sort-keys.js

@@ -24,6 +24,10 @@ function getPropertyName(node, sourceCode) {
     return sourceCode.text.slice(...target.range);
 }
 class YAMLPairData {
+    get reportLoc() {
+        var _a, _b;
+        return (_b = (_a = this.node.key) === null || _a === void 0 ? void 0 : _a.loc) !== null && _b !== void 0 ? _b : this.node.loc;
+    }
     constructor(mapping, node, index, anchorAlias) {
         this.cachedName = null;
         this.mapping = mapping;
@@ -31,10 +35,6 @@ class YAMLPairData {
         this.index = index;
         this.anchorAlias = anchorAlias;
     }
-    get reportLoc() {
-        var _a, _b;
-        return (_b = (_a = this.node.key) === null || _a === void 0 ? void 0 : _a.loc) !== null && _b !== void 0 ? _b : this.node.loc;
-    }
     get name() {
         var _a;
         return ((_a = this.cachedName) !== null && _a !== void 0 ? _a : (this.cachedName = getPropertyName(this.node, this.mapping.sourceCode)));

package/lib/rules/sort-sequence-values.js

@@ -8,15 +8,6 @@ const utils_1 = require("../utils");
 const ast_utils_1 = require("../utils/ast-utils");
 const yaml_eslint_parser_1 = require("yaml-eslint-parser");
 class YAMLEntryData {
-    constructor(sequence, node, index, anchorAlias) {
-        this.cached = null;
-        this.cachedRange = null;
-        this.cachedAroundTokens = null;
-        this.sequence = sequence;
-        this.node = node;
-        this.index = index;
-        this.anchorAlias = anchorAlias;
-    }
     get reportLoc() {
         if (this.node) {
             return this.node.loc;
@@ -57,6 +48,15 @@ class YAMLEntryData {
         const after = sourceCode.getTokenAfter(before);
         return (this.cachedAroundTokens = { before, after });
     }
+    constructor(sequence, node, index, anchorAlias) {
+        this.cached = null;
+        this.cachedRange = null;
+        this.cachedAroundTokens = null;
+        this.sequence = sequence;
+        this.node = node;
+        this.index = index;
+        this.anchorAlias = anchorAlias;
+    }
     get value() {
         var _a;
         return ((_a = this.cached) !== null && _a !== void 0 ? _a : (this.cached = {

package/lib/types.d.ts

@@ -75,7 +75,7 @@ export interface PartialRuleMetaData {
     deprecated?: boolean;
     type: "problem" | "suggestion" | "layout";
 }
-export declare type YMLSettings = {
+export type YMLSettings = {
     indent?: number;
 };
 export interface RuleContext {
@@ -98,8 +98,8 @@ export interface RuleContext {
 export declare namespace SourceCode {
     function splitLines(text: string): string[];
 }
-export declare type YAMLToken = AST.Token | AST.Comment;
-export declare type YAMLNodeOrToken = AST.YAMLNode | YAMLToken;
+export type YAMLToken = AST.Token | AST.Comment;
+export type YAMLNodeOrToken = AST.YAMLNode | YAMLToken;
 export interface SourceCode {
     text: string;
     ast: AST.YAMLProgram;
@@ -149,13 +149,13 @@ export interface SourceCode {
     getCommentsAfter(nodeOrToken: YAMLNodeOrToken): AST.Comment[];
     getCommentsInside(node: AST.YAMLNode): AST.Comment[];
 }
-declare type FilterPredicate = (tokenOrComment: YAMLToken) => boolean;
-declare type CursorWithSkipOptions = number | FilterPredicate | {
+type FilterPredicate = (tokenOrComment: YAMLToken) => boolean;
+type CursorWithSkipOptions = number | FilterPredicate | {
     includeComments?: boolean;
     filter?: FilterPredicate;
     skip?: number;
 };
-declare type CursorWithCountOptions = number | FilterPredicate | {
+type CursorWithCountOptions = number | FilterPredicate | {
     includeComments?: boolean;
     filter?: FilterPredicate;
     count?: number;
@@ -166,22 +166,22 @@ interface ReportDescriptorOptionsBase {
     };
     fix?: null | ((fixer: RuleFixer) => null | Fix | IterableIterator<Fix> | Fix[]);
 }
-declare type SuggestionDescriptorMessage = {
+type SuggestionDescriptorMessage = {
     desc: string;
 } | {
     messageId: string;
 };
-declare type SuggestionReportDescriptor = SuggestionDescriptorMessage & ReportDescriptorOptionsBase;
+type SuggestionReportDescriptor = SuggestionDescriptorMessage & ReportDescriptorOptionsBase;
 interface ReportDescriptorOptions extends ReportDescriptorOptionsBase {
     suggest?: SuggestionReportDescriptor[] | null;
 }
-declare type ReportDescriptor = ReportDescriptorMessage & ReportDescriptorLocation & ReportDescriptorOptions;
-declare type ReportDescriptorMessage = {
+type ReportDescriptor = ReportDescriptorMessage & ReportDescriptorLocation & ReportDescriptorOptions;
+type ReportDescriptorMessage = {
     message: string;
 } | {
     messageId: string;
 };
-declare type ReportDescriptorLocation = {
+type ReportDescriptorLocation = {
     node: YAMLNodeOrToken;
 } | {
     loc: SourceLocation | {

package/lib/utils/casing.d.ts

@@ -1,4 +1,4 @@
-export declare type CasingKind = "camelCase" | "kebab-case" | "PascalCase" | "snake_case" | "SCREAMING_SNAKE_CASE";
+export type CasingKind = "camelCase" | "kebab-case" | "PascalCase" | "snake_case" | "SCREAMING_SNAKE_CASE";
 export declare const allowedCaseOptions: CasingKind[];
 export declare function kebabCase(str: string): string;
 export declare function isKebabCase(str: string): boolean;

package/lib/utils/index.d.ts

@@ -2,7 +2,7 @@ import type { RuleListener, RuleModule, PartialRuleModule, RuleContext } from ".
 import type { Rule } from "eslint";
 import type { AST } from "yaml-eslint-parser";
 export declare function createRule(ruleName: string, rule: PartialRuleModule): RuleModule;
-declare type CoreRuleListener = {
+type CoreRuleListener = {
     [key: string]: (node: any) => void;
 };
 export declare function defineWrapperListener(coreRule: Rule.RuleModule, context: RuleContext, proxyOptions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-yml",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "This ESLint plugin provides linting rules for YAML.",
   "main": "lib/index.js",
   "files": [
@@ -65,16 +65,16 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.2",
-    "@ota-meshi/eslint-plugin": "^0.12.0",
+    "@ota-meshi/eslint-plugin": "^0.13.0",
     "@types/debug": "^4.1.5",
     "@types/eslint": "^8.0.0",
     "@types/eslint-scope": "^3.7.0",
     "@types/eslint-visitor-keys": "^1.0.0",
     "@types/estree": "^1.0.0",
     "@types/lodash": "^4.14.158",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.0",
     "@types/natural-compare": "^1.4.0",
-    "@types/node": "^16.11.3",
+    "@types/node": "^18.0.0",
     "@types/semver": "^7.3.1",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
@@ -90,7 +90,7 @@
     "eslint-plugin-jsonc": "^2.0.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-node-dependencies": "^0.9.0",
+    "eslint-plugin-node-dependencies": "^0.10.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-regexp": "^1.0.0",
     "eslint-plugin-vue": "^9.0.0",
@@ -105,9 +105,9 @@
     "semver": "^7.3.2",
     "stylelint": "^14.9.1",
     "stylelint-config-recommended-vue": "^1.0.0",
-    "stylelint-config-standard": "^28.0.0",
+    "stylelint-config-standard": "^29.0.0",
     "stylelint-stylus": "^0.17.0",
-    "typescript": "~4.8.0",
+    "typescript": "~4.9.0",
     "vue-eslint-editor": "^1.1.0",
     "vue-eslint-parser": "^9.0.0",
     "vuepress": "^1.5.2",