@kazupon/eslint-plugin 0.2.1 → 0.3.0

package/README.md

@@ -64,6 +64,7 @@ The rules with the following star ⭐ are included in the configs.
 | Rule ID                                                                                                | Description                                     | Category | Fixable | RECOMMENDED |
 | :----------------------------------------------------------------------------------------------------- | :---------------------------------------------- | :------- | :-----: | :---------: |
 | [@kazupon/enforce-header-comment](https://eslint-plugin.kazupon.dev/rules/enforce-header-comment.html) | Enforce heading the comment in source code file | Comment  |         |     ⭐      |
+| [@kazupon/no-tag-comments](https://eslint-plugin.kazupon.dev/rules/no-tag-comments.html)               | disallow tag comments                           | Comment  |         |             |
 
 <!--RULES_TABLE_END-->
 

package/lib/index.d.ts

@@ -2,17 +2,18 @@ import { ESLint, Linter } from "eslint";
 
 //#region src/index.d.ts
 type PluginConfigs = {
-	recommended: Linter.Config<Linter.RulesRecord>[]
-	comment: Linter.Config<Linter.RulesRecord>[]
+  recommended: Linter.Config<Linter.RulesRecord>[];
+  comment: Linter.Config<Linter.RulesRecord>[];
 };
 declare const plugin: Omit<ESLint.Plugin, "configs"> & {
-	configs: PluginConfigs
+  configs: PluginConfigs;
 };
 declare const commentConfig: Linter.Config[];
 declare const configs: {
-	recommended: typeof commentConfig
-	comment: typeof commentConfig
+  recommended: typeof commentConfig;
+  comment: typeof commentConfig;
 };
+/** @alias */
 
 //#endregion
 export { configs, plugin as default, plugin };

package/lib/index.js

@@ -1,15 +1,28 @@
 import { parseComment } from "@es-joy/jsdoccomment";
 
 //#region src/utils/constants.ts
+/**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
+* The plugin name.
+*/
 const name = "@kazupon/eslint-plugin";
-const version = "0.2.1";
+/**
+* The plugin version.
+*/
+const version = "0.3.0";
+/**
+* The namespace for rules
+*/
 const namespace = "@kazupon";
 
 //#endregion
 //#region src/utils/rule.ts
-const BLOB_URL = "https://github.com/kazupon/eslint-plugin/tree/main/src/rules";
+const BLOB_URL = "https://eslint-plugin.kazupon.dev/rules";
 function RuleCreator(urlCreator, namespace$1 = "") {
-	return function createNamedRule({ meta, name: name$1,...rule$1 }) {
+	return function createNamedRule({ meta, name: name$1,...rule$2 }) {
 		const ruleId = namespace$1 ? `${namespace$1}/${name$1}` : name$1;
 		return {
 			meta: {
@@ -21,12 +34,12 @@ function RuleCreator(urlCreator, namespace$1 = "") {
 					ruleId
 				}
 			},
-			...rule$1
+			...rule$2
 		};
 	};
 }
 const createRule = RuleCreator((ruleName) => {
-	return `${BLOB_URL}/${ruleName}.ts`;
+	return `${BLOB_URL}/${ruleName}`;
 }, namespace);
 
 //#endregion
@@ -40,7 +53,7 @@ function initializeTagDiagnosis(tags) {
 function validTagDiagnosis(tagDiagnosis) {
 	return Object.keys(tagDiagnosis).every((tag) => tagDiagnosis[tag] === "ok");
 }
-const rule = createRule({
+const rule$1 = createRule({
 	name: "enforce-header-comment",
 	meta: {
 		type: "suggestion",
@@ -168,11 +181,110 @@ const rule = createRule({
 		};
 	}
 });
-var enforce_header_comment_default = rule;
+var enforce_header_comment_default = rule$1;
+
+//#endregion
+//#region src/rules/no-tag-comments.ts
+const DEFAULT_TAGS = ["FIXME", "BUG"];
+/**
+* Remove JSDoc asterisk prefix if present
+*/
+function stripJSDocPrefix(line) {
+	const trimmed = line.trim();
+	return trimmed.startsWith("*") ? trimmed.slice(1).trim() : trimmed;
+}
+const rule = createRule({
+	name: "no-tag-comments",
+	meta: {
+		type: "problem",
+		docs: {
+			description: "disallow tag comments",
+			category: "Comment",
+			recommended: false,
+			defaultSeverity: "warn"
+		},
+		messages: { avoidTagComment: "Fix '{{tag}}' tag comment" },
+		schema: [{
+			type: "object",
+			properties: { tags: {
+				type: "array",
+				items: { type: "string" },
+				minItems: 1,
+				uniqueItems: true
+			} },
+			additionalProperties: false
+		}]
+	},
+	create(ctx) {
+		const options = ctx.options[0] || { tags: DEFAULT_TAGS };
+		const tags = options.tags || DEFAULT_TAGS;
+		const sourceCode = ctx.sourceCode;
+		/**
+		* Check if the text starts with a tag followed by valid delimiter
+		*/
+		function hasTag(text) {
+			for (const tag of tags) if (text.startsWith(tag)) {
+				const afterTag = text.slice(tag.length);
+				if (afterTag === "" || afterTag.startsWith(":") || afterTag.startsWith(" ")) return tag;
+			}
+			return null;
+		}
+		/**
+		* Report a tag comment violation
+		*/
+		function reportTag(comment, tag) {
+			ctx.report({
+				messageId: "avoidTagComment",
+				data: { tag },
+				loc: comment.loc
+			});
+		}
+		/**
+		* Process a single line of text for tags
+		*/
+		function checkLine(text, comment) {
+			const tag = hasTag(text);
+			if (tag) {
+				reportTag(comment, tag);
+				return true;
+			}
+			return false;
+		}
+		/**
+		* Check a comment for tag violations
+		*/
+		function checkComment(comment) {
+			const { value, type } = comment;
+			if (type === "Line") {
+				checkLine(value.trim(), comment);
+				return;
+			}
+			const lines = value.split("\n");
+			if (lines.length === 1) {
+				checkLine(value.trim(), comment);
+				return;
+			}
+			for (const line of lines) {
+				const trimmedLine = line.trim();
+				if (!trimmedLine) continue;
+				const contentToCheck = stripJSDocPrefix(line);
+				if (checkLine(contentToCheck, comment)) break;
+			}
+		}
+		return { Program() {
+			const comments = sourceCode.getAllComments();
+			for (const comment of comments) checkComment(comment);
+		} };
+	}
+});
+var no_tag_comments_default = rule;
 
 //#endregion
 //#region src/rules/index.ts
-const rules = { "enforce-header-comment": enforce_header_comment_default };
+const rules = {
+	"enforce-header-comment": enforce_header_comment_default,
+	"no-tag-comments": no_tag_comments_default
+};
 
 //#endregion
 //#region src/index.ts
@@ -193,9 +305,9 @@ const commentConfig = [{
 		"**/*.config.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 	],
 	plugins: { [namespace]: plugin },
-	rules: Object.entries(rules).reduce((rules$1, [ruleName, rule$1]) => {
-		const ruleId = rule$1.meta?.docs?.ruleId || (namespace ? `${namespace}/${ruleName}` : ruleName);
-		rules$1[ruleId] = rule$1.meta?.docs?.defaultSeverity || "warn";
+	rules: Object.entries(rules).reduce((rules$1, [ruleName, rule$2]) => {
+		const ruleId = rule$2.meta?.docs?.ruleId || (namespace ? `${namespace}/${ruleName}` : ruleName);
+		rules$1[ruleId] = rule$2.meta?.docs?.defaultSeverity || "warn";
 		return rules$1;
 	}, Object.create(null))
 }];
@@ -204,6 +316,7 @@ const configs = {
 	comment: commentConfig
 };
 plugin.configs = configs;
+/** @alias */
 var src_default = plugin;
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-plugin",
   "description": "ESLint plugin for @kazupon",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "license": "MIT",
   "funding": "https://github.com/sponsors/kazupon",
   "bugs": {
@@ -47,46 +47,47 @@
     }
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "^0.50.0",
-    "@eslint/core": "^0.13.0"
+    "@es-joy/jsdoccomment": "^0.50.2",
+    "@eslint/core": "^0.14.0"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"
   },
   "devDependencies": {
-    "@eslint/markdown": "^6.3.0",
-    "@kazupon/eslint-config": "^0.28.0",
+    "@eslint/compat": "^1.2.9",
+    "@eslint/markdown": "^6.5.0",
+    "@kazupon/eslint-config": "^0.30.0",
     "@kazupon/prettier-config": "^0.1.1",
-    "@shikijs/vitepress-twoslash": "^3.2.2",
-    "@types/node": "^22.14.1",
-    "@vitest/eslint-plugin": "^1.1.42",
-    "bumpp": "^10.1.0",
-    "eslint": "^9.24.0",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-import-resolver-typescript": "^4.3.2",
+    "@shikijs/vitepress-twoslash": "^3.6.0",
+    "@types/node": "^22.15.30",
+    "@vitest/eslint-plugin": "^1.2.1",
+    "bumpp": "^10.1.1",
+    "eslint": "^9.28.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.4.3",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsonc": "^2.20.0",
+    "eslint-plugin-jsonc": "^2.20.1",
     "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-unicorn": "^58.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
-    "eslint-plugin-yml": "^1.17.0",
+    "eslint-plugin-yml": "^1.18.0",
     "eslint-vitest-rule-tester": "^2.2.0",
     "gh-changelogen": "^0.2.8",
-    "knip": "^5.50.2",
-    "lint-staged": "^15.5.1",
-    "pkg-pr-new": "^0.0.42",
+    "knip": "^5.60.2",
+    "lint-staged": "^16.0.0",
+    "pkg-pr-new": "^0.0.51",
     "prettier": "^3.5.3",
-    "publint": "^0.3.11",
-    "tsdown": "^0.8.0-beta.2",
-    "tsx": "^4.19.3",
+    "publint": "^0.3.12",
+    "tsdown": "^0.12.7",
+    "tsx": "^4.19.4",
     "twoslash-eslint": "^0.3.1",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.29.1",
+    "typescript-eslint": "^8.33.1",
     "vite-plugin-eslint4b": "^0.5.1",
     "vitepress": "^1.6.3",
-    "vitepress-plugin-group-icons": "^1.4.1",
-    "vitest": "^3.1.1"
+    "vitepress-plugin-group-icons": "^1.6.0",
+    "vitest": "^3.2.2"
   },
   "prettier": "@kazupon/prettier-config",
   "lint-staged": {