expiring-todo-comments: Add YAML support (#3625)

Author: sindresorhus

AGENTS.md

@@ -100,8 +100,9 @@ Available identifiers:
 - `json/json`, `json/jsonc`, `json/json5` — [`@eslint/json`](https://github.com/eslint/json)
 - `markdown/commonmark`, `markdown/gfm` — [`@eslint/markdown`](https://github.com/eslint/markdown)
 - `html/html` — [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint)
+- `yml/yaml` — [`eslint-plugin-yml`](https://github.com/ota-meshi/eslint-plugin-yml)
 
-Most rules visit JavaScript AST nodes, so `js/js` is all they can support. But when a rule's logic is language-agnostic (filename, raw text, comments, or disable directives), support as many languages as is feasible. Root node types differ per language (`Program` for JS/TS and HTML, `StyleSheet` for CSS, `Document` for JSON, `root` for Markdown), so use `onRoot(context, listener)` to run on every root and `getComments(context)` for cross-language comments (both from `rules/utils/`). For reference, see `prefer-https` (`['*']`, raw-text scan) and `no-empty-file` (per-language root handlers).
+Most rules visit JavaScript AST nodes, so `js/js` is all they can support. But when a rule's logic is language-agnostic (filename, raw text, comments, or disable directives), support as many languages as is feasible. Root node types differ per language (`Program` for JS/TS, HTML, and YAML, `StyleSheet` for CSS, `Document` for JSON, `root` for Markdown), so use `onRoot(context, listener)` to run on every root and `getComments(context)` for cross-language comments (both from `rules/utils/`). For reference, see `prefer-https` (`['*']`, raw-text scan) and `no-empty-file` (per-language root handlers).
 
 ## Reusable utilities
 

docs/rules/expiring-todo-comments.md

@@ -19,7 +19,7 @@ With this rule, a TODO can have a condition right from the beginning to define i
 
 This rule will ignore all TODOs without conditions. For more information, read the below [`eslint/no-warning-comments`](#disallow-warning-comments-no-warning-comments) section.
 
-This rule also supports CSS comments when linting CSS files with [`@eslint/css`](https://github.com/eslint/css), HTML comments when linting HTML files with [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint), line comments in JSONC/JSON5 files when linting with [`@eslint/json`](https://github.com/eslint/json), and HTML comments in Markdown files when linting with [`@eslint/markdown`](https://github.com/eslint/markdown).
+This rule also supports CSS comments when linting CSS files with [`@eslint/css`](https://github.com/eslint/css), HTML comments when linting HTML files with [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint), line comments in JSONC/JSON5 files when linting with [`@eslint/json`](https://github.com/eslint/json), HTML comments in Markdown files when linting with [`@eslint/markdown`](https://github.com/eslint/markdown), and comments in YAML files when linting with [`eslint-plugin-yml`](https://github.com/ota-meshi/eslint-plugin-yml).
 
 Quick overview of conditions:
 
@@ -208,6 +208,15 @@ When used with [`@eslint/markdown`](https://github.com/eslint/markdown), this ru
 # Heading
 ```
 
+### YAML
+
+When used with [`eslint-plugin-yml`](https://github.com/ota-meshi/eslint-plugin-yml), this rule can check comments in YAML files too.
+
+```yaml
+# TODO [2019-11-15]: Update this configuration.
+key: value
+```
+
 ## Disallow Warning Comments (no-warning-comments)
 
 This rule implements [`eslint/no-warning-comments`](https://eslint.org/docs/rules/no-warning-comments).
@@ -249,7 +258,7 @@ Imagine you maintain a `main` branch at a version such as 10 and always keep wor
 - TODOs may or may not have a colon before the message such as
   `TODO [...]: message` or `TODO [...] message`.
 - If no proper argument is found, you'll be notified that the TODO is useless (See [`eslint/no-warning-comments`](#disallow-warning-comments-no-warning-comments)).
-- CSS, HTML, JSONC, JSON5, and Markdown comments are supported when using [`@eslint/css`](https://github.com/eslint/css), [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint), [`@eslint/json`](https://github.com/eslint/json), and [`@eslint/markdown`](https://github.com/eslint/markdown).
+- CSS, HTML, JSONC, JSON5, Markdown, and YAML comments are supported when using [`@eslint/css`](https://github.com/eslint/css), [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint), [`@eslint/json`](https://github.com/eslint/json), [`@eslint/markdown`](https://github.com/eslint/markdown), and [`eslint-plugin-yml`](https://github.com/ota-meshi/eslint-plugin-yml).
 
 ## Examples
 

package.json

@@ -104,6 +104,7 @@
 		"eslint-plugin-eslint-plugin": "^7.4.1",
 		"eslint-plugin-jsdoc": "^63.0.11",
 		"eslint-plugin-unicorn": "^70.0.0",
+		"eslint-plugin-yml": "^3.8.1",
 		"eslint-remote-tester": "^4.0.4",
 		"eslint-remote-tester-repositories": "^2.0.2",
 		"eslint-scope": "^9.1.2",

readme.md

@@ -5,7 +5,7 @@
 
 > More than 300 powerful ESLint rules
 
-Most rules target JavaScript and TypeScript, but [some also lint CSS, HTML, JSON, and Markdown](#non-javascript-files) when used with the matching ESLint language plugin.
+Most rules target JavaScript and TypeScript, but [some also lint CSS, HTML, JSON, Markdown, and YAML](#non-javascript-files) when used with the matching ESLint language plugin.
 
 [**Propose a new rule ➡**](.github/contributing.md)
 
@@ -434,7 +434,7 @@ export default defineConfig([
 
 ### Non-JavaScript files
 
-While most rules target JavaScript and TypeScript, some also lint other file types when used with the corresponding [ESLint language plugin](https://eslint.org/docs/latest/use/configure/plugins#specifying-a-language) such as [`@eslint/css`](https://github.com/eslint/css), [`@eslint/json`](https://github.com/eslint/json), [`@eslint/markdown`](https://github.com/eslint/markdown), or [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint). Each such rule declares this with the `meta.languages` field.
+While most rules target JavaScript and TypeScript, some also lint other file types when used with the corresponding [ESLint language plugin](https://eslint.org/docs/latest/use/configure/plugins#specifying-a-language) such as [`@eslint/css`](https://github.com/eslint/css), [`@eslint/json`](https://github.com/eslint/json), [`@eslint/markdown`](https://github.com/eslint/markdown), [`@html-eslint/eslint-plugin`](https://github.com/yeonjuan/html-eslint), or [`eslint-plugin-yml`](https://github.com/ota-meshi/eslint-plugin-yml). Each such rule declares this with the `meta.languages` field.
 
 When linting JSON, CSS, Markdown, HTML, or other non-JavaScript languages in the same ESLint config, scope Unicorn's JavaScript rule config objects with `files`. Include TypeScript/JSX extensions there only if your config already provides the matching parser/language setup for those files.
 
@@ -522,18 +522,18 @@ These rules work on **any** file type:
 
 These rules also work on specific non-JavaScript languages:
 
-| Name | CSS | HTML | JSON | Markdown |
-| :-- | :-: | :-: | :-: | :-: |
-| [`expiring-todo-comments`](docs/rules/expiring-todo-comments.md) | ✅ | ✅ | ✅ | ✅ |
-| [`no-empty-file`](docs/rules/no-empty-file.md) | ✅ | ✅ | ✅ | ✅ |
-| [`no-invalid-file-input-accept`](docs/rules/no-invalid-file-input-accept.md) |  | ✅ |  |  |
-| [`no-manually-wrapped-comments`](docs/rules/no-manually-wrapped-comments.md) |  |  | ✅ |  |
-| [`no-missing-local-resource`](docs/rules/no-missing-local-resource.md) | ✅ | ✅ |  | ✅ |
-| [`no-shorthand-property-overrides`](docs/rules/no-shorthand-property-overrides.md) | ✅ |  |  |  |
-| [`no-transition-all`](docs/rules/no-transition-all.md) | ✅ |  |  |  |
-| [`prefer-explicit-viewport-units`](docs/rules/prefer-explicit-viewport-units.md) | ✅ |  |  |  |
-| [`require-frontmatter-fields`](docs/rules/require-frontmatter-fields.md) |  |  |  | ✅ |
-| [`text-encoding-identifier-case`](docs/rules/text-encoding-identifier-case.md) | ✅ | ✅ |  |  |
+| Name | CSS | HTML | JSON | Markdown | YAML |
+| :-- | :-: | :-: | :-: | :-: | :-: |
+| [`expiring-todo-comments`](docs/rules/expiring-todo-comments.md) | ✅ | ✅ | ✅ | ✅ | ✅ |
+| [`no-empty-file`](docs/rules/no-empty-file.md) | ✅ | ✅ | ✅ | ✅ |  |
+| [`no-invalid-file-input-accept`](docs/rules/no-invalid-file-input-accept.md) |  | ✅ |  |  |  |
+| [`no-manually-wrapped-comments`](docs/rules/no-manually-wrapped-comments.md) |  |  | ✅ |  |  |
+| [`no-missing-local-resource`](docs/rules/no-missing-local-resource.md) | ✅ | ✅ |  | ✅ |  |
+| [`no-shorthand-property-overrides`](docs/rules/no-shorthand-property-overrides.md) | ✅ |  |  |  |  |
+| [`no-transition-all`](docs/rules/no-transition-all.md) | ✅ |  |  |  |  |
+| [`prefer-explicit-viewport-units`](docs/rules/prefer-explicit-viewport-units.md) | ✅ |  |  |  |  |
+| [`require-frontmatter-fields`](docs/rules/require-frontmatter-fields.md) |  |  |  | ✅ |  |
+| [`text-encoding-identifier-case`](docs/rules/text-encoding-identifier-case.md) | ✅ | ✅ |  |  |  |
 
 <!-- end auto-generated non-js languages list -->
 

rules/expiring-todo-comments.js

@@ -657,6 +657,7 @@ const config = {
 			'json/json5',
 			'markdown/commonmark',
 			'markdown/gfm',
+			'yml/yaml',
 		],
 	},
 };

rules/utils/on-root.js

@@ -1,7 +1,7 @@
 /*
 The root node type produced by each ESLint language:
 
-- `Program` — JavaScript/TypeScript, and HTML via `@html-eslint`
+- `Program` — JavaScript/TypeScript, HTML via `@html-eslint`, and YAML via `eslint-plugin-yml`
 - `StyleSheet` — CSS via `@eslint/css`
 - `Document` — JSON via `@eslint/json`
 - `root` — Markdown via `@eslint/markdown`

scripts/create-non-js-languages-list.js

@@ -7,8 +7,9 @@ const languageLabels = {
 	html: 'HTML',
 	json: 'JSON',
 	markdown: 'Markdown',
+	yml: 'YAML',
 };
-const columnOrder = ['css', 'html', 'json', 'markdown'];
+const columnOrder = ['css', 'html', 'json', 'markdown', 'yml'];
 
 const beginMarker = '<!-- begin auto-generated non-js languages list -->';
 const endMarker = '<!-- end auto-generated non-js languages list -->';

test/expiring-todo-comments.js

@@ -6,6 +6,7 @@ import css from '@eslint/css';
 import json from '@eslint/json';
 import markdown from '@eslint/markdown';
 import htmlEslintPlugin from '@html-eslint/eslint-plugin';
+import yml from 'eslint-plugin-yml';
 import unicorn from '../index.js';
 import {getTester} from './utils/test.js';
 
@@ -852,3 +853,81 @@ test('supports CSS comments with @eslint/css', t => {
 		],
 	);
 });
+
+test('supports YAML comments with eslint-plugin-yml', t => {
+	const linter = new Linter({configType: 'flat'});
+	const messages = linter.verify('key: value # TODO [2000-01-01]: Drop\n# TODO: Update config', {
+		files: ['**/*.yml'],
+		language: 'yml/yaml',
+		plugins: {
+			yml,
+			unicorn,
+		},
+		rules: {
+			'unicorn/expiring-todo-comments': [
+				'error',
+				{
+					date: '2026-05-29',
+					checkDates: true,
+					checkDatesOnPullRequests: true,
+					allowWarningComments: false,
+				},
+			],
+		},
+	}, {
+		filename: 'fixture.yml',
+	});
+
+	t.deepEqual(
+		messages.map(({message, ruleId, line, column, endLine, endColumn}) => ({
+			message,
+			ruleId,
+			line,
+			column,
+			endLine,
+			endColumn,
+		})),
+		[
+			{
+				message: 'Past due date: 2000-01-01. Drop',
+				ruleId: 'unicorn/expiring-todo-comments',
+				line: 1,
+				column: 12,
+				endLine: 1,
+				endColumn: 37,
+			},
+			{
+				message: 'Unexpected \'todo\': \'TODO: Update config\'.',
+				ruleId: 'unicorn/expiring-todo-comments',
+				line: 2,
+				column: 1,
+				endLine: 2,
+				endColumn: 22,
+			},
+		],
+	);
+});
+
+test('supports ESLint disable directives in YAML', t => {
+	const linter = new Linter({configType: 'flat'});
+	const messages = linter.verify('# eslint-disable-next-line unicorn/expiring-todo-comments -- TODO reason\n# TODO: Update config\nkey: value', {
+		files: ['**/*.yaml'],
+		language: 'yml/yaml',
+		plugins: {
+			yml,
+			unicorn,
+		},
+		rules: {
+			'unicorn/expiring-todo-comments': [
+				'error',
+				{
+					allowWarningComments: false,
+				},
+			],
+		},
+	}, {
+		filename: 'fixture.yaml',
+	});
+
+	t.deepEqual(messages, []);
+});