@kongyo2/ts-comment-scanner 1.10.0 → 1.11.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.md +261 -21
- package/dist/args.d.ts +2 -0
- package/dist/args.d.ts.map +1 -1
- package/dist/args.js +25 -0
- package/dist/args.js.map +1 -1
- package/dist/directives.d.ts +41 -14
- package/dist/directives.d.ts.map +1 -1
- package/dist/directives.js +103 -32
- package/dist/directives.js.map +1 -1
- package/dist/remove.d.ts +10 -1
- package/dist/remove.d.ts.map +1 -1
- package/dist/remove.js +65 -10
- package/dist/remove.js.map +1 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +5 -1
- package/dist/run.js.map +1 -1
- package/dist/scanner.d.ts +11 -0
- package/dist/scanner.d.ts.map +1 -1
- package/dist/scanner.js +100 -19
- package/dist/scanner.js.map +1 -1
- package/package.json +1 -1
- package/src/args.ts +28 -0
- package/src/directives.ts +148 -35
- package/src/remove.ts +72 -12
- package/src/run.ts +5 -1
- package/src/scanner.ts +107 -19
- package/README.en.md +0 -241
package/dist/run.js
CHANGED
|
@@ -30,6 +30,8 @@ Removal:
|
|
|
30
30
|
--dry-run With --remove: show what would be removed, change nothing
|
|
31
31
|
--remove-directives With --remove: also delete directive comments
|
|
32
32
|
--remove-legal With --remove: also delete license/legal comments
|
|
33
|
+
--keep <regex> With --remove: also keep comments matching the regular
|
|
34
|
+
expression, like directives (repeatable)
|
|
33
35
|
|
|
34
36
|
General:
|
|
35
37
|
-h, --help Show this help
|
|
@@ -40,7 +42,8 @@ skipping node_modules and .git. Ignore globs without a slash match file names,
|
|
|
40
42
|
and a trailing slash (dist/) restricts a glob to directories. JavaScript files
|
|
41
43
|
(.js, .jsx, .mjs, .cjs) added with --ext are parsed with JSX enabled. Removal
|
|
42
44
|
keeps directives and license headers unless explicitly requested, so builds
|
|
43
|
-
and linters keep working
|
|
45
|
+
and linters keep working; --keep protects the markers only a project's own
|
|
46
|
+
tooling reads, e.g. --keep "@skipMangle" or --keep "^// INJECT".
|
|
44
47
|
|
|
45
48
|
--diff narrows any scan or removal to files changed in git: a single revision
|
|
46
49
|
compares the working tree against it (HEAD covers all uncommitted work,
|
|
@@ -201,6 +204,7 @@ async function runRemove(options, collectOptions, io) {
|
|
|
201
204
|
jsx: isJsxFile(file),
|
|
202
205
|
removeDirectives: options.removeDirectives,
|
|
203
206
|
removeLegal: options.removeLegal,
|
|
207
|
+
keep: (comment) => options.keep.some((pattern) => pattern.test(comment.text)),
|
|
204
208
|
shouldRemove: (comment) => inScope(comment, options.directives),
|
|
205
209
|
});
|
|
206
210
|
if (result.changed) {
|
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,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,YAAY,EACZ,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,EAAqB,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,SAAS,GAAG
|
|
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,YAAY,EACZ,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,EAAqB,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmDjB,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,EAAE,CAAC,GAAG,CAAC,uBAAuB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvD,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED,sGAAsG;AACtG,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,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,wEAAwE;IACxE,wEAAwE;IACxE,yEAAyE;IACzE,2EAA2E;IAC3E,wEAAwE;IACxE,2BAA2B;IAC3B,4EAA4E;IAC5E,0EAA0E;IAC1E,iCAAiC;IACjC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,MAAM,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,sEAAsE;IACtE,2EAA2E;IAC3E,yEAAyE;IACzE,iEAAiE;IACjE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5E,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,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;AAOD,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,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7E,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,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;QAC9D,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,0EAA0E;IAC1E,4EAA4E;IAC5E,yEAAyE;IACzE,+BAA+B;IAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,mBAAmB,CAAC;IACxG,MAAM,WAAW,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,KAAK,aAAa,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7G,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,SAAS,CACnB;YACE,OAAO,EAAE;gBACP,mEAAmE;gBACnE,oEAAoE;gBACpE,KAAK,EAAE,QAAQ,CAAC,MAAM;gBACtB,YAAY,EAAE,cAAc,CAAC,MAAM;gBACnC,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
CHANGED
|
@@ -10,4 +10,15 @@ export interface SourceAnalysis {
|
|
|
10
10
|
jsx: JsxLayout;
|
|
11
11
|
}
|
|
12
12
|
export declare function analyzeSource(source: string, options?: ScanOptions): SourceAnalysis;
|
|
13
|
+
/**
|
|
14
|
+
* Whether a comment from `start` to `end` sits where ast-grep's suppression
|
|
15
|
+
* comment covers the whole file (`get_suppression_kind` in its `combined.rs`):
|
|
16
|
+
* on the first line with nothing but whitespace in front of it, and with the
|
|
17
|
+
* next node — code or another comment — starting two or more lines further
|
|
18
|
+
* down, or with nothing after it at all. Lines are counted the way tree-sitter
|
|
19
|
+
* counts its rows, by line feeds alone.
|
|
20
|
+
*/
|
|
21
|
+
export declare function isFileWidePosition(text: string, start: number, end: number): boolean;
|
|
22
|
+
/** Whether nothing but whitespace, and no line feed, precedes the offset: the start of tree-sitter's first row. */
|
|
23
|
+
export declare function opensFirstRow(text: string, offset: number): boolean;
|
|
13
24
|
//# sourceMappingURL=scanner.d.ts.map
|
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,EAAa,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"scanner.d.ts","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrD,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,CAEjF;AAED,6FAA6F;AAC7F,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,GAAG,EAAE,SAAS,CAAC;CAChB;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,cAAc,CA4HvF;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAIpF;AAED,mHAAmH;AACnH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAGnE"}
|
package/dist/scanner.js
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import ts from "typescript";
|
|
2
2
|
import { bunMarkerOffset, detectDirective } from "./directives.js";
|
|
3
3
|
import { jsxLayout } from "./jsx.js";
|
|
4
|
+
import { isBlank } from "./lines.js";
|
|
5
|
+
import { firstIndexAtOrAfter } from "./ranges.js";
|
|
4
6
|
export function scanComments(source, options = {}) {
|
|
5
7
|
return analyzeSource(source, options).comments;
|
|
6
8
|
}
|
|
@@ -13,6 +15,8 @@ export function analyzeSource(source, options = {}) {
|
|
|
13
15
|
const jsxParents = [];
|
|
14
16
|
const ranges = [];
|
|
15
17
|
const seen = new Set();
|
|
18
|
+
/** Every token, in document order. */
|
|
19
|
+
const tokens = [];
|
|
16
20
|
const collect = (found) => {
|
|
17
21
|
if (!found)
|
|
18
22
|
return;
|
|
@@ -36,6 +40,7 @@ export function analyzeSource(source, options = {}) {
|
|
|
36
40
|
// end-of-file token). Treat them as trivia like any other comment.
|
|
37
41
|
const children = node.getChildren(sourceFile).filter((child) => !ts.isJSDoc(child));
|
|
38
42
|
if (children.length === 0) {
|
|
43
|
+
tokens.push(node);
|
|
39
44
|
if (node.kind === ts.SyntaxKind.JsxText) {
|
|
40
45
|
jsxTextSpans.push([node.getFullStart(), node.getEnd()]);
|
|
41
46
|
}
|
|
@@ -76,29 +81,37 @@ export function analyzeSource(source, options = {}) {
|
|
|
76
81
|
const shebangEnd = ts.getShebang(source)?.length ?? 0;
|
|
77
82
|
const firstCommentPos = sorted.length > 0 ? sorted[0].pos : -1;
|
|
78
83
|
const bunMarkerPos = bunMarkerOffset(source);
|
|
79
|
-
// The token after
|
|
80
|
-
//
|
|
81
|
-
//
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
84
|
+
// The token after a comment, past any further comments: no token overlaps
|
|
85
|
+
// a comment, so it is the first one ending at or past the comment's end
|
|
86
|
+
// (the end-of-file token ends at the text's end). Token ends never
|
|
87
|
+
// decrease in document order, so a binary search finds it — without
|
|
88
|
+
// skipping the leading trivia a token start would need.
|
|
89
|
+
const tokenAfter = (offset) => tokens[firstIndexAtOrAfter(tokens, offset, (token) => token.end)];
|
|
90
|
+
const placementOf = (range) => {
|
|
91
|
+
// The switch slots walk the syntax tree, so they are worked out only for
|
|
92
|
+
// the comments a switch-clause rule matched, when it asks.
|
|
93
|
+
let slots;
|
|
94
|
+
const slotsOf = () => (slots ??= switchSlots(tokenAfter(range.end)));
|
|
95
|
+
const firstComment = range.pos === firstCommentPos;
|
|
96
|
+
return {
|
|
97
|
+
header: range.pos < firstTokenStart,
|
|
98
|
+
firstComment: firstComment && /^\s*$/.test(source.slice(shebangEnd, range.pos)),
|
|
99
|
+
fileStart: range.pos === bunMarkerPos,
|
|
100
|
+
fileWide: firstComment && isFileWidePosition(source, range.pos, range.end),
|
|
101
|
+
get fallthroughSlot() {
|
|
102
|
+
return slotsOf().fallthroughSlot;
|
|
103
|
+
},
|
|
104
|
+
get noDefaultSlot() {
|
|
105
|
+
return slotsOf().noDefaultSlot;
|
|
106
|
+
},
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
const comments = sorted.map((range) => {
|
|
97
110
|
const kind = range.kind === ts.SyntaxKind.SingleLineCommentTrivia ? "line" : "block";
|
|
98
111
|
const text = source.slice(range.pos, range.end);
|
|
99
112
|
const startPosition = sourceFile.getLineAndCharacterOfPosition(range.pos);
|
|
100
113
|
const endPosition = sourceFile.getLineAndCharacterOfPosition(range.end);
|
|
101
|
-
const directive = detectDirective(kind, text, placementOf(range
|
|
114
|
+
const directive = detectDirective(kind, text, placementOf(range));
|
|
102
115
|
return {
|
|
103
116
|
kind,
|
|
104
117
|
text,
|
|
@@ -113,4 +126,72 @@ export function analyzeSource(source, options = {}) {
|
|
|
113
126
|
});
|
|
114
127
|
return { comments, jsx: jsxLayout(source, sourceFile, jsxParents, comments) };
|
|
115
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* Whether a comment from `start` to `end` sits where ast-grep's suppression
|
|
131
|
+
* comment covers the whole file (`get_suppression_kind` in its `combined.rs`):
|
|
132
|
+
* on the first line with nothing but whitespace in front of it, and with the
|
|
133
|
+
* next node — code or another comment — starting two or more lines further
|
|
134
|
+
* down, or with nothing after it at all. Lines are counted the way tree-sitter
|
|
135
|
+
* counts its rows, by line feeds alone.
|
|
136
|
+
*/
|
|
137
|
+
export function isFileWidePosition(text, start, end) {
|
|
138
|
+
if (!opensFirstRow(text, start))
|
|
139
|
+
return false;
|
|
140
|
+
const next = text.slice(end).search(/\S/);
|
|
141
|
+
return next === -1 || lineFeedCount(text.slice(0, end + next)) >= 2;
|
|
142
|
+
}
|
|
143
|
+
/** Whether nothing but whitespace, and no line feed, precedes the offset: the start of tree-sitter's first row. */
|
|
144
|
+
export function opensFirstRow(text, offset) {
|
|
145
|
+
const before = text.slice(0, offset);
|
|
146
|
+
return isBlank(before) && !before.includes("\n");
|
|
147
|
+
}
|
|
148
|
+
function lineFeedCount(text) {
|
|
149
|
+
return text.split("\n").length - 1;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* The switch slots (see DirectivePlacement) a comment in front of the given
|
|
153
|
+
* token sits in. The token is what follows the comment past any further
|
|
154
|
+
* comments — the end-of-file token at the latest, whose parent is the file.
|
|
155
|
+
*/
|
|
156
|
+
function switchSlots(token) {
|
|
157
|
+
let fallthroughSlot = false;
|
|
158
|
+
let noDefaultSlot = false;
|
|
159
|
+
const parent = token.parent;
|
|
160
|
+
if ((token.kind === ts.SyntaxKind.CaseKeyword || token.kind === ts.SyntaxKind.DefaultKeyword) &&
|
|
161
|
+
ts.isCaseOrDefaultClause(parent)) {
|
|
162
|
+
// In front of a clause: where ESLint, oxlint and deno_lint read the
|
|
163
|
+
// comment saying the clause before it falls through — so not the first.
|
|
164
|
+
fallthroughSlot = parent.parent.clauses[0] !== parent;
|
|
165
|
+
}
|
|
166
|
+
else if (token.kind === ts.SyntaxKind.CloseBraceToken &&
|
|
167
|
+
ts.isBlock(parent) &&
|
|
168
|
+
ts.isCaseOrDefaultClause(parent.parent)) {
|
|
169
|
+
// Inside a block that is the last statement of a clause (its only one,
|
|
170
|
+
// for ESLint and oxlint), in front of its closing brace — read when
|
|
171
|
+
// another clause follows.
|
|
172
|
+
const clause = parent.parent;
|
|
173
|
+
const clauses = clause.parent.clauses;
|
|
174
|
+
fallthroughSlot = clause.statements.at(-1) === parent && clauses.at(-1) !== clause;
|
|
175
|
+
}
|
|
176
|
+
else if (token.kind === ts.SyntaxKind.CloseBraceToken && ts.isCaseBlock(parent)) {
|
|
177
|
+
// After the last clause of a switch, in front of its closing brace:
|
|
178
|
+
// where ESLint's default-case reads its comment.
|
|
179
|
+
noDefaultSlot = lacksDefaultClause(parent);
|
|
180
|
+
}
|
|
181
|
+
// oxlint's default-case reads the last comment from the last clause's
|
|
182
|
+
// start to the switch's end, so the comments inside that clause count too
|
|
183
|
+
// — all but one in front of the clause's opening `case`.
|
|
184
|
+
for (let node = parent; !noDefaultSlot && !ts.isSourceFile(node); node = node.parent) {
|
|
185
|
+
noDefaultSlot =
|
|
186
|
+
ts.isCaseClause(node) &&
|
|
187
|
+
node.parent.clauses.at(-1) === node &&
|
|
188
|
+
lacksDefaultClause(node.parent) &&
|
|
189
|
+
(node !== parent || token.kind !== ts.SyntaxKind.CaseKeyword);
|
|
190
|
+
}
|
|
191
|
+
return { fallthroughSlot, noDefaultSlot };
|
|
192
|
+
}
|
|
193
|
+
/** Whether the switch has clauses but none of them is a default clause. */
|
|
194
|
+
function lacksDefaultClause(caseBlock) {
|
|
195
|
+
return caseBlock.clauses.length > 0 && !caseBlock.clauses.some(ts.isDefaultClause);
|
|
196
|
+
}
|
|
116
197
|
//# sourceMappingURL=scanner.js.map
|
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,EAAE,eAAe,EAA2B,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,SAAS,EAAkB,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,eAAe,EAA2B,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,SAAS,EAAkB,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAOlD,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,UAAuB,EAAE;IACpE,OAAO,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC;AACjD,CAAC;AAQD,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,UAAuB,EAAE;IACrE,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,UAAU,GAA0C,EAAE,CAAC;IAC7D,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,sCAAsC;IACtC,MAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,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,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClB,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,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAC7C,0EAA0E;IAC1E,wEAAwE;IACxE,mEAAmE;IACnE,oEAAoE;IACpE,wDAAwD;IACxD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAW,EAAE,CAC7C,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAY,CAAC;IAC/E,MAAM,WAAW,GAAG,CAAC,KAAsB,EAAsB,EAAE;QACjE,yEAAyE;QACzE,2DAA2D;QAC3D,IAAI,KAAiD,CAAC;QACtD,MAAM,OAAO,GAAG,GAAmC,EAAE,CAAC,CAAC,KAAK,KAAK,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrG,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,KAAK,eAAe,CAAC;QACnD,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,GAAG,GAAG,eAAe;YACnC,YAAY,EAAE,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/E,SAAS,EAAE,KAAK,CAAC,GAAG,KAAK,YAAY;YACrC,QAAQ,EAAE,YAAY,IAAI,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;YAC1E,IAAI,eAAe;gBACjB,OAAO,OAAO,EAAE,CAAC,eAAe,CAAC;YACnC,CAAC;YACD,IAAI,aAAa;gBACf,OAAO,OAAO,EAAE,CAAC,aAAa,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAW,EAAE;QAC7C,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,CAAC,CAAC;QAClE,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;IAEH,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC;AAChF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW;IACzE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,IAAI,KAAK,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;AACtE,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,MAAc;IACxD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,eAAe,GAAG,KAAK,CAAC;IAC5B,IAAI,aAAa,GAAG,KAAK,CAAC;IAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC5B,IACE,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QACzF,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAChC,CAAC;QACD,oEAAoE;QACpE,wEAAwE;QACxE,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACxD,CAAC;SAAM,IACL,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe;QAC5C,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;QAClB,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,EACvC,CAAC;QACD,uEAAuE;QACvE,oEAAoE;QACpE,0BAA0B;QAC1B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;QACtC,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACrF,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAClF,oEAAoE;QACpE,iDAAiD;QACjD,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IACD,sEAAsE;IACtE,0EAA0E;IAC1E,yDAAyD;IACzD,KAAK,IAAI,IAAI,GAAG,MAAM,EAAE,CAAC,aAAa,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACrF,aAAa;YACX,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;gBACnC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC/B,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;AAC5C,CAAC;AAED,2EAA2E;AAC3E,SAAS,kBAAkB,CAAC,SAAuB;IACjD,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;AACrF,CAAC"}
|
package/package.json
CHANGED
package/src/args.ts
CHANGED
|
@@ -12,6 +12,8 @@ export interface CliOptions {
|
|
|
12
12
|
remove: boolean;
|
|
13
13
|
removeDirectives: boolean;
|
|
14
14
|
removeLegal: boolean;
|
|
15
|
+
/** Patterns of comments --remove keeps anyway (--keep). */
|
|
16
|
+
keep: RegExp[];
|
|
15
17
|
dryRun: boolean;
|
|
16
18
|
help: boolean;
|
|
17
19
|
version: boolean;
|
|
@@ -32,6 +34,7 @@ export function parseArgs(argv: string[]): CliOptions {
|
|
|
32
34
|
const paths: string[] = [];
|
|
33
35
|
const ignore: string[] = [];
|
|
34
36
|
const extensions: string[] = [];
|
|
37
|
+
const keep: RegExp[] = [];
|
|
35
38
|
let format: OutputFormat = "text";
|
|
36
39
|
let diff: string | undefined;
|
|
37
40
|
let directives: DirectiveMode = "include";
|
|
@@ -132,6 +135,18 @@ export function parseArgs(argv: string[]): CliOptions {
|
|
|
132
135
|
rejectValue();
|
|
133
136
|
removeLegal = true;
|
|
134
137
|
break;
|
|
138
|
+
case "--keep": {
|
|
139
|
+
// A forgotten pattern must not swallow the next flag: `--keep --dry-run`
|
|
140
|
+
// would turn a preview into an in-place removal. A pattern that does
|
|
141
|
+
// start with `-` can still be given inline, as `--keep=-x`.
|
|
142
|
+
if (inlineValue === undefined && argv[index + 1]?.startsWith("-") === true) {
|
|
143
|
+
throw new UsageError(
|
|
144
|
+
`option ${flag} requires a regular expression (use ${flag}=<regex> for one starting with "-")`,
|
|
145
|
+
);
|
|
146
|
+
}
|
|
147
|
+
keep.push(parsePattern(flag, readValue()));
|
|
148
|
+
break;
|
|
149
|
+
}
|
|
135
150
|
case "--dry-run":
|
|
136
151
|
rejectValue();
|
|
137
152
|
dryRun = true;
|
|
@@ -156,6 +171,7 @@ export function parseArgs(argv: string[]): CliOptions {
|
|
|
156
171
|
[dryRun, "--dry-run"],
|
|
157
172
|
[removeDirectives, "--remove-directives"],
|
|
158
173
|
[removeLegal, "--remove-legal"],
|
|
174
|
+
[keep.length > 0, "--keep"],
|
|
159
175
|
] as const) {
|
|
160
176
|
if (set) throw new UsageError(`${flag} requires --remove`);
|
|
161
177
|
}
|
|
@@ -186,12 +202,24 @@ export function parseArgs(argv: string[]): CliOptions {
|
|
|
186
202
|
remove,
|
|
187
203
|
removeDirectives,
|
|
188
204
|
removeLegal,
|
|
205
|
+
keep,
|
|
189
206
|
dryRun,
|
|
190
207
|
help,
|
|
191
208
|
version,
|
|
192
209
|
};
|
|
193
210
|
}
|
|
194
211
|
|
|
212
|
+
/** Compiles a pattern-valued option, reporting an invalid regular expression as a usage error. */
|
|
213
|
+
function parsePattern(flag: string, value: string): RegExp {
|
|
214
|
+
if (value === "") throw new UsageError(`option ${flag} requires a regular expression`);
|
|
215
|
+
try {
|
|
216
|
+
return new RegExp(value);
|
|
217
|
+
} catch (error) {
|
|
218
|
+
// The engine's message names the problem: "Invalid regular expression: /(/: Unterminated group".
|
|
219
|
+
throw new UsageError(`option ${flag}: ${(error as Error).message}`);
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
|
|
195
223
|
function splitFlag(arg: string): [string, string | undefined] {
|
|
196
224
|
const equalsIndex = arg.indexOf("=");
|
|
197
225
|
if (arg.startsWith("--") && equalsIndex > 2) {
|