@kazupon/eslint-plugin 0.4.0 → 0.5.0

package/lib/index.js

@@ -12,7 +12,7 @@ const name = "@kazupon/eslint-plugin";
 /**
 * The plugin version.
 */
-const version = "0.4.0";
+const version = "0.5.0";
 /**
 * The namespace for rules
 */
@@ -200,7 +200,7 @@ function stripJSDocPrefix(line) {
 */
 function detectTag(text, tags) {
 	for (const tag of tags) {
-		const tagRegex = new RegExp(`^${tag}\\b`);
+		const tagRegex = /* @__PURE__ */ new RegExp(`^${tag}\\b`);
 		const match = text.match(tagRegex);
 		if (match) {
 			const afterTag = text.slice(tag.length);
@@ -350,6 +350,14 @@ const DEFAULT_TAGS = [
 	"BUG",
 	"NOTE"
 ];
+const DEFAULT_DIRECTIVES = [
+	"eslint-disable",
+	"eslint-disable-next-line",
+	"eslint-disable-line",
+	"@ts-expect-error",
+	"@ts-ignore",
+	"@ts-nocheck"
+];
 const rule = createRule({
 	name: "prefer-scope-on-tag-comment",
 	meta: {
@@ -363,18 +371,27 @@ const rule = createRule({
 		messages: { missingScope: "Tag comment '{{tag}}' is missing a scope. Use format: {{tag}}(scope)" },
 		schema: [{
 			type: "object",
-			properties: { tags: {
-				type: "array",
-				items: { type: "string" },
-				minItems: 1,
-				uniqueItems: true
-			} },
+			properties: {
+				tags: {
+					type: "array",
+					items: { type: "string" },
+					minItems: 1,
+					uniqueItems: true
+				},
+				directives: {
+					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 directives = options.directives || DEFAULT_DIRECTIVES;
 		const sourceCode = ctx.sourceCode;
 		/**
 		* Report a missing scope violation
@@ -409,11 +426,59 @@ const rule = createRule({
 			});
 		}
 		/**
+		* Check if comment starts with a directive and extract the description
+		* @returns Object with directive match info or null
+		*/
+		function parseDirectiveComment(text) {
+			const trimmedText = text.trim();
+			for (const directive of directives) if (trimmedText.startsWith(directive)) {
+				const afterDirective = trimmedText.slice(directive.length);
+				const separatorIndex = afterDirective.indexOf("--");
+				if (separatorIndex !== -1) {
+					const description = afterDirective.slice(separatorIndex + 2).trim();
+					const separatorPos = text.indexOf("--");
+					const afterSeparator = text.slice(separatorPos + 2);
+					const descriptionStart = separatorPos + 2 + (afterSeparator.length - afterSeparator.trimStart().length);
+					return {
+						directive,
+						description,
+						descriptionStart
+					};
+				}
+				if (afterDirective.trim()) {
+					const spaceMatch = afterDirective.match(/^\s+/);
+					if (spaceMatch) {
+						const description = afterDirective.trim();
+						const directiveIndex = text.indexOf(directive);
+						const descriptionStart = directiveIndex + directive.length + spaceMatch[0].length;
+						return {
+							directive,
+							description,
+							descriptionStart
+						};
+					}
+				}
+			}
+			return null;
+		}
+		/**
 		* Check a comment for missing scope
 		*/
 		function checkComment(comment) {
 			const { value, type } = comment;
 			if (type === "Line") {
+				const directiveInfo$1 = parseDirectiveComment(value);
+				if (directiveInfo$1) {
+					const tagInfo$1 = detectTag(directiveInfo$1.description, tags);
+					if (tagInfo$1 && !tagInfo$1.hasScope) {
+						const tagIndex = directiveInfo$1.description.indexOf(tagInfo$1.tag);
+						if (tagIndex !== -1) reportMissingScope(comment, tagInfo$1.tag, {
+							line: comment.loc.start.line,
+							column: comment.loc.start.column + 2 + directiveInfo$1.descriptionStart + tagIndex
+						});
+					}
+					return;
+				}
 				const tagInfo = detectTag(value.trim(), tags);
 				if (tagInfo && !tagInfo.hasScope) {
 					const tagIndex = value.indexOf(tagInfo.tag);
@@ -425,6 +490,44 @@ const rule = createRule({
 				return;
 			}
 			const lines = value.split("\n");
+			const directiveInfo = parseDirectiveComment(value);
+			if (directiveInfo) {
+				const tagInfo = detectTag(directiveInfo.description, tags);
+				if (tagInfo && !tagInfo.hasScope) if (lines.length === 1) {
+					const tagIndexInDesc = directiveInfo.description.indexOf(tagInfo.tag);
+					if (tagIndexInDesc !== -1) {
+						const tagIndexInValue = directiveInfo.descriptionStart + tagIndexInDesc;
+						const location = {
+							line: comment.loc.start.line,
+							column: comment.loc.start.column + 2 + tagIndexInValue
+						};
+						reportMissingScope(comment, tagInfo.tag, location);
+					}
+				} else {
+					const descLines = directiveInfo.description.split("\n");
+					for (const [descLineIndex, descLine] of descLines.entries()) {
+						const lineTagInfo = detectTag(descLine.trim(), tags);
+						if (lineTagInfo && !lineTagInfo.hasScope) {
+							const descStartInComment = value.indexOf(directiveInfo.description);
+							const linesBeforeDesc = value.slice(0, descStartInComment).split("\n").length - 1;
+							const actualLineIndex = linesBeforeDesc + descLineIndex;
+							if (actualLineIndex < lines.length) {
+								const actualLine = lines[actualLineIndex];
+								const tagIndex = actualLine.indexOf(lineTagInfo.tag);
+								if (tagIndex !== -1) {
+									const location = {
+										line: comment.loc.start.line + actualLineIndex,
+										column: actualLineIndex === 0 ? comment.loc.start.column + 2 + tagIndex : tagIndex
+									};
+									reportMissingScope(comment, lineTagInfo.tag, location);
+									break;
+								}
+							}
+						}
+					}
+				}
+				return;
+			}
 			for (const [i, line] of lines.entries()) {
 				const trimmedLine = line.trim();
 				if (!trimmedLine) continue;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-plugin",
   "description": "ESLint plugin for @kazupon",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "funding": "https://github.com/sponsors/kazupon",
   "bugs": {
@@ -47,48 +47,48 @@
     }
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "^0.50.2",
-    "@eslint/core": "^0.14.0"
+    "@es-joy/jsdoccomment": "^0.52.0",
+    "@eslint/core": "^0.15.1"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"
   },
   "devDependencies": {
-    "@eslint/compat": "^1.2.9",
-    "@eslint/markdown": "^6.5.0",
-    "@kazupon/eslint-config": "^0.31.0",
+    "@eslint/compat": "^1.3.1",
+    "@eslint/markdown": "^7.0.0",
+    "@kazupon/eslint-config": "^0.32.0",
     "@kazupon/prettier-config": "^0.1.1",
-    "@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",
+    "@shikijs/vitepress-twoslash": "^3.8.1",
+    "@types/node": "^22.16.5",
+    "@vitest/eslint-plugin": "^1.3.4",
+    "bumpp": "^10.2.0",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsonc": "^2.20.1",
     "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-regexp": "^2.8.0",
-    "eslint-plugin-unicorn": "^59.0.0",
+    "eslint-plugin-regexp": "^2.9.0",
+    "eslint-plugin-unicorn": "^60.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "eslint-plugin-yml": "^1.18.0",
     "eslint-vitest-rule-tester": "^2.2.0",
     "gh-changelogen": "^0.2.8",
-    "knip": "^5.60.2",
-    "lint-staged": "^16.0.0",
-    "pkg-pr-new": "^0.0.51",
-    "prettier": "^3.5.3",
+    "knip": "^5.62.0",
+    "lint-staged": "^16.1.2",
+    "pkg-pr-new": "^0.0.54",
+    "prettier": "^3.6.2",
     "publint": "^0.3.12",
-    "tsdown": "^0.12.7",
-    "tsx": "^4.19.4",
-    "twoslash-eslint": "^0.3.1",
+    "tsdown": "^0.13.0",
+    "tsx": "^4.20.3",
+    "twoslash-eslint": "^0.3.3",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.1",
-    "vite-plugin-eslint4b": "^0.5.1",
+    "typescript-eslint": "^8.38.0",
+    "vite-plugin-eslint4b": "^0.6.0",
     "vitepress": "^1.6.3",
-    "vitepress-plugin-group-icons": "^1.6.0",
-    "vitest": "^3.2.2"
+    "vitepress-plugin-group-icons": "^1.6.1",
+    "vitest": "^3.2.4"
   },
   "prettier": "@kazupon/prettier-config",
   "lint-staged": {
@@ -118,11 +118,11 @@
     "fix": "pnpm run --stream --color \"/^fix:/\"",
     "fix:eslint": "eslint . --fix",
     "fix:knip": "knip --fix --no-exit-code",
-    "fix:prettier": "prettier . --write",
+    "fix:prettier": "prettier . --write --experimental-cli",
     "lint": "pnpm run --stream --color \"/^lint:/\"",
     "lint:eslint": "eslint .",
     "lint:knip": "knip",
-    "lint:prettier": "prettier . --check",
+    "lint:prettier": "prettier . --check --experimental-cli",
     "release": "bumpp --commit \"release: v%s\" --all --push --tag",
     "test": "vitest run",
     "typecheck": "pnpm run --stream --color \"/^typecheck:/\"",