@yuu1111/comment-check 1.0.1 → 2.1.0

package/src/comments.ts

@@ -1,244 +0,0 @@
-/** 抽出するcommentの種別 */
-export type CommentKind = "line" | "block";
-
-/** 抽出したcomment1件の種別と原文上の位置 */
-export interface CommentPiece {
-	kind: CommentKind;
-	text: string;
-	start: number;
-	end: number;
-}
-
-type Mode = "code" | "template" | "expression";
-
-interface ScanState {
-	braces: number[];
-	comments: CommentPiece[];
-	index: number;
-	modes: Mode[];
-}
-
-const REGEX_PRECEDING_CHARACTERS = new Set("(,=:[!&|?{};".split(""));
-const REGEX_PRECEDING_KEYWORDS = new Set([
-	"await",
-	"case",
-	"delete",
-	"do",
-	"else",
-	"in",
-	"instanceof",
-	"new",
-	"of",
-	"return",
-	"throw",
-	"typeof",
-	"void",
-	"yield",
-]);
-
-function isIdentifierCharacter(character: string): boolean {
-	return /[A-Za-z0-9_$]/.test(character);
-}
-
-function skipString(source: string, start: number, quote: string): number {
-	let index = start + 1;
-	while (index < source.length) {
-		const character = source[index] ?? "";
-		if (character === "\\") {
-			index += 2;
-			continue;
-		}
-		if (character === quote) {
-			return index + 1;
-		}
-		if (character === "\n") {
-			return index;
-		}
-		index += 1;
-	}
-	return index;
-}
-
-function isRegexStart(source: string, index: number): boolean {
-	let previous = index - 1;
-	while (previous >= 0 && /\s/.test(source[previous] ?? "")) {
-		previous -= 1;
-	}
-	if (previous < 0) {
-		return true;
-	}
-	const character = source[previous] ?? "";
-	if (REGEX_PRECEDING_CHARACTERS.has(character)) {
-		return true;
-	}
-	if (!isIdentifierCharacter(character)) {
-		return false;
-	}
-	let wordStart = previous;
-	while (wordStart >= 0 && isIdentifierCharacter(source[wordStart] ?? "")) {
-		wordStart -= 1;
-	}
-	return REGEX_PRECEDING_KEYWORDS.has(
-		source.slice(wordStart + 1, previous + 1),
-	);
-}
-
-function skipRegex(source: string, start: number): number {
-	let index = start + 1;
-	let inClass = false;
-	while (index < source.length) {
-		const character = source[index] ?? "";
-		if (character === "\\") {
-			index += 2;
-			continue;
-		}
-		if (character === "\n") {
-			return start;
-		}
-		if (inClass) {
-			inClass = character !== "]";
-			index += 1;
-			continue;
-		}
-		if (character === "[") {
-			inClass = true;
-			index += 1;
-			continue;
-		}
-		if (character === "/") {
-			return index + 1;
-		}
-		index += 1;
-	}
-	return start;
-}
-
-function currentMode(state: ScanState): Mode {
-	return state.modes[state.modes.length - 1] ?? "code";
-}
-
-function stepComment(state: ScanState, source: string): boolean {
-	const character = source[state.index] ?? "";
-	const next = source[state.index + 1] ?? "";
-	if (character !== "/" || (next !== "/" && next !== "*")) {
-		return false;
-	}
-	if (next === "/") {
-		const newline = source.indexOf("\n", state.index);
-		const stop = newline === -1 ? source.length : newline;
-		state.comments.push({
-			end: stop,
-			kind: "line",
-			start: state.index,
-			text: source.slice(state.index + 2, stop),
-		});
-		state.index = stop;
-		return true;
-	}
-	const close = source.indexOf("*/", state.index + 2);
-	const stop = close === -1 ? source.length : close + 2;
-	state.comments.push({
-		end: stop,
-		kind: "block",
-		start: state.index,
-		text: source.slice(state.index + 2, Math.max(state.index + 2, stop - 2)),
-	});
-	state.index = stop;
-	return true;
-}
-
-function stepString(state: ScanState, source: string): boolean {
-	const character = source[state.index] ?? "";
-	if (character !== "'" && character !== '"') {
-		return false;
-	}
-	state.index = skipString(source, state.index, character);
-	return true;
-}
-
-function stepTemplateStart(state: ScanState, source: string): boolean {
-	if (source[state.index] !== "`") {
-		return false;
-	}
-	state.modes.push("template");
-	state.index += 1;
-	return true;
-}
-
-function stepRegex(state: ScanState, source: string): boolean {
-	if (source[state.index] !== "/" || !isRegexStart(source, state.index)) {
-		return false;
-	}
-	const stop = skipRegex(source, state.index);
-	if (stop <= state.index) {
-		return false;
-	}
-	state.index = stop;
-	return true;
-}
-
-function stepTemplate(state: ScanState, source: string): void {
-	const character = source[state.index] ?? "";
-	if (character === "\\") {
-		state.index += 2;
-		return;
-	}
-	if (character === "`") {
-		state.modes.pop();
-		state.index += 1;
-		return;
-	}
-	if (character === "$" && source[state.index + 1] === "{") {
-		state.modes.push("expression");
-		state.braces.push(1);
-		state.index += 2;
-		return;
-	}
-	state.index += 1;
-}
-
-function stepExpression(state: ScanState, source: string): void {
-	const character = source[state.index] ?? "";
-	const depth = state.braces[state.braces.length - 1] ?? 0;
-	if (character === "{") {
-		state.braces[state.braces.length - 1] = depth + 1;
-	} else if (character === "}") {
-		state.braces[state.braces.length - 1] = depth - 1;
-		if (depth - 1 === 0) {
-			state.modes.pop();
-			state.braces.pop();
-		}
-	}
-	state.index += 1;
-}
-
-function step(state: ScanState, source: string): void {
-	if (currentMode(state) === "template") {
-		stepTemplate(state, source);
-		return;
-	}
-	if (
-		stepComment(state, source) ||
-		stepString(state, source) ||
-		stepTemplateStart(state, source) ||
-		stepRegex(state, source)
-	) {
-		return;
-	}
-	stepExpression(state, source);
-}
-
-/** 文字列や正規表現リテラルを除外してsourceからcommentを抽出する */
-export function extractComments(source: string): CommentPiece[] {
-	const shebang = source.startsWith("#!") ? source.indexOf("\n") : 0;
-	const state: ScanState = {
-		braces: [],
-		comments: [],
-		index: Math.max(0, shebang),
-		modes: ["code"],
-	};
-	while (state.index < source.length) {
-		step(state, source);
-	}
-	return state.comments;
-}

package/src/rules.ts

@@ -1,60 +0,0 @@
-/** comment-checkが報告するruleの識別子一覧 */
-export const RULE_IDS = [
-	"broad-suppression",
-	"undocumented-directive",
-	"placeholder-comment",
-	"separator-comment",
-] as const;
-
-/** RULE_IDSが定義するrule識別子のunion型 */
-export type RuleId = (typeof RULE_IDS)[number];
-
-/** 検出したcomment違反1件の内容と位置 */
-export interface Finding {
-	rule: RuleId;
-	file: string;
-	line: number;
-	column: number;
-	text: string;
-}
-
-const PLACEHOLDER_PATTERN = /\b(TODO|FIXME|XXX|HACK)\b/;
-const SEPARATOR_PATTERN = /^[-=*_#~+./\\|]{4,}$/;
-const DIRECTIVE_PATTERN = /^@ts-(?:ignore|expect-error)\b([\s\S]*)$/;
-
-/** block commentの記号を除いて空白を揃えた本文を返す */
-export function normalizeComment(body: string): string {
-	return body
-		.split("\n")
-		.map((line) => line.replace(/^\s*\*+\s?/, ""))
-		.join(" ")
-		.replace(/\s+/g, " ")
-		.trim();
-}
-
-/** comment本文を分類し、該当するruleがなければnullを返す */
-export function classifyComment(body: string): RuleId | null {
-	const text = normalizeComment(body);
-	if (text === "") {
-		return null;
-	}
-	if (
-		/^(?:biome-ignore-all|@ts-nocheck)\b/.test(text) ||
-		/^eslint-disable(?:-next-line|-line)?\s*$/.test(text)
-	) {
-		return "broad-suppression";
-	}
-	const directive = DIRECTIVE_PATTERN.exec(text);
-	if (directive) {
-		return (directive[1] ?? "").replace(/^[\s:—-]+/, "") === ""
-			? "undocumented-directive"
-			: null;
-	}
-	if (PLACEHOLDER_PATTERN.test(text)) {
-		return "placeholder-comment";
-	}
-	if (SEPARATOR_PATTERN.test(text)) {
-		return "separator-comment";
-	}
-	return null;
-}

package/src/scan.ts

@@ -1,145 +0,0 @@
-import { readdirSync, readFileSync, statSync } from "node:fs";
-import { extname, join, relative, resolve } from "node:path";
-import { extractComments } from "./comments";
-import { classifyComment, type Finding, normalizeComment } from "./rules";
-
-const SUPPORTED_EXTENSIONS = new Set([
-	".cjs",
-	".cts",
-	".js",
-	".jsx",
-	".mjs",
-	".mts",
-	".ts",
-	".tsx",
-]);
-const IGNORED_DIRECTORIES = new Set([
-	"build",
-	"coverage",
-	"dist",
-	"node_modules",
-	"out",
-	"vendor",
-]);
-
-/** 区切り文字を統一し先頭の./と末尾の/を除いたpathを返す */
-export function normalizePath(path: string): string {
-	return path.split("\\").join("/").replace(/^\.\//, "").replace(/\/+$/, "");
-}
-
-function isIgnored(path: string, ignores: string[]): boolean {
-	return ignores.some(
-		(ignore) => path === ignore || path.startsWith(`${ignore}/`),
-	);
-}
-
-function positionAt(
-	source: string,
-	offset: number,
-): { line: number; column: number } {
-	let line = 1;
-	let lineStart = 0;
-	for (let index = 0; index < offset; index += 1) {
-		if (source[index] === "\n") {
-			line += 1;
-			lineStart = index + 1;
-		}
-	}
-	return { line, column: offset - lineStart + 1 };
-}
-
-function compareFindings(left: Finding, right: Finding): number {
-	if (left.file !== right.file) {
-		return left.file < right.file ? -1 : 1;
-	}
-	if (left.line !== right.line) {
-		return left.line - right.line;
-	}
-	return left.column - right.column;
-}
-
-function walk(directory: string, files: Set<string>): void {
-	for (const entry of readdirSync(directory, { withFileTypes: true })) {
-		if (entry.name.startsWith(".")) {
-			continue;
-		}
-		const path = join(directory, entry.name);
-		if (entry.isDirectory()) {
-			if (!IGNORED_DIRECTORIES.has(entry.name)) {
-				walk(path, files);
-			}
-			continue;
-		}
-		if (entry.isFile() && SUPPORTED_EXTENSIONS.has(extname(entry.name))) {
-			files.add(path);
-		}
-	}
-}
-
-/** 対象pathを走査して検査対象のfile一覧を集める */
-export function collectFiles(
-	targets: string[],
-	cwd = process.cwd(),
-	ignores: string[] = [],
-): string[] {
-	const files = new Set<string>();
-	for (const target of targets) {
-		const absolute = resolve(cwd, target);
-		let stats: ReturnType<typeof statSync>;
-		try {
-			stats = statSync(absolute);
-		} catch {
-			continue;
-		}
-		if (stats.isFile()) {
-			if (
-				SUPPORTED_EXTENSIONS.has(extname(absolute)) &&
-				!isIgnored(normalizePath(target), ignores)
-			) {
-				files.add(absolute);
-			}
-			continue;
-		}
-		walk(absolute, files);
-	}
-	return [...files]
-		.filter((file) => !isIgnored(normalizePath(relative(cwd, file)), ignores))
-		.sort();
-}
-
-/** source文字列を走査してcomment違反を検出する */
-export function scanSource(source: string, file: string): Finding[] {
-	const findings: Finding[] = [];
-	for (const comment of extractComments(source)) {
-		const rule = classifyComment(comment.text);
-		if (rule === null) {
-			continue;
-		}
-		const position = positionAt(source, comment.start);
-		findings.push({
-			column: position.column,
-			file,
-			line: position.line,
-			rule,
-			text: normalizeComment(comment.text),
-		});
-	}
-	return findings;
-}
-
-/** fileを読み込んでcomment違反を検出する */
-export function scanFile(file: string, cwd = process.cwd()): Finding[] {
-	return scanSource(
-		readFileSync(file, "utf8"),
-		normalizePath(relative(cwd, file)),
-	);
-}
-
-/** 複数fileの違反をまとめて位置順に並べる */
-export function scanFiles(files: string[], cwd = process.cwd()): Finding[] {
-	const findings: Finding[] = [];
-	for (const file of files) {
-		findings.push(...scanFile(file, cwd));
-	}
-	return findings.sort(compareFindings);
-}