eslint-plugin-yml 1.19.1 → 2.0.1

package/README.md

@@ -53,8 +53,8 @@ npm install --save-dev eslint eslint-plugin-yml
 
 > **Requirements**
 >
-> - ESLint v6.0.0 and above
-> - Node.js v14.17.x, v16.x and above
+> - ESLint v9.38.0 and above
+> - Node.js v20.19.0 or higher (in the 20.x line), v22.13.0 or higher (in the 22.x line), or v24.0.0 and above
 
 <!--DOCS_IGNORE_END-->
 
@@ -65,8 +65,6 @@ npm install --save-dev eslint eslint-plugin-yml
 
 ### Configuration
 
-#### 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**:
@@ -76,7 +74,7 @@ import eslintPluginYml from 'eslint-plugin-yml';
 export default [
   // add more generic rule sets here, such as:
   // js.configs.recommended,
-  ...eslintPluginYml.configs['flat/recommended'],
+  ...eslintPluginYml.configs.recommended,
   {
     rules: {
       // override/add rules settings here, such as:
@@ -88,41 +86,14 @@ export default [
 
 This plugin provides configs:
 
-- `*.configs['flat/base']` ... Configuration to enable correct YAML 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.
-- `*.configs['flat/prettier']` ... Turn off rules that may conflict with [Prettier](https://prettier.io/).
+- `*.configs.base` ... Configuration to enable correct YAML parsing.
+- `*.configs.recommended` ... Above, plus rules to prevent errors or unintended behavior.
+- `*.configs.standard` ... Above, plus rules to enforce the common stylistic conventions.
+- `*.configs.prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/).
 
 See [the rule list](https://ota-meshi.github.io/eslint-plugin-yml/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**:
-
-```js
-module.exports = {
-  extends: [
-    // add more generic rulesets here, such as:
-    // 'eslint:recommended',
-    "plugin:yml/standard",
-  ],
-  rules: {
-    // override/add rules settings here, such as:
-    // 'yml/rule-name': 'error'
-  },
-};
-```
-
-This plugin provides configs:
-
-- `plugin:yml/base` ... Configuration to enable correct YAML parsing.
-- `plugin:yml/recommended` ... Above, plus rules to prevent errors or unintended behavior.
-- `plugin:yml/standard` ... Above, plus rules to enforce the common stylistic conventions.
-- `plugin:yml/prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/).
-
-See [the rule list](https://ota-meshi.github.io/eslint-plugin-yml/rules/) to get the `rules` that this plugin provides.
+**Note:** The `*.configs['flat/*']` configs are still available for backward compatibility, but it is recommended to use the new config names without the `flat/` prefix.
 
 #### Parser Configuration
 
@@ -131,20 +102,19 @@ If you have specified a parser, you need to configure a parser for `.yaml`.
 For example, if you are using the `"@babel/eslint-parser"`, configure it as follows:
 
 ```js
-module.exports = {
-  // ...
-  extends: ["plugin:yml/standard"],
-  // ...
-  parser: "@babel/eslint-parser",
-  // Add an `overrides` section to add a parser configuration for YAML.
-  overrides: [
-    {
-      files: ["*.yaml", "*.yml"],
-      parser: "yaml-eslint-parser",
+import eslintPluginYml from 'eslint-plugin-yml';
+import babelParser from '@babel/eslint-parser';
+
+export default [
+  ...eslintPluginYml.configs.standard,
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      parser: babelParser,
     },
-  ],
-  // ...
-};
+  },
+  // YAML files are already configured by the plugin
+];
 ```
 
 #### Parser Options
@@ -152,35 +122,59 @@ module.exports = {
 The following parser options for `yaml-eslint-parser` are available by specifying them in [parserOptions](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options) in the ESLint configuration file.
 
 ```js
-module.exports = {
-  // ...
-  overrides: [
-    {
-      files: ["*.yaml", "*.yml"],
-      parser: "yaml-eslint-parser",
-      // Options used with yaml-eslint-parser.
+import eslintPluginYml from 'eslint-plugin-yml';
+
+export default [
+  ...eslintPluginYml.configs.recommended,
+  {
+    files: ['**/*.yaml', '**/*.yml'],
+    languageOptions: {
       parserOptions: {
-        defaultYAMLVersion: "1.2",
+        defaultYAMLVersion: '1.2',
       },
     },
-  ],
-  // ...
-};
+  },
+];
 ```
 
 See also [https://github.com/ota-meshi/yaml-eslint-parser#readme](https://github.com/ota-meshi/yaml-eslint-parser#readme).
 
 ### Running ESLint from the command line
 
-If you want to run `eslint` from the command line, make sure you include the `.yaml` 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.
+With ESLint v9 and flat config, ESLint automatically lints all files matched by your config. You typically don't need the `--ext` option anymore.
 
 Examples:
 
 ```bash
-eslint --ext .js,.yaml,.yml src
+eslint .
 eslint "src/**/*.{js,yaml,yml}"
 ```
 
+#### Languages
+
+This plugin provides the following language identifiers for use in ESLint configurations:
+
+- `yml/yaml` ... YAML files
+
+For example, to apply settings specifically to YAML files, you can use the `language` field in your ESLint configuration:
+
+```js
+import eslintPluginYml from 'eslint-plugin-yml';
+export default [
+  {
+    files: ["*.yaml", "*.yml", "**/*.yaml", "**/*.yml"],
+    plugins: {
+      yml: eslintPluginYml,
+    },
+    language: "yml/yaml",
+  }
+]
+```
+
+The configuration above is included in the shareable configs provided by this plugin, so using `configs` is generally recommended.
+
+See also <https://eslint.org/docs/latest/use/configure/plugins#specify-a-language>
+
 ## :computer: Editor Integrations
 
 ### Visual Studio Code
@@ -231,7 +225,7 @@ The rules with the following star :star: are included in the config.
 
 | Rule ID | Description | Fixable | RECOMMENDED | STANDARD |
 |:--------|:------------|:-------:|:-----------:|:--------:|
-| [yml/block-mapping-colon-indicator-newline](https://ota-meshi.github.io/eslint-plugin-yml/rules/block-mapping-colon-indicator-newline.html) | enforce consistent line breaks after `:` indicator | :wrench: |  |  |
+| [yml/block-mapping-colon-indicator-newline](https://ota-meshi.github.io/eslint-plugin-yml/rules/block-mapping-colon-indicator-newline.html) | enforce consistent line breaks after `:` indicator | :wrench: |  | :star: |
 | [yml/block-mapping-question-indicator-newline](https://ota-meshi.github.io/eslint-plugin-yml/rules/block-mapping-question-indicator-newline.html) | enforce consistent line breaks after `?` indicator | :wrench: |  | :star: |
 | [yml/block-mapping](https://ota-meshi.github.io/eslint-plugin-yml/rules/block-mapping.html) | require or disallow block style mappings. | :wrench: |  | :star: |
 | [yml/block-sequence-hyphen-indicator-newline](https://ota-meshi.github.io/eslint-plugin-yml/rules/block-sequence-hyphen-indicator-newline.html) | enforce consistent line breaks after `-` indicator | :wrench: |  | :star: |
@@ -244,7 +238,7 @@ The rules with the following star :star: are included in the config.
 | [yml/no-empty-mapping-value](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-empty-mapping-value.html) | disallow empty mapping values |  | :star: | :star: |
 | [yml/no-empty-sequence-entry](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-empty-sequence-entry.html) | disallow empty sequence entries |  | :star: | :star: |
 | [yml/no-tab-indent](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-tab-indent.html) | disallow tabs for indentation. |  | :star: | :star: |
-| [yml/no-trailing-zeros](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-trailing-zeros.html) | disallow trailing zeros for floats | :wrench: |  |  |
+| [yml/no-trailing-zeros](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-trailing-zeros.html) | disallow trailing zeros for floats | :wrench: |  | :star: |
 | [yml/plain-scalar](https://ota-meshi.github.io/eslint-plugin-yml/rules/plain-scalar.html) | require or disallow plain style scalar. | :wrench: |  | :star: |
 | [yml/quotes](https://ota-meshi.github.io/eslint-plugin-yml/rules/quotes.html) | enforce the consistent use of either double, or single quotes | :wrench: |  | :star: |
 | [yml/require-string-key](https://ota-meshi.github.io/eslint-plugin-yml/rules/require-string-key.html) | disallow mapping keys other than strings |  |  |  |
@@ -262,7 +256,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/no-multiple-empty-lines](https://ota-meshi.github.io/eslint-plugin-yml/rules/no-multiple-empty-lines.html) | disallow multiple empty lines | :wrench: |  | :star: |
 | [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: |
 
 <!--RULES_TABLE_END-->

package/lib/chunk-15K8U1wQ.mjs

@@ -0,0 +1,18 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+export { __exportAll as t };

package/lib/index.d.mts

@@ -0,0 +1,217 @@
+import { AST } from "yaml-eslint-parser";
+import { IDirective, TextSourceCodeBase, TraversalStep } from "@eslint/plugin-kit";
+import * as _eslint_core0 from "@eslint/core";
+import { File, FileProblem, Language, OkParseResult, RuleDefinition, RulesConfig } from "@eslint/core";
+import { Linter, Scope } from "eslint";
+
+//#region src/meta.d.ts
+declare namespace meta_d_exports {
+  export { name, version };
+}
+declare const name: string;
+declare const version: string;
+//#endregion
+//#region src/language/token-store.d.ts
+type FilterPredicate = (tokenOrComment: YAMLToken) => boolean;
+type CursorWithSkipOptions = number | FilterPredicate | {
+  includeComments?: boolean;
+  filter?: FilterPredicate;
+  skip?: number;
+};
+type CursorWithCountOptions = number | FilterPredicate | {
+  includeComments?: boolean;
+  filter?: FilterPredicate;
+  count?: number;
+};
+//#endregion
+//#region src/language/yaml-source-code.d.ts
+/**
+ * YAML-specific syntax element type
+ */
+type YAMLSyntaxElement = AST.YAMLNode | AST.Token | AST.Comment;
+type YAMLToken = AST.Token | AST.Comment;
+/**
+ * YAML Source Code Object
+ */
+declare class YAMLSourceCode extends TextSourceCodeBase<{
+  LangOptions: Record<never, never>;
+  RootNode: AST.YAMLProgram;
+  SyntaxElementWithLoc: YAMLSyntaxElement;
+  ConfigNode: AST.Comment;
+}> {
+  #private;
+  readonly hasBOM: boolean;
+  readonly parserServices: {
+    isYAML?: boolean;
+    parseError?: unknown;
+  };
+  readonly visitorKeys: Record<string, string[]>;
+  private readonly tokenStore;
+  /**
+       * Creates a new instance.
+       */
+  constructor(config: {
+    text: string;
+    ast: AST.YAMLProgram;
+    hasBOM: boolean;
+    parserServices: {
+      isYAML: boolean;
+      parseError?: unknown;
+    };
+    visitorKeys?: Record<string, string[]> | null | undefined;
+  });
+  traverse(): Iterable<TraversalStep>;
+  /**
+       * Gets all tokens and comments.
+       */
+  get tokensAndComments(): YAMLToken[];
+  getLines(): string[];
+  getAllComments(): AST.Comment[];
+  /**
+       * Returns an array of all inline configuration nodes found in the source code.
+       * This includes eslint-disable, eslint-enable, eslint-disable-line,
+       * eslint-disable-next-line, and eslint (for inline config) comments.
+       */
+  getInlineConfigNodes(): AST.Comment[];
+  /**
+       * Returns directives that enable or disable rules along with any problems
+       * encountered while parsing the directives.
+       */
+  getDisableDirectives(): {
+    directives: IDirective[];
+    problems: FileProblem[];
+  };
+  /**
+       * Returns inline rule configurations along with any problems
+       * encountered while parsing the configurations.
+       */
+  applyInlineConfig(): {
+    configs: {
+      config: {
+        rules: RulesConfig;
+      };
+      loc: AST.SourceLocation;
+    }[];
+    problems: FileProblem[];
+  };
+  getNodeByRangeIndex(index: number): AST.YAMLNode | null;
+  getFirstToken(node: YAMLSyntaxElement): AST.Token;
+  getFirstToken(node: YAMLSyntaxElement, options?: CursorWithSkipOptions): YAMLToken | null;
+  getLastToken(node: YAMLSyntaxElement): AST.Token;
+  getLastToken(node: YAMLSyntaxElement, options?: CursorWithSkipOptions): YAMLToken | null;
+  getTokenBefore(node: YAMLSyntaxElement): AST.Token | null;
+  getTokenBefore(node: YAMLSyntaxElement, options?: CursorWithSkipOptions): YAMLToken | null;
+  getTokensBefore(node: YAMLSyntaxElement, options?: CursorWithCountOptions): YAMLToken[];
+  getTokenAfter(node: YAMLSyntaxElement): AST.Token | null;
+  getTokenAfter(node: YAMLSyntaxElement, options?: CursorWithSkipOptions): YAMLToken | null;
+  getFirstTokenBetween(left: YAMLSyntaxElement, right: YAMLSyntaxElement, options?: CursorWithSkipOptions): YAMLToken | null;
+  getTokensBetween(left: YAMLSyntaxElement, right: YAMLSyntaxElement, paddingOrOptions?: number | FilterPredicate | CursorWithCountOptions): YAMLToken[];
+  getTokens(node: AST.YAMLNode, options?: FilterPredicate | CursorWithCountOptions): YAMLToken[];
+  getCommentsBefore(nodeOrToken: YAMLSyntaxElement): AST.Comment[];
+  getCommentsAfter(nodeOrToken: YAMLSyntaxElement): AST.Comment[];
+  isSpaceBetween(first: YAMLToken, second: YAMLToken): boolean;
+  /**
+       * Compatibility for ESLint's SourceCode API
+       * @deprecated YAML does not have scopes
+       */
+  getScope(node?: AST.YAMLNode): Scope.Scope | null;
+  /**
+       * Compatibility for ESLint's SourceCode API
+       * @deprecated
+       */
+  isSpaceBetweenTokens(first: YAMLToken, second: YAMLToken): boolean;
+  private _getChildren;
+}
+//#endregion
+//#region src/language/yaml-language.d.ts
+/**
+ * Parse result
+ */
+interface YAMLParseResult {
+  ok: true;
+  ast: AST.YAMLProgram;
+}
+/**
+ * Language options for YAML
+ */
+type YAMLLanguageOptions = {
+  parserOptions?: {
+    defaultYAMLVersion?: "1.1" | "1.2";
+  };
+};
+/**
+ * The YAML language implementation for ESLint.
+ */
+declare class YAMLLanguage implements Language<{
+  LangOptions: YAMLLanguageOptions;
+  Code: YAMLSourceCode;
+  RootNode: AST.YAMLProgram;
+  Node: AST.YAMLNode;
+}> {
+  /**
+       * The type of file to read.
+       */
+  fileType: "text";
+  /**
+       * The line number at which the parser starts counting.
+       */
+  lineStart: 1;
+  /**
+       * The column number at which the parser starts counting.
+       */
+  columnStart: 0;
+  /**
+       * The name of the key that holds the type of the node.
+       */
+  nodeTypeKey: "type";
+  /**
+       * Validates the language options.
+       */
+  validateLanguageOptions(_languageOptions: YAMLLanguageOptions): void;
+  normalizeLanguageOptions(languageOptions: YAMLLanguageOptions): YAMLLanguageOptions;
+  /**
+       * Parses the given file into an AST.
+       */
+  parse(file: File, context: {
+    languageOptions?: YAMLLanguageOptions;
+  }): OkParseResult<AST.YAMLProgram> | YAMLParseResult;
+  /**
+       * Creates a new SourceCode object for the given file and parse result.
+       */
+  createSourceCode(file: File, parseResult: OkParseResult<AST.YAMLProgram> | YAMLParseResult): YAMLSourceCode;
+}
+//#endregion
+//#region src/index.d.ts
+declare const configs: {
+  base: Linter.Config[];
+  recommended: Linter.Config[];
+  standard: Linter.Config[];
+  prettier: Linter.Config[];
+  "flat/base": Linter.Config[];
+  "flat/recommended": Linter.Config[];
+  "flat/standard": Linter.Config[];
+  "flat/prettier": Linter.Config[];
+};
+declare const rules: Record<string, RuleDefinition>;
+declare const languages: {
+  yaml: YAMLLanguage;
+};
+declare const _default: {
+  meta: typeof meta_d_exports;
+  configs: {
+    base: Linter.Config[];
+    recommended: Linter.Config[];
+    standard: Linter.Config[];
+    prettier: Linter.Config[];
+    "flat/base": Linter.Config[];
+    "flat/recommended": Linter.Config[];
+    "flat/standard": Linter.Config[];
+    "flat/prettier": Linter.Config[];
+  };
+  rules: Record<string, RuleDefinition<_eslint_core0.RuleDefinitionTypeOptions>>;
+  languages: {
+    yaml: YAMLLanguage;
+  };
+};
+//#endregion
+export { type YAMLLanguageOptions, type YAMLSourceCode, configs, _default as default, languages, meta_d_exports as meta, rules };