@kongyo2/ts-comment-scanner 1.2.1 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +31 -10
- package/README.md +29 -8
- package/dist/directives.d.ts +24 -3
- package/dist/directives.d.ts.map +1 -1
- package/dist/directives.js +313 -29
- package/dist/directives.js.map +1 -1
- package/dist/files.d.ts +34 -0
- package/dist/files.d.ts.map +1 -1
- package/dist/files.js +148 -20
- package/dist/files.js.map +1 -1
- package/dist/git.js +6 -6
- package/dist/git.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/remove.js +154 -29
- package/dist/remove.js.map +1 -1
- package/dist/report.d.ts.map +1 -1
- package/dist/report.js +24 -2
- package/dist/report.js.map +1 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +47 -13
- package/dist/run.js.map +1 -1
- package/dist/scanner.d.ts.map +1 -1
- package/dist/scanner.js +43 -25
- package/dist/scanner.js.map +1 -1
- package/package.json +11 -5
- package/src/args.ts +198 -0
- package/src/cli.ts +12 -0
- package/src/directives.ts +492 -0
- package/src/files.ts +304 -0
- package/src/git.ts +72 -0
- package/src/index.ts +19 -0
- package/src/remove.ts +410 -0
- package/src/report.ts +106 -0
- package/src/run.ts +283 -0
- package/src/scanner.ts +104 -0
- package/src/types.ts +19 -0
- package/src/version.ts +7 -0
package/dist/report.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Buffer } from "node:buffer";
|
|
1
2
|
/** Formats `3 comments`, `1 file`, ... with naive pluralization. */
|
|
2
3
|
export function count(value, noun) {
|
|
3
4
|
return `${value} ${noun}${value === 1 ? "" : "s"}`;
|
|
@@ -54,10 +55,31 @@ function annotation(file, comment) {
|
|
|
54
55
|
const title = comment.directive === undefined ? `${comment.kind} comment` : `${comment.kind} comment (${comment.directive})`;
|
|
55
56
|
const properties = [`file=${escapeProperty(file)}`, `line=${comment.line}`, `endLine=${comment.endLine}`];
|
|
56
57
|
if (comment.line === comment.endLine) {
|
|
57
|
-
|
|
58
|
+
// The scanner's endColumn is exclusive, GitHub's annotation columns are
|
|
59
|
+
// inclusive (a 6-character token at columns 5–10 is reported end_column
|
|
60
|
+
// 10 by the Checks API), so the last covered column is endColumn - 1.
|
|
61
|
+
properties.push(`col=${comment.column}`, `endColumn=${comment.endColumn - 1}`);
|
|
58
62
|
}
|
|
59
63
|
properties.push(`title=${escapeProperty(title)}`);
|
|
60
|
-
return `::notice ${properties.join(",")}::${escapeData(comment.text)}`;
|
|
64
|
+
return `::notice ${properties.join(",")}::${escapeData(truncateAnnotationMessage(comment.text))}`;
|
|
65
|
+
}
|
|
66
|
+
// GitHub rejects annotation messages over 64 KiB; truncate on a code-point
|
|
67
|
+
// boundary with room to spare so huge comments still annotate.
|
|
68
|
+
const MAX_ANNOTATION_MESSAGE_BYTES = 60_000;
|
|
69
|
+
const TRUNCATION_SUFFIX = "… (truncated)";
|
|
70
|
+
function truncateAnnotationMessage(text) {
|
|
71
|
+
if (Buffer.byteLength(text, "utf8") <= MAX_ANNOTATION_MESSAGE_BYTES)
|
|
72
|
+
return text;
|
|
73
|
+
let bytes = 0;
|
|
74
|
+
let end = 0;
|
|
75
|
+
for (const char of text) {
|
|
76
|
+
const size = Buffer.byteLength(char, "utf8");
|
|
77
|
+
if (bytes + size > MAX_ANNOTATION_MESSAGE_BYTES)
|
|
78
|
+
break;
|
|
79
|
+
bytes += size;
|
|
80
|
+
end += char.length;
|
|
81
|
+
}
|
|
82
|
+
return `${text.slice(0, end)}${TRUNCATION_SUFFIX}`;
|
|
61
83
|
}
|
|
62
84
|
function escapeData(value) {
|
|
63
85
|
return value.replaceAll("%", "%25").replaceAll("\r", "%0D").replaceAll("\n", "%0A");
|
package/dist/report.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,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,uEAAuE;IACvE,0EAA0E;IAC1E,OAAO,IAAI;SACR,KAAK,CAAC,yBAAyB,CAAC;SAChC,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,wEAAwE;QACxE,wEAAwE;QACxE,sEAAsE;QACtE,UAAU,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,OAAO,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC;IACjF,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,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;AACpG,CAAC;AAED,2EAA2E;AAC3E,+DAA+D;AAC/D,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAC5C,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,SAAS,yBAAyB,CAAC,IAAY;IAC7C,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,4BAA4B;QAAE,OAAO,IAAI,CAAC;IACjF,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC7C,IAAI,KAAK,GAAG,IAAI,GAAG,4BAA4B;YAAE,MAAM;QACvD,KAAK,IAAI,IAAI,CAAC;QACd,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,iBAAiB,EAAE,CAAC;AACrD,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.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAqBA,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,o+DA6CrB,CAAC;AAEF,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAmDpE"}
|
package/dist/run.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { realpathSync } from "node:fs";
|
|
2
|
-
import {
|
|
2
|
+
import { stat } from "node:fs/promises";
|
|
3
3
|
import { basename, dirname, join, resolve } from "node:path";
|
|
4
4
|
import { parseArgs, UsageError } from "./args.js";
|
|
5
|
-
import { collectFiles, isJsxFile, mapLimit, scanFile, FILE_CONCURRENCY } from "./files.js";
|
|
5
|
+
import { collectFiles, encodeFileText, isJsxFile, mapLimit, readFileText, scanFile, writeFileAtomic, FILE_CONCURRENCY, } from "./files.js";
|
|
6
6
|
import { changedFiles } from "./git.js";
|
|
7
7
|
import { removeComments } from "./remove.js";
|
|
8
8
|
import { count, formatGitHub, formatJson, formatText } from "./report.js";
|
|
@@ -70,6 +70,12 @@ export async function run(argv, io) {
|
|
|
70
70
|
}
|
|
71
71
|
throw error;
|
|
72
72
|
}
|
|
73
|
+
// A -h/--help the early scan above could not see (e.g. consumed-looking
|
|
74
|
+
// spots like `--ignore -- --help`) still means help once parsed as a flag.
|
|
75
|
+
if (options.help) {
|
|
76
|
+
io.out(HELP_TEXT);
|
|
77
|
+
return 0;
|
|
78
|
+
}
|
|
73
79
|
try {
|
|
74
80
|
if (options.version) {
|
|
75
81
|
io.out(`${await getVersion()}\n`);
|
|
@@ -106,11 +112,19 @@ async function collectTargets(options, collectOptions) {
|
|
|
106
112
|
return files;
|
|
107
113
|
const first = resolve(options.paths[0]);
|
|
108
114
|
const anchor = (await stat(first)).isDirectory() ? first : dirname(first);
|
|
109
|
-
const changed = new Set(await changedFiles(options.diff, anchor));
|
|
115
|
+
const changed = new Set((await changedFiles(options.diff, anchor)).map(caseFold));
|
|
110
116
|
// Realpath only the directory part: spellings through symlinked directories
|
|
111
117
|
// then compare equal, while a tracked symlink still matches the path git
|
|
112
118
|
// reports it at instead of dereferencing to its target.
|
|
113
|
-
return files.filter((file) => changed.has(join(realpathSync(dirname(file)), basename(file))));
|
|
119
|
+
return files.filter((file) => changed.has(caseFold(join(realpathSync(dirname(file)), basename(file)))));
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Windows paths are case-insensitive, but git reports the case a file was
|
|
123
|
+
* tracked with; folding both sides keeps `Foo.ts` in the --diff scope when
|
|
124
|
+
* the scan found it as `foo.ts`.
|
|
125
|
+
*/
|
|
126
|
+
function caseFold(path) {
|
|
127
|
+
return process.platform === "win32" ? path.toLowerCase() : path;
|
|
114
128
|
}
|
|
115
129
|
/** True when -h/--help appears before any `--` separator. */
|
|
116
130
|
function wantsHelp(argv) {
|
|
@@ -148,17 +162,26 @@ async function runRemove(options, collectOptions, io) {
|
|
|
148
162
|
const files = await collectTargets(options, collectOptions);
|
|
149
163
|
const outcomes = await mapLimit(files, FILE_CONCURRENCY, async (file) => {
|
|
150
164
|
try {
|
|
151
|
-
const
|
|
152
|
-
const result = removeComments(
|
|
165
|
+
const { text, encoding, bom, lossless } = await readFileText(file);
|
|
166
|
+
const result = removeComments(text, {
|
|
153
167
|
jsx: isJsxFile(file),
|
|
154
168
|
removeDirectives: options.removeDirectives,
|
|
155
169
|
removeLegal: options.removeLegal,
|
|
156
170
|
shouldRemove: (comment) => inScope(comment, options.directives),
|
|
157
171
|
});
|
|
158
|
-
if (result.changed
|
|
159
|
-
|
|
172
|
+
if (result.changed) {
|
|
173
|
+
if (!lossless) {
|
|
174
|
+
// Re-encoding would not reproduce the original bytes (invalid
|
|
175
|
+
// UTF-8, truncated UTF-16, ...): rewriting the file would corrupt
|
|
176
|
+
// content outside the comments. Reported for --dry-run too, so the
|
|
177
|
+
// preflight fails the same way the real removal would.
|
|
178
|
+
throw new Error("file is not valid UTF-8 or UTF-16; refusing to modify it");
|
|
179
|
+
}
|
|
180
|
+
if (!options.dryRun) {
|
|
181
|
+
await writeFileAtomic(file, encodeFileText(result.code, { encoding, bom }));
|
|
182
|
+
}
|
|
160
183
|
}
|
|
161
|
-
return { file, removed: result.removed, kept: result.kept };
|
|
184
|
+
return { file, removed: result.removed, kept: result.kept, skipped: result.skipped };
|
|
162
185
|
}
|
|
163
186
|
catch (error) {
|
|
164
187
|
const message = error instanceof Error ? error.message : String(error);
|
|
@@ -171,7 +194,7 @@ async function runRemove(options, collectOptions, io) {
|
|
|
171
194
|
if ("failure" in outcome) {
|
|
172
195
|
failures.push(outcome.failure);
|
|
173
196
|
}
|
|
174
|
-
else if (outcome.removed.length > 0 || outcome.kept.length > 0) {
|
|
197
|
+
else if (outcome.removed.length > 0 || outcome.kept.length > 0 || outcome.skipped.length > 0) {
|
|
175
198
|
removals.push(outcome);
|
|
176
199
|
}
|
|
177
200
|
}
|
|
@@ -184,16 +207,27 @@ async function runRemove(options, collectOptions, io) {
|
|
|
184
207
|
function renderRemoval(removals, options) {
|
|
185
208
|
const totalRemoved = removals.reduce((sum, entry) => sum + entry.removed.length, 0);
|
|
186
209
|
const totalKept = removals.reduce((sum, entry) => sum + entry.kept.length, 0);
|
|
210
|
+
const totalSkipped = removals.reduce((sum, entry) => sum + entry.skipped.length, 0);
|
|
187
211
|
const changedEntries = removals.filter((entry) => entry.removed.length > 0);
|
|
188
212
|
const keptNote = totalKept > 0 ? ` Kept ${count(totalKept, "protected comment")}.` : "";
|
|
213
|
+
// Directives held back by --skip-directives are invisible in the removal
|
|
214
|
+
// counts; say how many were left untouched so "removed N" is not mistaken
|
|
215
|
+
// for "the files are now comment-free".
|
|
216
|
+
const skippedNote = totalSkipped > 0 ? ` Skipped ${count(totalSkipped, "comment")} (--skip-directives).` : "";
|
|
189
217
|
if (options.format === "json") {
|
|
190
218
|
return JSON.stringify({
|
|
191
|
-
summary: {
|
|
219
|
+
summary: {
|
|
220
|
+
files: changedEntries.length,
|
|
221
|
+
removed: totalRemoved,
|
|
222
|
+
kept: totalKept,
|
|
223
|
+
skipped: totalSkipped,
|
|
224
|
+
dryRun: options.dryRun,
|
|
225
|
+
},
|
|
192
226
|
files: removals,
|
|
193
227
|
}, null, 2);
|
|
194
228
|
}
|
|
195
229
|
if (totalRemoved === 0) {
|
|
196
|
-
return `No removable comments found.${keptNote}`;
|
|
230
|
+
return `No removable comments found.${keptNote}${skippedNote}`;
|
|
197
231
|
}
|
|
198
232
|
const verb = options.dryRun ? "would remove" : "removed";
|
|
199
233
|
const lines = changedEntries.map((entry) => {
|
|
@@ -201,7 +235,7 @@ function renderRemoval(removals, options) {
|
|
|
201
235
|
return `${entry.file}: ${verb} ${entry.removed.length}${kept}`;
|
|
202
236
|
});
|
|
203
237
|
const sentenceVerb = verb.charAt(0).toUpperCase() + verb.slice(1);
|
|
204
|
-
lines.push("", `${sentenceVerb} ${count(totalRemoved, "comment")} across ${count(changedEntries.length, "file")}.${keptNote}`);
|
|
238
|
+
lines.push("", `${sentenceVerb} ${count(totalRemoved, "comment")} across ${count(changedEntries.length, "file")}.${keptNote}${skippedNote}`);
|
|
205
239
|
return lines.join("\n");
|
|
206
240
|
}
|
|
207
241
|
//# sourceMappingURL=run.js.map
|
package/dist/run.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAuC,MAAM,WAAW,CAAC;AACvF,OAAO,EACL,YAAY,EACZ,cAAc,EACd,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,eAAe,EACf,gBAAgB,GAEjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,CAAC,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6CxB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,IAAc,EAAE,EAAS;IACjD,+DAA+D;IAC/D,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,OAAmB,CAAC;IACxB,IAAI,CAAC;QACH,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,EAAE,CAAC,GAAG,CAAC,uBAAuB,KAAK,CAAC,OAAO,gDAAgD,CAAC,CAAC;YAC7F,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,wEAAwE;IACxE,2EAA2E;IAC3E,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,UAAU,EAAE,IAAI,CAAC,CAAC;YAClC,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,cAAc,GAAmB;YACrC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;SAChF,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,MAAM,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACxG,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE/C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/E,OAAO,OAAO,CAAC,aAAa,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,EAAE,CAAC,GAAG,CAAC,uBAAuB,OAAO,IAAI,CAAC,CAAC;QAC3C,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,cAAc,CAAC,OAAmB,EAAE,cAA8B;IAC/E,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAChE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAE7C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAW,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,4EAA4E;IAC5E,yEAAyE;IACzE,wDAAwD;IACxD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1G,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAED,6DAA6D;AAC7D,SAAS,SAAS,CAAC,IAAc;IAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAC/B,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,MAAM,CAAC,OAAyB,EAAE,MAA4B;IACrE,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;IAClD,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;IACtD,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,OAAO,CAAC,OAAgB,EAAE,IAAmB;IACpD,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC;IAC5D,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC;IAC5D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAyB,EAAE,IAAmB;IACtE,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IACvC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACtE,CAAC,CAAC,CAAC;AACN,CAAC;AASD,KAAK,UAAU,SAAS,CAAC,OAAmB,EAAE,cAA8B,EAAE,EAAS;IACrF,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAE5D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtE,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE;gBAClC,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC;gBACpB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;gBAC1C,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;aAChE,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,8DAA8D;oBAC9D,kEAAkE;oBAClE,mEAAmE;oBACnE,uDAAuD;oBACvD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;gBAC9E,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACpB,MAAM,eAAe,CAAC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACvF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,KAAK,OAAO,EAAE,EAAE,CAAC;QAClD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAkB,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/F,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,EAAE,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,EAAE,CAAC,GAAG,CAAC,uBAAuB,OAAO,IAAI,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,aAAa,CAAC,QAAuB,EAAE,OAAmB;IACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACpF,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC9E,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACpF,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACxF,yEAAyE;IACzE,0EAA0E;IAC1E,wCAAwC;IACxC,MAAM,WAAW,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;IAE9G,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,SAAS,CACnB;YACE,OAAO,EAAE;gBACP,KAAK,EAAE,cAAc,CAAC,MAAM;gBAC5B,OAAO,EAAE,YAAY;gBACrB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,YAAY;gBACrB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB;YACD,KAAK,EAAE,QAAQ;SAChB,EACD,IAAI,EACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,+BAA+B,QAAQ,GAAG,WAAW,EAAE,CAAC;IACjE,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClE,KAAK,CAAC,IAAI,CACR,EAAE,EACF,GAAG,YAAY,IAAI,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,WAAW,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,QAAQ,GAAG,WAAW,EAAE,CAC7H,CAAC;IACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}
|
package/dist/scanner.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scanner.d.ts","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAe,MAAM,YAAY,CAAC;AAEvD,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,EAAE,CA+
|
|
1
|
+
{"version":3,"file":"scanner.d.ts","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAe,MAAM,YAAY,CAAC;AAEvD,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,EAAE,CA+FjF"}
|
package/dist/scanner.js
CHANGED
|
@@ -18,7 +18,12 @@ export function scanComments(source, options = {}) {
|
|
|
18
18
|
ranges.push(range);
|
|
19
19
|
}
|
|
20
20
|
};
|
|
21
|
-
|
|
21
|
+
// Iterative depth-first walk: generated or minified sources nest thousands
|
|
22
|
+
// of expressions deep, where a recursive visitor overflows the call stack
|
|
23
|
+
// even though the parse itself succeeded.
|
|
24
|
+
const pending = [sourceFile];
|
|
25
|
+
while (pending.length > 0) {
|
|
26
|
+
const node = pending.pop();
|
|
22
27
|
// JSDoc nodes start inside the comment text itself; descending into them
|
|
23
28
|
// would hide the comment (e.g. a trailing JSDoc attached to the
|
|
24
29
|
// end-of-file token). Treat them as trivia like any other comment.
|
|
@@ -29,38 +34,51 @@ export function scanComments(source, options = {}) {
|
|
|
29
34
|
}
|
|
30
35
|
collect(ts.getLeadingCommentRanges(source, node.getFullStart()));
|
|
31
36
|
collect(ts.getTrailingCommentRanges(source, node.getEnd()));
|
|
32
|
-
|
|
37
|
+
continue;
|
|
33
38
|
}
|
|
34
|
-
for (
|
|
35
|
-
|
|
39
|
+
for (let index = children.length - 1; index >= 0; index -= 1) {
|
|
40
|
+
pending.push(children[index]);
|
|
36
41
|
}
|
|
42
|
+
}
|
|
43
|
+
// JsxText spans never overlap, so a position is inside one exactly when it
|
|
44
|
+
// is inside the closest span starting at or before it — found by binary
|
|
45
|
+
// search, keeping comment-dense TSX files out of quadratic time.
|
|
46
|
+
jsxTextSpans.sort((a, b) => a[0] - b[0]);
|
|
47
|
+
const insideJsxText = (pos) => {
|
|
48
|
+
let low = 0;
|
|
49
|
+
let high = jsxTextSpans.length - 1;
|
|
50
|
+
let candidate = -1;
|
|
51
|
+
while (low <= high) {
|
|
52
|
+
const middle = (low + high) >> 1;
|
|
53
|
+
if (jsxTextSpans[middle][0] <= pos) {
|
|
54
|
+
candidate = middle;
|
|
55
|
+
low = middle + 1;
|
|
56
|
+
}
|
|
57
|
+
else {
|
|
58
|
+
high = middle - 1;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
return candidate >= 0 && pos < jsxTextSpans[candidate][1];
|
|
37
62
|
};
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
//
|
|
41
|
-
//
|
|
42
|
-
//
|
|
43
|
-
// Coverage file pragmas (`istanbul ignore file`, `c8/v8 ignore file`) are
|
|
44
|
-
// NOT gated: istanbul-lib-instrument and Vitest's v8 provider
|
|
45
|
-
// (ast-v8-to-istanbul) honour them on any comment in the file.
|
|
63
|
+
const sorted = ranges.filter((range) => !insideJsxText(range.pos)).sort((a, b) => a.pos - b.pos);
|
|
64
|
+
// Directive rules with positional requirements (header pragmas, prettier's
|
|
65
|
+
// first-comment docblock, Bun's file-start marker) get the comment's actual
|
|
66
|
+
// placement; a shebang does not count as content before the first comment,
|
|
67
|
+
// matching jest-docblock.
|
|
46
68
|
const firstTokenStart = sourceFile.getStart(sourceFile);
|
|
47
|
-
const
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
return
|
|
55
|
-
.filter((range) => !insideJsxText(range.pos))
|
|
56
|
-
.sort((a, b) => a.pos - b.pos)
|
|
57
|
-
.map((range) => {
|
|
69
|
+
const shebangEnd = ts.getShebang(source)?.length ?? 0;
|
|
70
|
+
const firstCommentPos = sorted.length > 0 ? sorted[0].pos : -1;
|
|
71
|
+
const placementOf = (pos) => ({
|
|
72
|
+
header: pos < firstTokenStart,
|
|
73
|
+
firstComment: pos === firstCommentPos && /^\s*$/.test(source.slice(shebangEnd, pos)),
|
|
74
|
+
fileStart: pos === 0,
|
|
75
|
+
});
|
|
76
|
+
return sorted.map((range) => {
|
|
58
77
|
const kind = range.kind === ts.SyntaxKind.SingleLineCommentTrivia ? "line" : "block";
|
|
59
78
|
const text = source.slice(range.pos, range.end);
|
|
60
79
|
const startPosition = sourceFile.getLineAndCharacterOfPosition(range.pos);
|
|
61
80
|
const endPosition = sourceFile.getLineAndCharacterOfPosition(range.end);
|
|
62
|
-
const
|
|
63
|
-
const directive = detected !== undefined && isActiveDirective(detected, range.pos) ? detected : undefined;
|
|
81
|
+
const directive = detectDirective(kind, text, placementOf(range.pos));
|
|
64
82
|
return {
|
|
65
83
|
kind,
|
|
66
84
|
text,
|
package/dist/scanner.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,eAAe,EAA2B,MAAM,iBAAiB,CAAC;AAO3E,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,UAAuB,EAAE;IACpE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC;IACjC,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC;IAClD,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;IAC9D,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAEnG,MAAM,YAAY,GAA4B,EAAE,CAAC;IACjD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,MAAM,OAAO,GAAG,CAAC,KAA6C,EAAQ,EAAE;QACtE,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;gBAAE,SAAS;YAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC;IAEF,2EAA2E;IAC3E,0EAA0E;IAC1E,0CAA0C;IAC1C,MAAM,OAAO,GAAc,CAAC,UAAU,CAAC,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAa,CAAC;QACtC,yEAAyE;QACzE,gEAAgE;QAChE,mEAAmE;QACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACpF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBACxC,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,CAAC,EAAE,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;YACjE,OAAO,CAAC,EAAE,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC5D,SAAS;QACX,CAAC;QACD,KAAK,IAAI,KAAK,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAY,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,wEAAwE;IACxE,iEAAiE;IACjE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAW,EAAE;QAC7C,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,IAAI,IAAI,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;QACnC,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC;QACnB,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,IAAK,YAAY,CAAC,MAAM,CAAsB,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;gBACzD,SAAS,GAAG,MAAM,CAAC;gBACnB,GAAG,GAAG,MAAM,GAAG,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QACD,OAAO,SAAS,IAAI,CAAC,IAAI,GAAG,GAAI,YAAY,CAAC,SAAS,CAAsB,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAEjG,2EAA2E;IAC3E,4EAA4E;IAC5E,2EAA2E;IAC3E,0BAA0B;IAC1B,MAAM,eAAe,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;IACtD,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAE,MAAM,CAAC,CAAC,CAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,MAAM,WAAW,GAAG,CAAC,GAAW,EAAsB,EAAE,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,GAAG,eAAe;QAC7B,YAAY,EAAE,GAAG,KAAK,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACpF,SAAS,EAAE,GAAG,KAAK,CAAC;KACrB,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,MAAM,IAAI,GAAgB,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;QAClG,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,MAAM,aAAa,GAAG,UAAU,CAAC,6BAA6B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,UAAU,CAAC,6BAA6B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,KAAK,EAAE,KAAK,CAAC,GAAG;YAChB,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,IAAI,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC;YAC5B,MAAM,EAAE,aAAa,CAAC,SAAS,GAAG,CAAC;YACnC,OAAO,EAAE,WAAW,CAAC,IAAI,GAAG,CAAC;YAC7B,SAAS,EAAE,WAAW,CAAC,SAAS,GAAG,CAAC;YACpC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;SAClD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kongyo2/ts-comment-scanner",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "CLI to detect, report and safely remove comments across a TypeScript project.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
],
|
|
18
18
|
"license": "MIT",
|
|
19
19
|
"author": "kongyo2",
|
|
20
|
+
"homepage": "https://kongyo2.github.io/ts-comment-scanner/",
|
|
20
21
|
"repository": {
|
|
21
22
|
"type": "git",
|
|
22
23
|
"url": "git+https://github.com/kongyo2/ts-comment-scanner.git"
|
|
@@ -39,22 +40,26 @@
|
|
|
39
40
|
},
|
|
40
41
|
"sideEffects": false,
|
|
41
42
|
"files": [
|
|
42
|
-
"dist"
|
|
43
|
+
"dist",
|
|
44
|
+
"src",
|
|
45
|
+
"!src/*.test.ts"
|
|
43
46
|
],
|
|
44
47
|
"scripts": {
|
|
45
|
-
"
|
|
48
|
+
"clean": "node --eval \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
|
|
49
|
+
"build": "npm run clean && tsc",
|
|
46
50
|
"build:watch": "tsc --watch",
|
|
47
|
-
"typecheck": "tsc --noEmit",
|
|
51
|
+
"typecheck": "tsc --noEmit && tsc -p tsconfig.tests.json",
|
|
48
52
|
"typecheck:watch": "tsc --noEmit --watch",
|
|
49
53
|
"start": "node dist/cli.js",
|
|
50
54
|
"test": "vitest run",
|
|
55
|
+
"test:coverage": "vitest run --coverage",
|
|
51
56
|
"test:watch": "vitest",
|
|
52
57
|
"lint": "oxlint --format agent",
|
|
53
58
|
"lint:fix": "oxlint --fix",
|
|
54
59
|
"lint:strict": "oxlint --deny-warnings",
|
|
55
60
|
"format": "prettier --write .",
|
|
56
61
|
"format:check": "prettier --check .",
|
|
57
|
-
"
|
|
62
|
+
"prepare": "npm run build"
|
|
58
63
|
},
|
|
59
64
|
"publishConfig": {
|
|
60
65
|
"access": "public"
|
|
@@ -66,6 +71,7 @@
|
|
|
66
71
|
"devDependencies": {
|
|
67
72
|
"@types/node": "^25.9.3",
|
|
68
73
|
"@types/picomatch": "^4.0.3",
|
|
74
|
+
"@vitest/coverage-v8": "^4.1.10",
|
|
69
75
|
"oxlint": "^1.70.0",
|
|
70
76
|
"prettier": "^3.8.4",
|
|
71
77
|
"vitest": "^4.1.9"
|
package/src/args.ts
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
export type OutputFormat = "text" | "json" | "github";
|
|
2
|
+
export type DirectiveMode = "include" | "skip" | "only";
|
|
3
|
+
|
|
4
|
+
export interface CliOptions {
|
|
5
|
+
paths: string[];
|
|
6
|
+
format: OutputFormat;
|
|
7
|
+
ignore: string[];
|
|
8
|
+
extensions: string[] | undefined;
|
|
9
|
+
diff: string | undefined;
|
|
10
|
+
directives: DirectiveMode;
|
|
11
|
+
failOnComment: boolean;
|
|
12
|
+
remove: boolean;
|
|
13
|
+
removeDirectives: boolean;
|
|
14
|
+
removeLegal: boolean;
|
|
15
|
+
dryRun: boolean;
|
|
16
|
+
help: boolean;
|
|
17
|
+
version: boolean;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/** Invalid command line input; the CLI reports the message and exits with code 2. */
|
|
21
|
+
export class UsageError extends Error {
|
|
22
|
+
constructor(message: string) {
|
|
23
|
+
super(message);
|
|
24
|
+
this.name = "UsageError";
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const FORMATS: readonly OutputFormat[] = ["text", "json", "github"];
|
|
29
|
+
const DIRECTIVE_CONFLICT = "--skip-directives and --only-directives cannot be combined";
|
|
30
|
+
|
|
31
|
+
export function parseArgs(argv: string[]): CliOptions {
|
|
32
|
+
const paths: string[] = [];
|
|
33
|
+
const ignore: string[] = [];
|
|
34
|
+
const extensions: string[] = [];
|
|
35
|
+
let format: OutputFormat = "text";
|
|
36
|
+
let diff: string | undefined;
|
|
37
|
+
let directives: DirectiveMode = "include";
|
|
38
|
+
let failOnComment = false;
|
|
39
|
+
let remove = false;
|
|
40
|
+
let removeDirectives = false;
|
|
41
|
+
let removeLegal = false;
|
|
42
|
+
let dryRun = false;
|
|
43
|
+
let help = false;
|
|
44
|
+
let version = false;
|
|
45
|
+
let pathsOnly = false;
|
|
46
|
+
|
|
47
|
+
for (let index = 0; index < argv.length; index += 1) {
|
|
48
|
+
const arg = argv[index] as string;
|
|
49
|
+
|
|
50
|
+
if (pathsOnly || !arg.startsWith("-") || arg === "-") {
|
|
51
|
+
paths.push(arg);
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const [flag, inlineValue] = splitFlag(arg);
|
|
56
|
+
const readValue = (): string => {
|
|
57
|
+
if (inlineValue !== undefined) return inlineValue;
|
|
58
|
+
const next = argv[index + 1];
|
|
59
|
+
if (next === undefined) throw new UsageError(`option ${flag} requires a value`);
|
|
60
|
+
index += 1;
|
|
61
|
+
return next;
|
|
62
|
+
};
|
|
63
|
+
const rejectValue = (): void => {
|
|
64
|
+
if (inlineValue !== undefined) throw new UsageError(`option ${flag} does not take a value`);
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
switch (flag) {
|
|
68
|
+
case "--":
|
|
69
|
+
rejectValue();
|
|
70
|
+
pathsOnly = true;
|
|
71
|
+
break;
|
|
72
|
+
case "--format": {
|
|
73
|
+
const value = readValue();
|
|
74
|
+
if (!FORMATS.includes(value as OutputFormat)) {
|
|
75
|
+
throw new UsageError(`unknown format: ${value} (expected ${FORMATS.join(", ")})`);
|
|
76
|
+
}
|
|
77
|
+
format = value as OutputFormat;
|
|
78
|
+
break;
|
|
79
|
+
}
|
|
80
|
+
case "--json":
|
|
81
|
+
rejectValue();
|
|
82
|
+
format = "json";
|
|
83
|
+
break;
|
|
84
|
+
case "--ignore":
|
|
85
|
+
ignore.push(readValue());
|
|
86
|
+
break;
|
|
87
|
+
case "--ext": {
|
|
88
|
+
const parsed = readValue()
|
|
89
|
+
.split(",")
|
|
90
|
+
.map((extension) => extension.trim())
|
|
91
|
+
.filter((extension) => extension !== "");
|
|
92
|
+
if (parsed.length === 0) {
|
|
93
|
+
throw new UsageError("option --ext requires at least one extension");
|
|
94
|
+
}
|
|
95
|
+
extensions.push(...parsed);
|
|
96
|
+
break;
|
|
97
|
+
}
|
|
98
|
+
case "--diff": {
|
|
99
|
+
const value = readValue();
|
|
100
|
+
if (value === "" || value.startsWith("-")) {
|
|
101
|
+
throw new UsageError("option --diff requires a git revision range (e.g. HEAD or main..HEAD)");
|
|
102
|
+
}
|
|
103
|
+
diff = value;
|
|
104
|
+
break;
|
|
105
|
+
}
|
|
106
|
+
case "--skip-directives":
|
|
107
|
+
rejectValue();
|
|
108
|
+
if (directives === "only") throw new UsageError(DIRECTIVE_CONFLICT);
|
|
109
|
+
directives = "skip";
|
|
110
|
+
break;
|
|
111
|
+
case "--only-directives":
|
|
112
|
+
rejectValue();
|
|
113
|
+
if (directives === "skip") throw new UsageError(DIRECTIVE_CONFLICT);
|
|
114
|
+
directives = "only";
|
|
115
|
+
break;
|
|
116
|
+
case "--fail-on-comment":
|
|
117
|
+
rejectValue();
|
|
118
|
+
failOnComment = true;
|
|
119
|
+
break;
|
|
120
|
+
case "--remove":
|
|
121
|
+
rejectValue();
|
|
122
|
+
remove = true;
|
|
123
|
+
break;
|
|
124
|
+
case "--remove-directives":
|
|
125
|
+
rejectValue();
|
|
126
|
+
removeDirectives = true;
|
|
127
|
+
break;
|
|
128
|
+
case "--remove-legal":
|
|
129
|
+
rejectValue();
|
|
130
|
+
removeLegal = true;
|
|
131
|
+
break;
|
|
132
|
+
case "--dry-run":
|
|
133
|
+
rejectValue();
|
|
134
|
+
dryRun = true;
|
|
135
|
+
break;
|
|
136
|
+
case "-h":
|
|
137
|
+
case "--help":
|
|
138
|
+
rejectValue();
|
|
139
|
+
help = true;
|
|
140
|
+
break;
|
|
141
|
+
case "-v":
|
|
142
|
+
case "--version":
|
|
143
|
+
rejectValue();
|
|
144
|
+
version = true;
|
|
145
|
+
break;
|
|
146
|
+
default:
|
|
147
|
+
throw new UsageError(`unknown option: ${flag}`);
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
if (!remove) {
|
|
152
|
+
for (const [set, flag] of [
|
|
153
|
+
[dryRun, "--dry-run"],
|
|
154
|
+
[removeDirectives, "--remove-directives"],
|
|
155
|
+
[removeLegal, "--remove-legal"],
|
|
156
|
+
] as const) {
|
|
157
|
+
if (set) throw new UsageError(`${flag} requires --remove`);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
if (remove && failOnComment) {
|
|
161
|
+
throw new UsageError("--fail-on-comment cannot be combined with --remove");
|
|
162
|
+
}
|
|
163
|
+
if (remove && format === "github") {
|
|
164
|
+
throw new UsageError("--format github cannot be combined with --remove");
|
|
165
|
+
}
|
|
166
|
+
if (remove && directives === "only" && !removeDirectives) {
|
|
167
|
+
throw new UsageError(
|
|
168
|
+
"--remove --only-directives would remove nothing; add --remove-directives to delete directives",
|
|
169
|
+
);
|
|
170
|
+
}
|
|
171
|
+
if (remove && directives === "skip" && removeDirectives) {
|
|
172
|
+
throw new UsageError("--remove-directives cannot be combined with --skip-directives");
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
return {
|
|
176
|
+
paths: paths.length > 0 ? paths : ["."],
|
|
177
|
+
format,
|
|
178
|
+
ignore,
|
|
179
|
+
extensions: extensions.length > 0 ? extensions : undefined,
|
|
180
|
+
diff,
|
|
181
|
+
directives,
|
|
182
|
+
failOnComment,
|
|
183
|
+
remove,
|
|
184
|
+
removeDirectives,
|
|
185
|
+
removeLegal,
|
|
186
|
+
dryRun,
|
|
187
|
+
help,
|
|
188
|
+
version,
|
|
189
|
+
};
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
function splitFlag(arg: string): [string, string | undefined] {
|
|
193
|
+
const equalsIndex = arg.indexOf("=");
|
|
194
|
+
if (arg.startsWith("--") && equalsIndex > 2) {
|
|
195
|
+
return [arg.slice(0, equalsIndex), arg.slice(equalsIndex + 1)];
|
|
196
|
+
}
|
|
197
|
+
return [arg, undefined];
|
|
198
|
+
}
|
package/src/cli.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import process from "node:process";
|
|
3
|
+
import { run } from "./run.js";
|
|
4
|
+
|
|
5
|
+
process.exitCode = await run(process.argv.slice(2), {
|
|
6
|
+
out: (text) => {
|
|
7
|
+
process.stdout.write(text);
|
|
8
|
+
},
|
|
9
|
+
err: (text) => {
|
|
10
|
+
process.stderr.write(text);
|
|
11
|
+
},
|
|
12
|
+
});
|