@kaynooo/cli-code 0.14.2 → 0.15.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/dist/cli.js +231 -103
- package/dist/hotspots-cli.js +152 -69
- package/dist/peek-cli.js +138 -63
- package/dist/todo-scan-cli.js +176 -58
- package/package.json +2 -2
package/dist/todo-scan-cli.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// @bun
|
|
3
3
|
|
|
4
4
|
// src/todo-scan-cli.ts
|
|
5
|
-
import
|
|
5
|
+
import process17 from "process";
|
|
6
6
|
// ../kit/src/args.ts
|
|
7
7
|
import process9 from "process";
|
|
8
8
|
import { parseArgs } from "util";
|
|
@@ -422,6 +422,23 @@ function fileLink(text, path, stream, from = process6.cwd(), env = process6.env)
|
|
|
422
422
|
}
|
|
423
423
|
|
|
424
424
|
// ../kit/src/format.ts
|
|
425
|
+
var UNITS = [["d", 86400], ["h", 3600], ["m", 60], ["s", 1]];
|
|
426
|
+
function formatSeconds(total) {
|
|
427
|
+
let rest = Math.max(0, Math.round(total));
|
|
428
|
+
const amounts = UNITS.map(([unit, size]) => {
|
|
429
|
+
const amount = Math.floor(rest / size);
|
|
430
|
+
rest -= amount * size;
|
|
431
|
+
return `${amount}${unit}`;
|
|
432
|
+
});
|
|
433
|
+
const first = amounts.findIndex((amount) => !amount.startsWith("0"));
|
|
434
|
+
if (first === -1)
|
|
435
|
+
return "0s";
|
|
436
|
+
const next = amounts[first + 1];
|
|
437
|
+
return next === undefined || next.startsWith("0") ? amounts[first] ?? "0s" : `${amounts[first]} ${next}`;
|
|
438
|
+
}
|
|
439
|
+
function formatDuration(ms) {
|
|
440
|
+
return ms < 60000 ? `${(Math.max(0, ms) / 1000).toFixed(1)}s` : formatSeconds(ms / 1000);
|
|
441
|
+
}
|
|
425
442
|
function upTo(text, separator) {
|
|
426
443
|
const end = text.indexOf(separator);
|
|
427
444
|
return end === -1 ? text : text.slice(0, end);
|
|
@@ -482,24 +499,20 @@ function printJson(value) {
|
|
|
482
499
|
|
|
483
500
|
// ../kit/src/help.ts
|
|
484
501
|
import process8 from "process";
|
|
485
|
-
var OPTIONAL =
|
|
502
|
+
var OPTIONAL = /(?<!\x1B)\[[^\]]+\]/g;
|
|
486
503
|
var USAGE_PREFIX = /^usage:\s*/i;
|
|
487
504
|
var FULL_STOP = /\.$/;
|
|
488
505
|
function usageLine(usage, colors = paint(process8.stdout)) {
|
|
489
506
|
return `${colors.bold("Usage:")} ${usage.replace(USAGE_PREFIX, "").replaceAll(OPTIONAL, (part) => colors.dim(part))}`;
|
|
490
507
|
}
|
|
491
|
-
function helpText(usage, options, colors = paint(process8.stdout), { examples = [],
|
|
492
|
-
return [usageLine(usage, colors),
|
|
508
|
+
function helpText(usage, options, colors = paint(process8.stdout), { examples = [], exits = [] } = {}) {
|
|
509
|
+
return [usageLine(usage, colors), "", colors.bold("Options:"), ...optionRows(options, colors), ...exitRows(exits, colors), ...exampleRows(examples, colors)].join(`
|
|
493
510
|
`);
|
|
494
511
|
}
|
|
495
512
|
function exitRows(exits, colors = paint(process8.stdout)) {
|
|
496
513
|
if (exits.length === 0)
|
|
497
514
|
return [];
|
|
498
|
-
|
|
499
|
-
return ["", colors.bold("Exits:"), ...exits.map(([code, meaning]) => ` ${colors.cyan(String(code).padEnd(width))} ${meaning}`)];
|
|
500
|
-
}
|
|
501
|
-
function replacesRows(replaces, colors = paint(process8.stdout)) {
|
|
502
|
-
return replaces === undefined || outputMode() === "agent" ? [] : ["", `${colors.bold("Instead of:")} ${replaces}`];
|
|
515
|
+
return ["", `${colors.bold("Exit codes:")} ${exits.map(([code, meaning]) => `${colors.cyan(String(code))} ${meaning}`).join(", ")}`];
|
|
503
516
|
}
|
|
504
517
|
function wantsHelpJson(env = process8.env) {
|
|
505
518
|
return env.KIT_HELP === "json";
|
|
@@ -525,29 +538,40 @@ function exampleRows(examples, colors = paint(process8.stdout)) {
|
|
|
525
538
|
return [];
|
|
526
539
|
return ["", colors.bold("Examples:"), ...examples.map((example) => typeof example === "string" ? ` ${example}` : ` ${example[0]} ${colors.dim(`# ${example[1]}`)}`)];
|
|
527
540
|
}
|
|
541
|
+
var MAX_INLINE_CHOICES = 24;
|
|
528
542
|
function optionRows(options, colors = paint(process8.stdout)) {
|
|
529
543
|
const rows = Object.entries(options).map(([name, option]) => {
|
|
530
544
|
const short = option.short === undefined ? " " : `${colors.cyan(`-${option.short}`)}, `;
|
|
531
|
-
const
|
|
545
|
+
const choices = option.choices?.join("|");
|
|
546
|
+
const inline = choices !== undefined && choices.length <= MAX_INLINE_CHOICES;
|
|
547
|
+
const named = inline ? `<${choices}>` : "<value>";
|
|
532
548
|
const placeholder = option.optional === undefined ? named : `[${named}]`;
|
|
533
549
|
const value = option.type === "string" ? ` ${colors.dim(placeholder)}` : "";
|
|
534
|
-
|
|
550
|
+
const described = choices === undefined || inline ? option.description ?? "" : [option.description, `one of ${option.choices.join(", ")}`].filter(Boolean).join("; ");
|
|
551
|
+
return { flag: `${short}${colors.cyan(`--${name}`)}${value}`, width: `-x, --${name}`.length + (option.type === "string" ? placeholder.length + 1 : 0), description: described };
|
|
535
552
|
});
|
|
536
553
|
const width = Math.max(0, ...rows.map((row) => row.width));
|
|
537
554
|
return rows.map((row) => row.description === "" ? ` ${row.flag}` : ` ${row.flag}${" ".repeat(width - row.width)} ${colors.dim(row.description)}`);
|
|
538
555
|
}
|
|
539
556
|
|
|
540
557
|
// ../kit/src/text.ts
|
|
541
|
-
var ANSI = new RegExp(`${String.fromCharCode(27)}\\[[\\d;?]*[a-z]`, "gi");
|
|
542
558
|
function distance(a, b) {
|
|
543
|
-
|
|
544
|
-
|
|
559
|
+
const left = [...a];
|
|
560
|
+
const right = [...b];
|
|
561
|
+
let before = [];
|
|
562
|
+
let previous = Array.from({ length: right.length + 1 }, (_, index) => index);
|
|
563
|
+
for (const [i, x] of left.entries()) {
|
|
545
564
|
const current = [i + 1];
|
|
546
|
-
for (const [j,
|
|
547
|
-
|
|
565
|
+
for (const [j, y] of right.entries()) {
|
|
566
|
+
let cost = Math.min((previous[j + 1] ?? 0) + 1, (current[j] ?? 0) + 1, (previous[j] ?? 0) + (x === y ? 0 : 1));
|
|
567
|
+
if (i > 0 && j > 0 && x === right[j - 1] && left[i - 1] === y)
|
|
568
|
+
cost = Math.min(cost, (before[j - 1] ?? 0) + 1);
|
|
569
|
+
current.push(cost);
|
|
570
|
+
}
|
|
571
|
+
before = previous;
|
|
548
572
|
previous = current;
|
|
549
573
|
}
|
|
550
|
-
return previous[
|
|
574
|
+
return previous[right.length] ?? 0;
|
|
551
575
|
}
|
|
552
576
|
function closest(name, names) {
|
|
553
577
|
const started = names.find((known) => known.startsWith(name));
|
|
@@ -800,9 +824,33 @@ function nearestOption(message, options, allowNegative) {
|
|
|
800
824
|
const meant = closest(word, known.map((flag) => flag.replace(DASHES, "")));
|
|
801
825
|
return meant === undefined ? undefined : `did you mean ${known.find((flag) => flag.replace(DASHES, "") === meant)}?`;
|
|
802
826
|
}
|
|
827
|
+
// ../kit/src/argv.ts
|
|
828
|
+
import { readFileSync as readFileSync3, realpathSync } from "fs";
|
|
829
|
+
import { resolve as resolve4 } from "path";
|
|
830
|
+
import process10 from "process";
|
|
831
|
+
function commandLine() {
|
|
832
|
+
try {
|
|
833
|
+
return readFileSync3("/proc/self/cmdline", "utf8").split("\x00").slice(0, -1);
|
|
834
|
+
} catch {
|
|
835
|
+
return;
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
function realPath(word) {
|
|
839
|
+
try {
|
|
840
|
+
return realpathSync(resolve4(word));
|
|
841
|
+
} catch {
|
|
842
|
+
return;
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
function scriptArgs(argv = process10.argv.slice(2), cmdline = commandLine(), script = process10.argv[1]) {
|
|
846
|
+
const target = script === undefined ? undefined : realPath(script) ?? script;
|
|
847
|
+
const at = cmdline === undefined || target === undefined ? -1 : cmdline.findIndex((word, index) => index > 0 && (resolve4(word) === script || realPath(word) === target));
|
|
848
|
+
const after = at === -1 ? [] : cmdline.slice(at + 1);
|
|
849
|
+
return after[0] === "--" && after.length === argv.length + 1 && argv.every((word, index) => word === after[index + 1]) ? after : argv;
|
|
850
|
+
}
|
|
803
851
|
// ../kit/src/process.ts
|
|
804
852
|
import { constants } from "os";
|
|
805
|
-
import
|
|
853
|
+
import process11 from "process";
|
|
806
854
|
var KILL_GRACE_MS = 2000;
|
|
807
855
|
function exitCodeOf(code, signal) {
|
|
808
856
|
if (code !== null)
|
|
@@ -822,7 +870,7 @@ async function runCommand(argv, { cwd, env, stdin = "ignore", timeoutMs, signal,
|
|
|
822
870
|
return;
|
|
823
871
|
try {
|
|
824
872
|
if (grouped)
|
|
825
|
-
|
|
873
|
+
process11.kill(-proc.pid, killing);
|
|
826
874
|
else
|
|
827
875
|
proc.kill(killing);
|
|
828
876
|
} catch {}
|
|
@@ -896,15 +944,33 @@ var ESCAPE_CODE = new RegExp(`${ESC}(?:\\[[\\x30-\\x3F]*[\\x20-\\x2F]*[\\x40-\\x
|
|
|
896
944
|
var RESET_STYLE = `${ESC}[0m`;
|
|
897
945
|
var CLOSE_LINK = `${ESC}]8;;${ESC}\\`;
|
|
898
946
|
// ../kit/src/cli.ts
|
|
899
|
-
import { readFileSync as
|
|
947
|
+
import { readFileSync as readFileSync4, realpathSync as realpathSync2 } from "fs";
|
|
900
948
|
import { dirname as dirname3, join as join5 } from "path";
|
|
949
|
+
import process14 from "process";
|
|
950
|
+
|
|
951
|
+
// ../kit/src/notify.ts
|
|
901
952
|
import process12 from "process";
|
|
953
|
+
var NOTIFY_AFTER_MS = 1e4;
|
|
954
|
+
var CANCELLED = 130;
|
|
955
|
+
function base64(text) {
|
|
956
|
+
return Buffer.from(text).toString("base64");
|
|
957
|
+
}
|
|
958
|
+
function notification(title, body, env = process12.env) {
|
|
959
|
+
const id = `kit${process12.pid}`;
|
|
960
|
+
const codes = [`\x1B]99;i=${id}:d=0:o=unfocused:e=1;${base64(title)}\x1B\\`, `\x1B]99;i=${id}:p=body:e=1;${base64(body)}\x1B\\`];
|
|
961
|
+
return codes.map((code) => env.TMUX === undefined || env.TMUX === "" ? code : `\x1BPtmux;${code.replaceAll("\x1B", "\x1B\x1B")}\x1B\\`).join("");
|
|
962
|
+
}
|
|
963
|
+
function notifyEnd(command, code, ms, { stream = process12.stderr, env = process12.env } = {}) {
|
|
964
|
+
if (ms < NOTIFY_AFTER_MS || code === CANCELLED || outputMode(stream, env) !== "terminal")
|
|
965
|
+
return;
|
|
966
|
+
stream.write(notification(command, code === 0 ? `done in ${formatDuration(ms)}` : `failed with exit ${code} after ${formatDuration(ms)}`, env));
|
|
967
|
+
}
|
|
902
968
|
|
|
903
969
|
// ../kit/src/usage.ts
|
|
904
970
|
import { appendFileSync, mkdirSync } from "fs";
|
|
905
971
|
import { homedir as homedir3 } from "os";
|
|
906
972
|
import { dirname as dirname2, isAbsolute, join as join4 } from "path";
|
|
907
|
-
import
|
|
973
|
+
import process13 from "process";
|
|
908
974
|
|
|
909
975
|
// ../kit/src/logs.ts
|
|
910
976
|
var DAY_MS = 24 * 60 * 60 * 1000;
|
|
@@ -918,14 +984,14 @@ var usageError;
|
|
|
918
984
|
function noteUsageError(message) {
|
|
919
985
|
usageError = message;
|
|
920
986
|
}
|
|
921
|
-
function stateHome(env =
|
|
987
|
+
function stateHome(env = process13.env) {
|
|
922
988
|
const dir = env.XDG_STATE_HOME;
|
|
923
989
|
return dir !== undefined && isAbsolute(dir) ? dir : join4(homedir3(), ".local", "state");
|
|
924
990
|
}
|
|
925
|
-
function usagePath(env =
|
|
991
|
+
function usagePath(env = process13.env) {
|
|
926
992
|
return join4(stateHome(env), CLI_FOLDER, "usage.jsonl");
|
|
927
993
|
}
|
|
928
|
-
function usageRecorded(env =
|
|
994
|
+
function usageRecorded(env = process13.env) {
|
|
929
995
|
const off = env.KAYNOOO_CLI_NO_USAGE;
|
|
930
996
|
return env.NODE_ENV !== "test" && (off === undefined || off === "" || off === "0");
|
|
931
997
|
}
|
|
@@ -939,7 +1005,7 @@ function usageEntry(bin, command, argv, code, now = new Date) {
|
|
|
939
1005
|
usageError = undefined;
|
|
940
1006
|
return { at: now.toISOString(), bin, ...command === undefined ? {} : { command }, flags: flagNames(argv), code, ...unknown === undefined ? {} : { unknown } };
|
|
941
1007
|
}
|
|
942
|
-
function recordUsage(entry, env =
|
|
1008
|
+
function recordUsage(entry, env = process13.env) {
|
|
943
1009
|
if (!usageRecorded(env))
|
|
944
1010
|
return;
|
|
945
1011
|
try {
|
|
@@ -1016,7 +1082,6 @@ async function help2({ path, header, summary: lazySummary, commands, defaultComm
|
|
|
1016
1082
|
header(colors, summary),
|
|
1017
1083
|
"",
|
|
1018
1084
|
usageLine(`${prefix} ${defaultCommand === undefined ? colors.cyan("<command>") : `[${colors.cyan("<command>")}]`} [options]`, colors),
|
|
1019
|
-
...replacesRows(replaces, colors),
|
|
1020
1085
|
"",
|
|
1021
1086
|
...await commandRows(commands, colors),
|
|
1022
1087
|
...own.length === 0 ? [] : ["", `${colors.bold(`Options of ${defaultCommand}:`)} ${colors.dim("the command run when none is named")}`, ...optionRows(Object.fromEntries(own), colors)],
|
|
@@ -1030,8 +1095,8 @@ async function help2({ path, header, summary: lazySummary, commands, defaultComm
|
|
|
1030
1095
|
`);
|
|
1031
1096
|
}
|
|
1032
1097
|
function printError(prefix, message, hint, cause) {
|
|
1033
|
-
const colors = paint(
|
|
1034
|
-
const styled = takesControlCodes(
|
|
1098
|
+
const colors = paint(process14.stderr);
|
|
1099
|
+
const styled = takesControlCodes(process14.stderr);
|
|
1035
1100
|
const head = styled ? `${colors.red.bold("error")} ${colors.dim(`${prefix}:`)}` : `error: ${prefix}:`;
|
|
1036
1101
|
const under = (label, text, tint) => text === undefined ? "" : `
|
|
1037
1102
|
${styled ? tint(label) : `${label}:`} ${text}`;
|
|
@@ -1074,11 +1139,11 @@ async function dispatch(level, typed, { version, redact }) {
|
|
|
1074
1139
|
}
|
|
1075
1140
|
}
|
|
1076
1141
|
if (name === undefined && level.path.length > 1) {
|
|
1077
|
-
console.error(await help2(await expand(level, [...level.path.slice(1), ...argv]),
|
|
1142
|
+
console.error(await help2(await expand(level, [...level.path.slice(1), ...argv]), process14.stderr));
|
|
1078
1143
|
return 2;
|
|
1079
1144
|
}
|
|
1080
1145
|
if (name === undefined || name === "help" || name === "--help" || name === "-h") {
|
|
1081
|
-
console.log(await help2(await expand(level, [...level.path.slice(1), ...argv]),
|
|
1146
|
+
console.log(await help2(await expand(level, [...level.path.slice(1), ...argv]), process14.stdout));
|
|
1082
1147
|
return 0;
|
|
1083
1148
|
}
|
|
1084
1149
|
if (level.path.length === 1 && (name === "--version" || name === "-v")) {
|
|
@@ -1134,24 +1199,24 @@ function candidateLine(candidate) {
|
|
|
1134
1199
|
}
|
|
1135
1200
|
function positionalBeingTyped(before, { options, positionals }) {
|
|
1136
1201
|
const takesValue = (word) => !word.includes("=") && Object.entries(options).some(([name, { short, type }]) => type === "string" && (word === `--${name}` || word === `-${short}`));
|
|
1137
|
-
|
|
1202
|
+
const typed = [];
|
|
1138
1203
|
let at = 0;
|
|
1139
1204
|
while (at < before.length) {
|
|
1140
1205
|
const word = before[at];
|
|
1141
1206
|
if (word === "--") {
|
|
1142
|
-
|
|
1207
|
+
typed.push(...before.slice(at + 1));
|
|
1143
1208
|
break;
|
|
1144
1209
|
}
|
|
1145
1210
|
if (!word.startsWith("-"))
|
|
1146
|
-
|
|
1211
|
+
typed.push(word);
|
|
1147
1212
|
else if (takesValue(word))
|
|
1148
1213
|
at++;
|
|
1149
1214
|
at++;
|
|
1150
1215
|
}
|
|
1151
1216
|
const last = positionals.at(-1);
|
|
1152
|
-
if (
|
|
1153
|
-
return positionals[
|
|
1154
|
-
return last?.replace("]", "").endsWith("...") === true ? last : undefined;
|
|
1217
|
+
if (typed.length < positionals.length)
|
|
1218
|
+
return { name: positionals[typed.length], typed };
|
|
1219
|
+
return { name: last?.replace("]", "").endsWith("...") === true ? last : undefined, typed };
|
|
1155
1220
|
}
|
|
1156
1221
|
async function leafCandidates(run, words) {
|
|
1157
1222
|
const completing = await completingOf(run);
|
|
@@ -1159,12 +1224,12 @@ async function leafCandidates(run, words) {
|
|
|
1159
1224
|
return Object.entries(completing.options).map(([name, option]) => option.description === undefined ? `--${name}` : `--${name} ${option.description}`);
|
|
1160
1225
|
const flag = words.at(-2);
|
|
1161
1226
|
const option = flag?.startsWith("-") === true ? Object.entries(completing.options).find(([name, { short }]) => flag === `--${name}` || flag === `-${short}`)?.[1] : undefined;
|
|
1227
|
+
const { name, typed } = positionalBeingTyped(words.slice(0, -1), completing);
|
|
1162
1228
|
if (option?.type === "string") {
|
|
1163
|
-
const values = option.choices === undefined ? await option.candidates?.() : option.choices;
|
|
1229
|
+
const values = option.choices === undefined ? await option.candidates?.(typed) : option.choices;
|
|
1164
1230
|
return values === undefined ? [FILES] : values.map(candidateLine);
|
|
1165
1231
|
}
|
|
1166
|
-
const
|
|
1167
|
-
const values = name === undefined ? undefined : await completing.candidates[name]?.();
|
|
1232
|
+
const values = name === undefined ? undefined : await completing.candidates[name]?.(typed);
|
|
1168
1233
|
return values === undefined ? [FILES] : values.map(candidateLine);
|
|
1169
1234
|
}
|
|
1170
1235
|
async function candidates(scope, defaultCommand, words, before = []) {
|
|
@@ -1195,9 +1260,13 @@ async function printCandidates(found) {
|
|
|
1195
1260
|
return 0;
|
|
1196
1261
|
}
|
|
1197
1262
|
function packageVersion(entry = Bun.main) {
|
|
1198
|
-
|
|
1263
|
+
let resolved = entry;
|
|
1264
|
+
try {
|
|
1265
|
+
resolved = realpathSync2(entry);
|
|
1266
|
+
} catch {}
|
|
1267
|
+
for (let dir = dirname3(resolved);; dir = dirname3(dir)) {
|
|
1199
1268
|
try {
|
|
1200
|
-
const { version } = JSON.parse(
|
|
1269
|
+
const { version } = JSON.parse(readFileSync4(join5(dir, "package.json"), "utf8"));
|
|
1201
1270
|
if (typeof version === "string")
|
|
1202
1271
|
return version;
|
|
1203
1272
|
} catch {}
|
|
@@ -1205,14 +1274,17 @@ function packageVersion(entry = Bun.main) {
|
|
|
1205
1274
|
return "0.0.0";
|
|
1206
1275
|
}
|
|
1207
1276
|
}
|
|
1208
|
-
async function runCli(cli, argv =
|
|
1277
|
+
async function runCli(cli, argv = scriptArgs()) {
|
|
1209
1278
|
const version = cli.version ?? packageVersion();
|
|
1210
1279
|
if (argv[0] === COMPLETE)
|
|
1211
1280
|
return printCandidates(candidates(scopeOf(cli.commands, cli.extraCommands, cli.aliases), cli.defaultCommand, argv.slice(1)));
|
|
1281
|
+
const started = performance.now();
|
|
1212
1282
|
const code = await dispatch({ path: [cli.name], header: (colors, about) => `${colors.bold(cli.name)} ${colors.dim(version)} ${about}`, summary: cli.about, ...scopeOf(cli.commands, cli.extraCommands, cli.aliases), defaultCommand: cli.defaultCommand, runBare: cli.runBare === true, examples: cli.examples, replaces: cli.replaces }, argv, { version, redact: cli.redact });
|
|
1283
|
+
const command = commandPath(scopeOf(cli.commands, cli.extraCommands, cli.aliases), argv);
|
|
1284
|
+
notifyEnd(command === undefined ? cli.name : `${cli.name} ${command}`, code, performance.now() - started);
|
|
1213
1285
|
if (cli.usage !== false) {
|
|
1214
1286
|
try {
|
|
1215
|
-
recordUsage(usageEntry(cli.name,
|
|
1287
|
+
recordUsage(usageEntry(cli.name, command, argv, code));
|
|
1216
1288
|
} catch {}
|
|
1217
1289
|
}
|
|
1218
1290
|
return code;
|
|
@@ -1232,7 +1304,7 @@ function commandPath(scope, argv) {
|
|
|
1232
1304
|
}
|
|
1233
1305
|
return path.length === 0 ? undefined : path.join(" ");
|
|
1234
1306
|
}
|
|
1235
|
-
async function runMain({ name, version, run, redact, usage }, argv =
|
|
1307
|
+
async function runMain({ name, version, run, redact, usage }, argv = scriptArgs()) {
|
|
1236
1308
|
if (argv[0] === COMPLETE)
|
|
1237
1309
|
return printCandidates(leafCandidates(run, argv.slice(1)));
|
|
1238
1310
|
if (argv.length === 1 && (argv[0] === "--version" || argv[0] === "-v")) {
|
|
@@ -1240,11 +1312,13 @@ async function runMain({ name, version, run, redact, usage }, argv = process12.a
|
|
|
1240
1312
|
return 0;
|
|
1241
1313
|
}
|
|
1242
1314
|
let code;
|
|
1315
|
+
const started = performance.now();
|
|
1243
1316
|
try {
|
|
1244
1317
|
code = await run(argv);
|
|
1245
1318
|
} catch (error) {
|
|
1246
1319
|
code = reportThrown(name, error, redact, wantsJson(argv));
|
|
1247
1320
|
}
|
|
1321
|
+
notifyEnd(name, code, performance.now() - started);
|
|
1248
1322
|
if (usage !== false) {
|
|
1249
1323
|
try {
|
|
1250
1324
|
recordUsage(usageEntry(name, undefined, argv, code));
|
|
@@ -1288,7 +1362,7 @@ var SESSION_FILES = new Glob("*.json");
|
|
|
1288
1362
|
var ACCOUNT_DIRS = new Glob("*/sessions");
|
|
1289
1363
|
// src/todo-scan.ts
|
|
1290
1364
|
import { join as join7 } from "path";
|
|
1291
|
-
import
|
|
1365
|
+
import process16 from "process";
|
|
1292
1366
|
|
|
1293
1367
|
// src/files.ts
|
|
1294
1368
|
import { existsSync as existsSync4, readdirSync, statSync as statSync2 } from "fs";
|
|
@@ -1336,7 +1410,7 @@ var COMMENT = /(?<![:\w/])\/\/|\/\*|<!--|(?:^|\s)(?:#|--)(?=\s)|^\s*\*(?=\s|$)/;
|
|
|
1336
1410
|
var MARKUP = /\.(?:md|mdx|markdown|html?|xml)$/i;
|
|
1337
1411
|
var MARKUP_COMMENT = /<!--/;
|
|
1338
1412
|
var CLOSERS = /\s*(?:\*\/|-->)\s*$/;
|
|
1339
|
-
var MARKER = /^(?:@|\[)?(TODO|FIXME)\b/;
|
|
1413
|
+
var MARKER = /^(?:@|\[)?(TODO|FIXME|HACK|XXX)\b/;
|
|
1340
1414
|
var QUOTES = ["'", '"', "`"];
|
|
1341
1415
|
var ESCAPE2 = /\\./g;
|
|
1342
1416
|
var AFTER_FIRST_LINE = /\n[\s\S]*/;
|
|
@@ -1345,6 +1419,40 @@ function isQuoted(line, index) {
|
|
|
1345
1419
|
const before = line.slice(0, index).replaceAll(ESCAPE2, "");
|
|
1346
1420
|
return QUOTES.some((quote) => before.split(quote).length % 2 === 0);
|
|
1347
1421
|
}
|
|
1422
|
+
var BLAME_HEADER = /^[0-9a-f]{40} \d+ (\d+)/;
|
|
1423
|
+
var DAY_S = 86400;
|
|
1424
|
+
async function commitTimes(path, cwd) {
|
|
1425
|
+
const blamed = await runCommand(["git", "blame", "--porcelain", "--", path], { cwd });
|
|
1426
|
+
const times = new Map;
|
|
1427
|
+
if (blamed.code !== 0)
|
|
1428
|
+
return times;
|
|
1429
|
+
const bySha = new Map;
|
|
1430
|
+
let sha = "";
|
|
1431
|
+
let line = 0;
|
|
1432
|
+
for (const row of stdoutOf(blamed.chunks).split(`
|
|
1433
|
+
`)) {
|
|
1434
|
+
const header = BLAME_HEADER.exec(row);
|
|
1435
|
+
if (header !== null) {
|
|
1436
|
+
sha = row.slice(0, 40);
|
|
1437
|
+
line = Number(header[1]);
|
|
1438
|
+
} else if (row.startsWith("committer-time ")) {
|
|
1439
|
+
bySha.set(sha, Number(row.slice("committer-time ".length)));
|
|
1440
|
+
} else if (row.startsWith("\t")) {
|
|
1441
|
+
times.set(line, bySha.get(sha) ?? 0);
|
|
1442
|
+
}
|
|
1443
|
+
}
|
|
1444
|
+
return times;
|
|
1445
|
+
}
|
|
1446
|
+
async function addAges(marks, cwd, now = Date.now() / 1000) {
|
|
1447
|
+
await Promise.all([...Map.groupBy(marks, (mark) => mark.path)].map(async ([path, ofFile]) => {
|
|
1448
|
+
const times = await commitTimes(path, cwd);
|
|
1449
|
+
for (const mark of ofFile) {
|
|
1450
|
+
const time = times.get(mark.line);
|
|
1451
|
+
if (time !== undefined)
|
|
1452
|
+
mark.age = Math.max(0, Math.floor((now - time) / DAY_S));
|
|
1453
|
+
}
|
|
1454
|
+
}));
|
|
1455
|
+
}
|
|
1348
1456
|
function marksIn(text, path) {
|
|
1349
1457
|
const marks = [];
|
|
1350
1458
|
const comment = MARKUP.test(path) ? MARKUP_COMMENT : COMMENT;
|
|
@@ -1400,18 +1508,21 @@ async function lookUp(refs, cwd) {
|
|
|
1400
1508
|
}
|
|
1401
1509
|
|
|
1402
1510
|
// src/todo-scan.ts
|
|
1403
|
-
var USAGE = `todo-scan [options] [path...]: lists the TODO, FIXME and owner/repo#N comments under the paths (here by default), each as <file>:<line>: <comment>, honouring .gitignore
|
|
1511
|
+
var USAGE = `todo-scan [options] [path...]: lists the TODO, FIXME, HACK, XXX and owner/repo#N comments under the paths (here by default), each as <file>:<line>: <comment>, honouring .gitignore
|
|
1404
1512
|
|
|
1405
|
-
--
|
|
1513
|
+
--older <duration> keeps only the comments whose line last changed longer ago than that (30d, 12w, 6m: git blame dates each one, a file git cannot blame is left out) and shows each one's age.
|
|
1406
1514
|
|
|
1407
|
-
|
|
1515
|
+
--stale keeps only the comments naming a closed issue, each issue's state looked up with ft, or gh for a GitHub repository, and exits 1 when it finds one.
|
|
1408
1516
|
|
|
1409
|
-
|
|
1517
|
+
Lists at most 100 comments, the count of the rest after them (--limit <n>, --full for all); --json is never cut unless --limit is given.`;
|
|
1518
|
+
var EXITS = [[0, "it listed the comments or found no stale one"], [1, "--stale finds one"], [2, "a usage error or when --stale could not look a repository up (ft and gh both failed)"]];
|
|
1410
1519
|
var LIST_LIMIT = 100;
|
|
1520
|
+
var DAY_MS2 = 86400000;
|
|
1411
1521
|
var OPTIONS = {
|
|
1412
1522
|
stale: { type: "boolean", description: "only the comments naming a closed issue, looked up with ft or gh" },
|
|
1523
|
+
older: { type: "string", description: "only the comments whose line last changed longer ago than this duration, from git blame" },
|
|
1413
1524
|
...limitOptions(LIST_LIMIT),
|
|
1414
|
-
json: jsonOption("[{path, line, kind, text, refs: [{repo, number, state?}]}]")
|
|
1525
|
+
json: jsonOption("[{path, line, kind, text, refs: [{repo, number, state?}], age?}], age being the days since the line last changed, given with --older or --json when git can date it")
|
|
1415
1526
|
};
|
|
1416
1527
|
function printLines(lines, footer) {
|
|
1417
1528
|
const all = [...lines, ...footer === undefined ? [] : [footer]];
|
|
@@ -1420,21 +1531,28 @@ function printLines(lines, footer) {
|
|
|
1420
1531
|
`));
|
|
1421
1532
|
}
|
|
1422
1533
|
async function todoScan(args) {
|
|
1423
|
-
const { values, positionals } = parse(args, USAGE, OPTIONS, { positionals: ["[path...]"], replaces: "grep -rn TODO, then opening each issue it names", examples: ["todo-scan src", ["todo-scan --stale", "only the comments naming a closed issue"]] });
|
|
1424
|
-
const cwd =
|
|
1534
|
+
const { values, positionals } = parse(args, USAGE, OPTIONS, { exits: EXITS, positionals: ["[path...]"], replaces: "grep -rn TODO, then opening each issue it names", examples: ["todo-scan src", ["todo-scan --stale", "only the comments naming a closed issue"]] });
|
|
1535
|
+
const cwd = process16.cwd();
|
|
1425
1536
|
const limit = limitOf(values, LIST_LIMIT);
|
|
1426
|
-
const
|
|
1537
|
+
const found = [];
|
|
1427
1538
|
for (const path of await listFiles(positionals, cwd)) {
|
|
1428
1539
|
const text = await readText(join7(cwd, path));
|
|
1429
1540
|
if (text !== undefined)
|
|
1430
|
-
|
|
1541
|
+
found.push(...marksIn(text, path));
|
|
1431
1542
|
}
|
|
1543
|
+
const older = values.older === undefined ? undefined : duration(values.older, "older", 0, "m") / DAY_MS2;
|
|
1544
|
+
let marks = found;
|
|
1545
|
+
if (older !== undefined || values.json === true)
|
|
1546
|
+
await addAges(found, cwd);
|
|
1547
|
+
const ageNote = (mark) => older === undefined || mark.age === undefined ? "" : ` [${mark.age}d]`;
|
|
1548
|
+
if (older !== undefined)
|
|
1549
|
+
marks = found.filter((mark) => mark.age !== undefined && mark.age >= older);
|
|
1432
1550
|
if (values.stale !== true) {
|
|
1433
1551
|
const { shown, footer } = capped(marks, limit);
|
|
1434
1552
|
if (values.json === true)
|
|
1435
1553
|
printJson(shown);
|
|
1436
1554
|
else
|
|
1437
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}`), footer);
|
|
1555
|
+
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}${ageNote(mark)}`), footer);
|
|
1438
1556
|
return 0;
|
|
1439
1557
|
}
|
|
1440
1558
|
const { states, failed } = await lookUp(marks.flatMap((mark) => mark.refs), cwd);
|
|
@@ -1445,11 +1563,11 @@ async function todoScan(args) {
|
|
|
1445
1563
|
if (values.json === true)
|
|
1446
1564
|
printJson(shown.map((mark) => ({ ...mark, refs: mark.refs.map((ref) => ({ ...ref, state: states.get(refKey(ref)) })) })));
|
|
1447
1565
|
else
|
|
1448
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.refs.filter((ref) => states.get(refKey(ref)) === "closed").map(refKey).join(", ")} closed: ${mark.text}`), footer);
|
|
1566
|
+
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.refs.filter((ref) => states.get(refKey(ref)) === "closed").map(refKey).join(", ")} closed: ${mark.text}${ageNote(mark)}`), footer);
|
|
1449
1567
|
if (stale.length > 0)
|
|
1450
1568
|
return 1;
|
|
1451
1569
|
return failed.size > 0 ? 2 : 0;
|
|
1452
1570
|
}
|
|
1453
1571
|
|
|
1454
1572
|
// src/todo-scan-cli.ts
|
|
1455
|
-
|
|
1573
|
+
process17.exitCode = await runMain({ name: "todo-scan", run: todoScan });
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kaynooo/cli-code",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.15.0",
|
|
5
5
|
"description": "peek, todo-scan and hotspots: source read by spans, symbols and outlines in one call, the TODO and issue-reference comments of a repository with stale ones flagged, and the files ranked by complexity times git churn.",
|
|
6
6
|
"author": "Kaynooo <contact@kaynooo.fr>",
|
|
7
7
|
"license": "MIT",
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"@kaynooo/utils": "3.0.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@kaynooo/cli-kit": "0.
|
|
49
|
+
"@kaynooo/cli-kit": "0.39.0"
|
|
50
50
|
}
|
|
51
51
|
}
|