@kongyo2/ts-comment-scanner 0.0.0 → 1.0.0

package/dist/files.js

@@ -1,17 +1,27 @@
 import { readFile, readdir, stat } from "node:fs/promises";
-import { extname, join } from "node:path";
+import { join, normalize, relative, sep } from "node:path";
+import picomatch from "picomatch";
 import { scanComments } from "./scanner.js";
 const DEFAULT_EXTENSIONS = [".ts", ".tsx", ".mts", ".cts"];
 const DEFAULT_IGNORE_DIRS = ["node_modules", ".git"];
-const READ_CONCURRENCY = 16;
 export async function collectFiles(inputs, options = {}) {
-    const extensions = options.extensions ?? DEFAULT_EXTENSIONS;
+    const extensions = normalizeExtensions(options.extensions ?? DEFAULT_EXTENSIONS);
     const ignoreDirs = new Set(options.ignoreDirs ?? DEFAULT_IGNORE_DIRS);
+    const isIgnored = buildIgnoreMatcher(options.ignore ?? []);
     const found = new Set();
-    await Promise.all(inputs.map(async (input) => {
+    await Promise.all(inputs.map(async (rawInput) => {
+        if (rawInput === "") {
+            // normalize("") would resolve to "." and silently widen the scan.
+            throw new Error("empty path is not a valid input");
+        }
+        const input = normalize(rawInput);
         const info = await stat(input);
         if (info.isDirectory()) {
-            await walk(input, extensions, ignoreDirs, found);
+            // Directory inputs are themselves subject to the ignore patterns;
+            // only explicitly listed files bypass them.
+            if (!isIgnored(input, input)) {
+                await walk(input, { extensions, ignoreDirs, isIgnored, root: input }, found);
+            }
         }
         else {
             found.add(input);
@@ -19,38 +29,92 @@ export async function collectFiles(inputs, options = {}) {
     }));
     return [...found].sort();
 }
-async function walk(dir, extensions, ignoreDirs, found) {
+async function walk(dir, context, found) {
     const entries = await readdir(dir, { withFileTypes: true });
     await Promise.all(entries.map(async (entry) => {
         const full = join(dir, entry.name);
         if (entry.isDirectory()) {
-            if (!ignoreDirs.has(entry.name)) {
-                await walk(full, extensions, ignoreDirs, found);
+            if (!context.ignoreDirs.has(entry.name) && !context.isIgnored(full, context.root)) {
+                await walk(full, context, found);
             }
         }
-        else if (entry.isFile() && extensions.includes(extname(entry.name))) {
+        else if (entry.isFile() &&
+            hasExtension(entry.name, context.extensions) &&
+            !context.isIgnored(full, context.root)) {
             found.add(full);
         }
     }));
 }
+function normalizeExtensions(extensions) {
+    return extensions.map((extension) => {
+        const withDot = extension.startsWith(".") ? extension : `.${extension}`;
+        return withDot.toLowerCase();
+    });
+}
+/** Suffix match so compound extensions like `.d.ts` work; `extname` would only see `.ts`. */
+function hasExtension(name, extensions) {
+    const lower = name.toLowerCase();
+    return extensions.some((extension) => lower.endsWith(extension));
+}
+function buildIgnoreMatcher(patterns) {
+    if (patterns.length === 0)
+        return () => false;
+    // Gitignore-like split: patterns without a slash match base names, patterns
+    // with a slash match whole paths. (picomatch's `basename` option would apply
+    // to every pattern, breaking path globs, so two matchers are needed.)
+    const matchers = [];
+    const byBasename = patterns.filter((pattern) => !pattern.includes("/"));
+    const byPath = patterns.filter((pattern) => pattern.includes("/"));
+    if (byBasename.length > 0)
+        matchers.push(picomatch(byBasename, { dot: true, basename: true }));
+    if (byPath.length > 0)
+        matchers.push(picomatch(byPath, { dot: true }));
+    const match = (path) => matchers.some((matcher) => matcher(path));
+    // Anchored patterns like `src/legacy/**` are tried against the path as
+    // spelled, relative to the scanned root, and relative to the working
+    // directory, so they work regardless of where the scan was started from.
+    return (path, root) => {
+        if (match(toPosix(path)))
+            return true;
+        return relativeMatches(root, path, match) || relativeMatches(process.cwd(), path, match);
+    };
+}
+function relativeMatches(base, path, match) {
+    const relativePath = relative(base, path);
+    return relativePath !== "" && !relativePath.startsWith("..") && match(toPosix(relativePath));
+}
+function toPosix(path) {
+    return sep === "/" ? path : path.split(sep).join("/");
+}
+export function isJsxFile(file) {
+    const lower = file.toLowerCase();
+    return lower.endsWith(".tsx") || lower.endsWith(".jsx");
+}
 export async function scanFile(file) {
-    const source = await readFile(file, "utf8");
-    return { file, comments: scanComments(source, { jsx: file.endsWith(".tsx") || file.endsWith(".jsx") }) };
+    const raw = await readFile(file, "utf8");
+    // Positions are reported relative to the content after a leading byte-order
+    // mark, matching editors, GitHub annotations and the removal report.
+    const source = raw.startsWith("\uFEFF") ? raw.slice(1) : raw;
+    return { file, comments: scanComments(source, { jsx: isJsxFile(file) }) };
 }
 export async function scanPaths(inputs, options = {}) {
     const files = await collectFiles(inputs, options);
-    return mapLimit(files, READ_CONCURRENCY, scanFile);
+    return mapLimit(files, FILE_CONCURRENCY, scanFile);
 }
-async function mapLimit(items, limit, fn) {
-    const results = [];
-    const processFrom = async (start) => {
-        if (start >= items.length)
+export const FILE_CONCURRENCY = 16;
+/** Concurrency-limited map that keeps input order and starts work as slots free up. */
+export async function mapLimit(items, limit, fn) {
+    const results = new Array(items.length);
+    let nextIndex = 0;
+    const claimNext = async () => {
+        const index = nextIndex;
+        nextIndex += 1;
+        if (index >= items.length)
             return;
-        const batch = await Promise.all(items.slice(start, start + limit).map(fn));
-        results.push(...batch);
-        await processFrom(start + limit);
+        results[index] = await fn(items[index]);
+        return claimNext();
     };
-    await processFrom(0);
+    await Promise.all(Array.from({ length: Math.min(limit, items.length) }, claimNext));
     return results;
 }
 //# sourceMappingURL=files.js.map

package/dist/files.js.map

@@ -1 +1 @@
-{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3D,MAAM,mBAAmB,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AACrD,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAO5B,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAgB,EAAE,UAA0B,EAAE;IAC/E,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,kBAAkB,CAAC;IAC5D,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAEhC,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,GAAW,EAAE,UAAoB,EAAE,UAAuB,EAAE,KAAkB;IAChG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACtE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;AAC3G,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAgB,EAAE,UAA0B,EAAE;IAC5E,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,QAAQ,CAAO,KAAmB,EAAE,KAAa,EAAE,EAA2B;IAC3F,MAAM,OAAO,GAAQ,EAAE,CAAC;IAExB,MAAM,WAAW,GAAG,KAAK,EAAE,KAAa,EAAiB,EAAE;QACzD,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM;YAAE,OAAO;QAClC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QACvB,MAAM,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;IACrB,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3D,MAAM,mBAAmB,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AAiBrD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAgB,EAAE,UAA0B,EAAE;IAC/E,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,UAAU,IAAI,kBAAkB,CAAC,CAAC;IACjF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAEhC,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC5B,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;YACpB,kEAAkE;YAClE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,kEAAkE;YAClE,4CAA4C;YAC5C,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;AAC3B,CAAC;AAUD,KAAK,UAAU,IAAI,CAAC,GAAW,EAAE,OAAoB,EAAE,KAAkB;IACvE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClF,MAAM,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;aAAM,IACL,KAAK,CAAC,MAAM,EAAE;YACd,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC;YAC5C,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EACtC,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,UAAoB;IAC/C,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAClC,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC;QACxE,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6FAA6F;AAC7F,SAAS,YAAY,CAAC,IAAY,EAAE,UAAoB;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAkB;IAC5C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;IAE9C,4EAA4E;IAC5E,6EAA6E;IAC7E,sEAAsE;IACtE,MAAM,QAAQ,GAAqC,EAAE,CAAC;IACtD,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/F,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnF,uEAAuE;IACvE,qEAAqE;IACrE,yEAAyE;IACzE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACtC,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,IAAY,EAAE,KAAgC;IACnF,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,OAAO,YAAY,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,4EAA4E;IAC5E,qEAAqE;IACrE,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC7D,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAgB,EAAE,UAA0B,EAAE;IAC5E,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAEnC,uFAAuF;AACvF,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAO,KAAmB,EAAE,KAAa,EAAE,EAA2B;IAClG,MAAM,OAAO,GAAG,IAAI,KAAK,CAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,MAAM,SAAS,GAAG,KAAK,IAAmB,EAAE;QAC1C,MAAM,KAAK,GAAG,SAAS,CAAC;QACxB,SAAS,IAAI,CAAC,CAAC;QACf,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM;YAAE,OAAO;QAClC,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,CAAM,CAAC,CAAC;QAC7C,OAAO,SAAS,EAAE,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IACpF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export { scanComments, type ScanOptions } from "./scanner.js";
-export { collectFiles, scanFile, scanPaths, type CollectOptions } from "./files.js";
-export { formatText, formatJson } from "./report.js";
+export { collectFiles, isJsxFile, scanFile, scanPaths, type CollectOptions } from "./files.js";
+export { removeComments, type RemoveOptions, type RemoveResult } from "./remove.js";
+export { detectDirective, isLegalComment } from "./directives.js";
+export { formatText, formatJson, formatGitHub } from "./report.js";
 export type { Comment, CommentKind, FileScanResult } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAC/F,OAAO,EAAE,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACnE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -1,4 +1,6 @@
 export { scanComments } from "./scanner.js";
-export { collectFiles, scanFile, scanPaths } from "./files.js";
-export { formatText, formatJson } from "./report.js";
+export { collectFiles, isJsxFile, scanFile, scanPaths } from "./files.js";
+export { removeComments } from "./remove.js";
+export { detectDirective, isLegalComment } from "./directives.js";
+export { formatText, formatJson, formatGitHub } from "./report.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoB,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAuB,MAAM,YAAY,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoB,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAuB,MAAM,YAAY,CAAC;AAC/F,OAAO,EAAE,cAAc,EAAyC,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/remove.d.ts

@@ -0,0 +1,38 @@
+import type { Comment } from "./types.js";
+export interface RemoveOptions {
+    jsx?: boolean;
+    /** Also remove compiler/linter directive comments. Default: false (kept for safety). */
+    removeDirectives?: boolean;
+    /** Also remove license/legal comments. Default: false (kept for safety). */
+    removeLegal?: boolean;
+    /** Extra predicate: return false to leave a comment out of the removal entirely. */
+    shouldRemove?: (comment: Comment) => boolean;
+}
+export interface RemoveResult {
+    /** Source with the removed comments spliced out. */
+    code: string;
+    removed: Comment[];
+    /**
+     * Comments kept because they are protected: directives, license headers,
+     * and comments whose removal would shift code under a next-line directive.
+     */
+    kept: Comment[];
+    /** Comments excluded from removal by the `shouldRemove` predicate. */
+    skipped: Comment[];
+    changed: boolean;
+}
+/**
+ * Removes comments from TypeScript source without touching code.
+ *
+ * Safety properties:
+ * - AST-based ranges: strings, template literals and regexes are never affected.
+ * - Directives (`@ts-expect-error`, `eslint-disable`, ...) and license headers are
+ *   kept by default, since deleting them changes build/lint behaviour.
+ * - A space is inserted where removing a block comment would merge two tokens,
+ *   and a line break is kept where the comment acted as one (ASI stays intact).
+ * - A leading byte-order mark is preserved.
+ * - The result is re-scanned; if the remaining comments do not match the kept
+ *   set, an error is thrown instead of returning corrupted output.
+ */
+export declare function removeComments(source: string, options?: RemoveOptions): RemoveResult;
+//# sourceMappingURL=remove.d.ts.map

package/dist/remove.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.d.ts","sourceRoot":"","sources":["../src/remove.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,wFAAwF;IACxF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,4EAA4E;IAC5E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oFAAoF;IACpF,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB;;;OAGG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,sEAAsE;IACtE,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,YAAY,CAgCxF"}

package/dist/remove.js

@@ -0,0 +1,223 @@
+import { isLegalComment } from "./directives.js";
+import { scanComments } from "./scanner.js";
+/**
+ * Removes comments from TypeScript source without touching code.
+ *
+ * Safety properties:
+ * - AST-based ranges: strings, template literals and regexes are never affected.
+ * - Directives (`@ts-expect-error`, `eslint-disable`, ...) and license headers are
+ *   kept by default, since deleting them changes build/lint behaviour.
+ * - A space is inserted where removing a block comment would merge two tokens,
+ *   and a line break is kept where the comment acted as one (ASI stays intact).
+ * - A leading byte-order mark is preserved.
+ * - The result is re-scanned; if the remaining comments do not match the kept
+ *   set, an error is thrown instead of returning corrupted output.
+ */
+export function removeComments(source, options = {}) {
+    const jsx = options.jsx === true;
+    const bom = source.startsWith("\uFEFF") ? "\uFEFF" : "";
+    const body = bom === "" ? source : source.slice(bom.length);
+    const comments = scanComments(body, { jsx });
+    let removed = [];
+    const kept = [];
+    const skipped = [];
+    for (const comment of comments) {
+        if (options.shouldRemove?.(comment) === false) {
+            skipped.push(comment);
+        }
+        else if (isProtected(comment, options)) {
+            kept.push(comment);
+        }
+        else {
+            removed.push(comment);
+        }
+    }
+    removed = shieldNextLineDirectives(body, removed, kept, skipped);
+    if (removed.length === 0) {
+        return { code: source, removed, kept, skipped, changed: false };
+    }
+    const code = bom + splice(body, removed);
+    if (scanComments(code, { jsx }).length !== kept.length + skipped.length) {
+        throw new Error("comment removal produced an unexpected result; refusing to continue");
+    }
+    return { code, removed, kept, skipped, changed: true };
+}
+function isProtected(comment, options) {
+    if (comment.directive !== undefined && options.removeDirectives !== true)
+        return true;
+    if (isLegalComment(comment.text) && options.removeLegal !== true)
+        return true;
+    return false;
+}
+/**
+ * Re-protects whole-line comments sitting directly below a surviving
+ * next-line directive (`@ts-expect-error`, `eslint-disable-next-line`, ...).
+ * Dropping such a line would shift the following code up, silently changing
+ * which line the directive applies to.
+ */
+function shieldNextLineDirectives(source, removed, kept, skipped) {
+    const shieldedLines = new Set();
+    for (const comment of [...kept, ...skipped]) {
+        if (comment.directive !== undefined && isNextLineDirective(comment.directive)) {
+            // Counted pragmas like `c8 ignore next 3` cover several lines.
+            for (let offset = 1; offset <= shieldedLineCount(comment.text); offset += 1) {
+                shieldedLines.add(comment.endLine + offset);
+            }
+        }
+    }
+    if (shieldedLines.size === 0)
+        return removed;
+    const stillRemoved = [];
+    for (const comment of removed) {
+        if (shieldedLines.has(comment.line) && occupiesWholeLines(source, comment)) {
+            kept.push(comment);
+        }
+        else {
+            stillRemoved.push(comment);
+        }
+    }
+    if (stillRemoved.length !== removed.length) {
+        kept.sort((a, b) => a.start - b.start);
+    }
+    return stillRemoved;
+}
+// File- and range-scoped pragmas (`c8 ignore start`, `istanbul ignore file`,
+// ...) do not target the following line, so they never shield it.
+function isNextLineDirective(name) {
+    return (name.endsWith("-next-line") ||
+        [
+            "@ts-ignore",
+            "@ts-expect-error",
+            "biome-ignore",
+            "deno-lint-ignore",
+            "deno-fmt-ignore",
+            "deno-coverage-ignore",
+            "prettier-ignore",
+            "istanbul-ignore",
+            "istanbul-ignore-next",
+            "istanbul-ignore-if",
+            "istanbul-ignore-else",
+            "c8-ignore",
+            "c8-ignore-next",
+            "v8-ignore",
+            "v8-ignore-next",
+            "node:coverage-ignore",
+        ].includes(name));
+}
+/** Number of following lines a next-line pragma covers (`ignore next 3` → 3). */
+function shieldedLineCount(text) {
+    const match = /\bignore\s+next\s+(\d{1,4})\b/.exec(text);
+    return match ? Math.max(1, Number(match[1])) : 1;
+}
+/** True when nothing but whitespace shares the comment's first and last lines. */
+function occupiesWholeLines(source, comment) {
+    const lineStart = source.lastIndexOf("\n", comment.start - 1) + 1;
+    if (!isBlank(source.slice(lineStart, comment.start)))
+        return false;
+    const newlineIndex = source.indexOf("\n", comment.end);
+    const lineEnd = newlineIndex === -1 ? source.length : newlineIndex;
+    return isBlank(source.slice(comment.end, lineEnd));
+}
+const isBlank = (text) => /^\s*$/.test(text);
+const isHorizontalSpace = (char) => char === " " || char === "\t";
+const LINE_TERMINATOR = /[\n\r\u2028\u2029]/;
+/**
+ * Splices sorted, non-overlapping comment ranges out of the source, tidying lines.
+ * Output is accumulated as segments with incremental line-state tracking, so the
+ * work stays linear in the source size even for comment-dense files.
+ */
+function splice(source, removals) {
+    const segments = [];
+    let cursor = 0;
+    /** Whether the output's current (unterminated) line is all whitespace so far. */
+    let lineIsBlank = true;
+    /** Last character of the output so far ("" while empty). */
+    let lastChar = "";
+    const push = (chunk) => {
+        if (chunk === "")
+            return;
+        segments.push(chunk);
+        const newlineIndex = chunk.lastIndexOf("\n");
+        lineIsBlank = newlineIndex === -1 ? lineIsBlank && isBlank(chunk) : isBlank(chunk.slice(newlineIndex + 1));
+        lastChar = chunk.slice(-1);
+    };
+    /** Deletes everything the output holds after its last line break. */
+    const dropCurrentLine = () => {
+        while (segments.length > 0) {
+            const last = segments[segments.length - 1];
+            const newlineIndex = last.lastIndexOf("\n");
+            if (newlineIndex === -1) {
+                segments.pop();
+                continue;
+            }
+            segments[segments.length - 1] = last.slice(0, newlineIndex + 1);
+            lineIsBlank = true;
+            lastChar = "\n";
+            return;
+        }
+        lineIsBlank = true;
+        lastChar = "";
+    };
+    /** Deletes trailing spaces/tabs of the output's current line. */
+    const trimLineEnd = () => {
+        while (segments.length > 0) {
+            const last = segments[segments.length - 1];
+            let end = last.length;
+            while (end > 0 && isHorizontalSpace(last[end - 1]))
+                end -= 1;
+            if (end === 0) {
+                segments.pop();
+                continue;
+            }
+            if (end < last.length)
+                segments[segments.length - 1] = last.slice(0, end);
+            lastChar = segments[segments.length - 1].slice(-1);
+            return;
+        }
+        lastChar = "";
+    };
+    for (const comment of removals) {
+        push(source.slice(cursor, comment.start));
+        cursor = comment.end;
+        const newlineIndex = source.indexOf("\n", cursor);
+        const lineEnd = newlineIndex === -1 ? source.length : newlineIndex + 1;
+        const rest = source.slice(cursor, lineEnd);
+        const eolLength = rest.endsWith("\r\n") ? 2 : rest.endsWith("\n") ? 1 : 0;
+        const restContent = rest.slice(0, rest.length - eolLength);
+        if (lineIsBlank && isBlank(restContent)) {
+            // The comment occupied whole line(s): drop them entirely.
+            dropCurrentLine();
+            cursor = lineEnd;
+        }
+        else if (isBlank(restContent)) {
+            // Trailing comment after code: trim the gap, keep the line break.
+            trimLineEnd();
+            push(rest.slice(restContent.length));
+            cursor = lineEnd;
+        }
+        else if (!lineIsBlank && LINE_TERMINATOR.test(comment.text)) {
+            // Code on both sides of a block comment that spans lines. Per ECMA-262
+            // such a comment acts as a line terminator for semicolon insertion, so
+            // replace it with a real line break (matching the file's style) instead
+            // of merging the lines.
+            trimLineEnd();
+            push(comment.text.includes("\r\n") ? "\r\n" : "\n");
+        }
+        else {
+            // Inline comment with code after it on the same line.
+            const next = source.charAt(cursor);
+            if (lastChar !== "" && !isBlank(lastChar) && !isBlank(next)) {
+                // `a/* x */b` would merge tokens: keep them apart.
+                push(" ");
+            }
+            else if (lastChar === "" || isBlank(lastChar)) {
+                // Collapse the horizontal whitespace that followed the comment.
+                while (cursor < lineEnd && isHorizontalSpace(source[cursor]))
+                    cursor += 1;
+            }
+        }
+    }
+    segments.push(source.slice(cursor));
+    return segments.join("");
+}
+//# sourceMappingURL=remove.js.map

package/dist/remove.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.js","sourceRoot":"","sources":["../src/remove.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AA2B5C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,UAAyB,EAAE;IACxE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,MAAM,IAAI,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAE7C,IAAI,OAAO,GAAc,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAc,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,OAAO,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAEjE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAClE,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzC,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACzD,CAAC;AAED,SAAS,WAAW,CAAC,OAAgB,EAAE,OAAsB;IAC3D,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,gBAAgB,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACtF,IAAI,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,WAAW,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9E,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB,CAAC,MAAc,EAAE,OAAkB,EAAE,IAAe,EAAE,OAAkB;IACvG,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IACxC,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;QAC5C,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9E,+DAA+D;YAC/D,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC;gBAC5E,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAE7C,MAAM,YAAY,GAAc,EAAE,CAAC;IACnC,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;QAC9B,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;YAC3E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,6EAA6E;AAC7E,kEAAkE;AAClE,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC3B;YACE,YAAY;YACZ,kBAAkB;YAClB,cAAc;YACd,kBAAkB;YAClB,iBAAiB;YACjB,sBAAsB;YACtB,iBAAiB;YACjB,iBAAiB;YACjB,sBAAsB;YACtB,oBAAoB;YACpB,sBAAsB;YACtB,WAAW;YACX,gBAAgB;YAChB,WAAW;YACX,gBAAgB;YAChB,sBAAsB;SACvB,CAAC,QAAQ,CAAC,IAAI,CAAC,CACjB,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,SAAS,iBAAiB,CAAC,IAAY;IACrC,MAAM,KAAK,GAAG,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,kFAAkF;AAClF,SAAS,kBAAkB,CAAC,MAAc,EAAE,OAAgB;IAC1D,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAClE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACnE,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC;IACnE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE9D,MAAM,iBAAiB,GAAG,CAAC,IAAwB,EAAW,EAAE,CAAC,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC;AAE/F,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAE7C;;;;GAIG;AACH,SAAS,MAAM,CAAC,MAAc,EAAE,QAA4B;IAC1D,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,iFAAiF;IACjF,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,4DAA4D;IAC5D,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,MAAM,IAAI,GAAG,CAAC,KAAa,EAAQ,EAAE;QACnC,IAAI,KAAK,KAAK,EAAE;YAAE,OAAO;QACzB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC7C,WAAW,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3G,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,qEAAqE;IACrE,MAAM,eAAe,GAAG,GAAS,EAAE;QACjC,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC;YACrD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxB,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACf,SAAS;YACX,CAAC;YACD,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC;YAChE,WAAW,GAAG,IAAI,CAAC;YACnB,QAAQ,GAAG,IAAI,CAAC;YAChB,OAAO;QACT,CAAC;QACD,WAAW,GAAG,IAAI,CAAC;QACnB,QAAQ,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC;IAEF,iEAAiE;IACjE,MAAM,WAAW,GAAG,GAAS,EAAE;QAC7B,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC;YACrD,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;YACtB,OAAO,GAAG,GAAG,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;gBAAE,GAAG,IAAI,CAAC,CAAC;YAC7D,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;gBACd,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACf,SAAS;YACX,CAAC;YACD,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM;gBAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1E,QAAQ,GAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/D,OAAO;QACT,CAAC;QACD,QAAQ,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;QAErB,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC;QACvE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;QAE3D,IAAI,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACxC,0DAA0D;YAC1D,eAAe,EAAE,CAAC;YAClB,MAAM,GAAG,OAAO,CAAC;QACnB,CAAC;aAAM,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,kEAAkE;YAClE,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACrC,MAAM,GAAG,OAAO,CAAC;QACnB,CAAC;aAAM,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,uEAAuE;YACvE,uEAAuE;YACvE,wEAAwE;YACxE,wBAAwB;YACxB,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,sDAAsD;YACtD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,QAAQ,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5D,mDAAmD;gBACnD,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,CAAC;iBAAM,IAAI,QAAQ,KAAK,EAAE,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAChD,gEAAgE;gBAChE,OAAO,MAAM,GAAG,OAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAAE,MAAM,IAAI,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3B,CAAC"}

package/dist/report.d.ts

@@ -1,4 +1,12 @@
 import type { FileScanResult } from "./types.js";
+/** Formats `3 comments`, `1 file`, ... with naive pluralization. */
+export declare function count(value: number, noun: string): string;
 export declare function formatText(results: FileScanResult[]): string;
 export declare function formatJson(results: FileScanResult[]): string;
+/**
+ * Formats results as GitHub Actions workflow commands so each comment shows up
+ * as an annotation on the corresponding file and line in CI.
+ * See https://docs.github.com/actions/reference/workflow-commands-for-github-actions
+ */
+export declare function formatGitHub(results: FileScanResult[]): string;
 //# sourceMappingURL=report.d.ts.map

package/dist/report.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,wBAAgB,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAkB5D;AAcD,wBAAgB,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAK5D"}
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,cAAc,EAAE,MAAM,YAAY,CAAC;AAE1D,oEAAoE;AACpE,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzD;AAwBD,wBAAgB,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAK5D;AAUD,wBAAgB,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAE9D"}

package/dist/report.js

@@ -1,19 +1,32 @@
-export function formatText(results) {
-    const withComments = results.filter((result) => result.comments.length > 0);
-    if (withComments.length === 0) {
-        return "No comments found.";
-    }
+/** Formats `3 comments`, `1 file`, ... with naive pluralization. */
+export function count(value, noun) {
+    return `${value} ${noun}${value === 1 ? "" : "s"}`;
+}
+function renderComments(results, renderLine) {
     const lines = [];
     let total = 0;
-    for (const { file, comments } of withComments) {
+    let fileCount = 0;
+    for (const { file, comments } of results) {
+        if (comments.length === 0)
+            continue;
+        fileCount += 1;
         for (const comment of comments) {
-            lines.push(`${file}:${comment.line}:${comment.column} [${comment.kind}] ${preview(comment.text)}`);
+            lines.push(renderLine(file, comment));
             total += 1;
         }
     }
-    lines.push("", `${count(total, "comment")} across ${count(withComments.length, "file")}`);
+    if (total === 0) {
+        return "No comments found.";
+    }
+    lines.push("", `${count(total, "comment")} across ${count(fileCount, "file")}`);
     return lines.join("\n");
 }
+export function formatText(results) {
+    return renderComments(results, (file, comment) => {
+        const tag = comment.directive === undefined ? "" : ` [${comment.directive}]`;
+        return `${file}:${comment.line}:${comment.column} [${comment.kind}]${tag} ${preview(comment.text)}`;
+    });
+}
 function preview(text) {
     return text
         .split("\n")
@@ -21,12 +34,33 @@ function preview(text) {
         .join(" ")
         .trim();
 }
-function count(value, noun) {
-    return `${value} ${noun}${value === 1 ? "" : "s"}`;
-}
 export function formatJson(results) {
     const files = results.filter((result) => result.comments.length > 0);
     const comments = files.reduce((sum, file) => sum + file.comments.length, 0);
-    return JSON.stringify({ summary: { files: files.length, comments }, files }, null, 2);
+    const directives = files.reduce((sum, file) => sum + file.comments.filter((comment) => comment.directive !== undefined).length, 0);
+    return JSON.stringify({ summary: { files: files.length, comments, directives }, files }, null, 2);
+}
+/**
+ * Formats results as GitHub Actions workflow commands so each comment shows up
+ * as an annotation on the corresponding file and line in CI.
+ * See https://docs.github.com/actions/reference/workflow-commands-for-github-actions
+ */
+export function formatGitHub(results) {
+    return renderComments(results, annotation);
+}
+function annotation(file, comment) {
+    const title = comment.directive === undefined ? `${comment.kind} comment` : `${comment.kind} comment (${comment.directive})`;
+    const properties = [`file=${escapeProperty(file)}`, `line=${comment.line}`, `endLine=${comment.endLine}`];
+    if (comment.line === comment.endLine) {
+        properties.push(`col=${comment.column}`, `endColumn=${comment.endColumn}`);
+    }
+    properties.push(`title=${escapeProperty(title)}`);
+    return `::notice ${properties.join(",")}::${escapeData(comment.text)}`;
+}
+function escapeData(value) {
+    return value.replaceAll("%", "%25").replaceAll("\r", "%0D").replaceAll("\n", "%0A");
+}
+function escapeProperty(value) {
+    return escapeData(value).replaceAll(":", "%3A").replaceAll(",", "%2C");
 }
 //# sourceMappingURL=report.js.map

package/dist/report.js.map

@@ -1 +1 @@
-{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE5E,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,YAAY,EAAE,CAAC;QAC9C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnG,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,WAAW,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1F,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,IAAI;SACR,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,IAAI,CAAC,GAAG,CAAC;SACT,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,IAAY;IACxC,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE5E,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACxF,CAAC"}
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAEA,oEAAoE;AACpE,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,IAAY;IAC/C,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,cAAc,CAAC,OAAyB,EAAE,UAAsD;IACvG,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,OAAO,EAAE,CAAC;QACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACpC,SAAS,IAAI,CAAC,CAAC;QACf,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;YACtC,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IAED,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,WAAW,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAChF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,GAAG,CAAC;QAC7E,OAAO,GAAG,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,IAAI,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IACtG,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,IAAI;SACR,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,IAAI,CAAC,GAAG,CAAC;SACT,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,MAAM,EAC9F,CAAC,CACF,CAAC;IAEF,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACpG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB;IACpD,OAAO,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,OAAgB;IAChD,MAAM,KAAK,GACT,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,aAAa,OAAO,CAAC,SAAS,GAAG,CAAC;IACjH,MAAM,UAAU,GAAG,CAAC,QAAQ,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,OAAO,CAAC,IAAI,EAAE,EAAE,WAAW,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1G,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,UAAU,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,UAAU,CAAC,IAAI,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClD,OAAO,YAAY,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;AACzE,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACzE,CAAC"}

package/dist/run.d.ts

@@ -2,6 +2,6 @@ export interface CliIO {
     out: (text: string) => void;
     err: (text: string) => void;
 }
-export declare const HELP_TEXT = "Usage: ts-comment-scanner [options] [paths...]\n\nDetect and report comments across a TypeScript project.\n\nOptions:\n  --json         Output results as JSON\n  -v, --version  Print the version number\n  -h, --help     Show this help\n\nPaths default to the current directory. Directories are scanned recursively\nfor .ts, .tsx, .mts and .cts files, skipping node_modules and .git.\n\nExamples:\n  ts-comment-scanner src\n  ts-comment-scanner --json src test\n";
+export declare const HELP_TEXT = "Usage: ts-comment-scanner [options] [paths...]\n\nDetect, report and clean up comments across a TypeScript project.\n\nOutput:\n  --format <fmt>       Output format: text, json or github (default: text)\n  --json               Shorthand for --format json\n\nFiltering:\n  --ignore <glob>      Skip files/directories matching the glob (repeatable)\n  --ext <list>         Comma-separated extensions to scan (default: .ts,.tsx,.mts,.cts)\n  --skip-directives    Hide compiler/linter directives (@ts-ignore, eslint-disable, ...)\n  --only-directives    Report only compiler/linter directives\n\nCI:\n  --fail-on-comment    Exit with code 1 when any comment is reported\n\nRemoval:\n  --remove             Delete the reported comments from the files (in place)\n  --dry-run            With --remove: show what would be removed, change nothing\n  --remove-directives  With --remove: also delete directive comments\n  --remove-legal       With --remove: also delete license/legal comments\n\nGeneral:\n  -h, --help           Show this help\n  -v, --version        Print the version number\n\nPaths default to the current directory. Directories are scanned recursively,\nskipping node_modules and .git. Removal keeps directives and license headers\nunless explicitly requested, so builds and linters keep working.\n\nExit codes: 0 success, 1 comments reported with --fail-on-comment, 2 error.\n\nExamples:\n  ts-comment-scanner src\n  ts-comment-scanner --format github --fail-on-comment src\n  ts-comment-scanner --ignore \"**/*.test.ts\" --skip-directives src\n  ts-comment-scanner --remove --dry-run src\n";
 export declare function run(argv: string[], io: CliIO): Promise<number>;
 //# sourceMappingURL=run.d.ts.map

package/dist/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,SAAS,kdAerB,CAAC;AAEF,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAsBpE"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,SAAS,skDAsCrB,CAAC;AAEF,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CA2CpE"}