@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/cli.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// @bun
|
|
3
3
|
|
|
4
4
|
// src/cli.ts
|
|
5
|
-
import
|
|
5
|
+
import process19 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/hotspots.ts
|
|
1290
1364
|
import { basename, join as join7 } from "path";
|
|
1291
|
-
import
|
|
1365
|
+
import process16 from "process";
|
|
1292
1366
|
|
|
1293
1367
|
// src/churn.ts
|
|
1294
1368
|
var SOURCE = /\.(?:[cm]?[jt]sx?|vue|svelte|astro|kay|py|go|rs|rb|php|java|kt|swift|cs|c|cc|cpp|h|hpp|scala|dart|lua|sh|zsh|fish)$/;
|
|
@@ -1296,9 +1370,8 @@ var TESTS = /(?:^|\/)(?:tests?|__tests__|spec|e2e|__mocks__|fixtures)\/|\.(?:tes
|
|
|
1296
1370
|
var GENERATED = /(?:^|\/)(?:dist|build|out|generated|\.nuxt|\.output|\.next)\/|\.min\.[cm]?js$|\.d\.ts$|\.(?:generated|gen)\.[^/]+$|\.pb\.go$|\.snap$/;
|
|
1297
1371
|
var LEADING_NEWLINE = /^\n/;
|
|
1298
1372
|
var GENERATED_HEADER = /@generated|generated by|do not edit/i;
|
|
1299
|
-
var DECISION = /\b(?:if|elif|elsif|for|foreach|while|until|case|when|catch|except|rescue|match|guard|and|or)\b
|
|
1300
|
-
var
|
|
1301
|
-
var STRING = /'(?:\\.|[^'\\\n])*'|"(?:\\.|[^"\\\n])*"|`(?:\\.|[^`\\])*`/g;
|
|
1373
|
+
var DECISION = /\b(?:if|elif|elsif|for|foreach|while|until|case|when|catch|except|rescue|match|guard|and|or)\b|&&|\|\||\?\?|\s\?(?![,):.?])/g;
|
|
1374
|
+
var COMMENT_OR_STRING = /(\/\*[\s\S]*?\*\/|\/\/[^\n]*|^[ \t]*#[^\n]*)|'(?:\\.|[^'\\\n])*'|"(?:\\.|[^"\\\n])*"|`(?:\\.|[^`\\])*`/gm;
|
|
1302
1375
|
function isCandidate(path) {
|
|
1303
1376
|
return SOURCE.test(path) && !TESTS.test(path) && !GENERATED.test(path);
|
|
1304
1377
|
}
|
|
@@ -1306,25 +1379,35 @@ function isGenerated(text) {
|
|
|
1306
1379
|
return GENERATED_HEADER.test(text.slice(0, 400));
|
|
1307
1380
|
}
|
|
1308
1381
|
function complexityOf(text) {
|
|
1309
|
-
return 1 + (text.replace(
|
|
1382
|
+
return 1 + (text.replace(COMMENT_OR_STRING, (_, comment) => comment === undefined ? '""' : "").match(DECISION)?.length ?? 0);
|
|
1310
1383
|
}
|
|
1311
1384
|
async function churnSince(cwd, since, { bulk, halfLifeMs, now = Date.now() }) {
|
|
1312
|
-
const log = await runCommand(["git", "log", `--since=${since}`, "--no-renames", "--
|
|
1313
|
-
if (log.code !== 0)
|
|
1385
|
+
const [log, top] = await Promise.all([runCommand(["git", "log", `--since=${since}`, "--no-renames", "--numstat", "--format=%x01%ct%x02%ae", "-z"], { cwd }), runCommand(["git", "rev-parse", "--show-prefix"], { cwd })]);
|
|
1386
|
+
if (log.code !== 0 || top.code !== 0)
|
|
1314
1387
|
return;
|
|
1388
|
+
const prefix = top.text.trim();
|
|
1315
1389
|
const churn = new Map;
|
|
1390
|
+
const authors = new Map;
|
|
1316
1391
|
for (const commit of log.text.split("\x01").slice(1)) {
|
|
1317
|
-
const [
|
|
1318
|
-
const
|
|
1319
|
-
|
|
1392
|
+
const [head = "", ...entries] = commit.split("\x00");
|
|
1393
|
+
const [stamp = "", author = ""] = head.split("\x02");
|
|
1394
|
+
const all = entries.map((entry) => entry.replace(LEADING_NEWLINE, "")).filter((entry) => entry !== "").map((entry) => {
|
|
1395
|
+
const [added = "", deleted = "", ...path] = entry.split("\t");
|
|
1396
|
+
return { path: path.join("\t"), lines: (Number(added) || 0) + (Number(deleted) || 0) };
|
|
1397
|
+
});
|
|
1398
|
+
if (all.length > bulk)
|
|
1320
1399
|
continue;
|
|
1400
|
+
const paths = all.filter(({ path }) => path.startsWith(prefix)).map(({ path, lines }) => ({ path: path.slice(prefix.length), lines }));
|
|
1321
1401
|
const age = Math.max(0, now - Number(stamp) * 1000);
|
|
1322
1402
|
const weight = halfLifeMs === 0 ? 1 : 0.5 ** (age / halfLifeMs);
|
|
1323
|
-
for (const path of paths) {
|
|
1324
|
-
const seen = churn.get(path) ?? { commits: 0, weight: 0 };
|
|
1325
|
-
churn.set(path, { commits: seen.commits + 1, weight: seen.weight + weight });
|
|
1403
|
+
for (const { path, lines } of paths) {
|
|
1404
|
+
const seen = churn.get(path) ?? { commits: 0, weight: 0, lines: 0, linesWeight: 0, authors: 0 };
|
|
1405
|
+
churn.set(path, { commits: seen.commits + 1, weight: seen.weight + weight, lines: seen.lines + lines, linesWeight: seen.linesWeight + lines * weight, authors: 0 });
|
|
1406
|
+
authors.set(path, (authors.get(path) ?? new Set).add(author));
|
|
1326
1407
|
}
|
|
1327
1408
|
}
|
|
1409
|
+
for (const [path, seen] of churn)
|
|
1410
|
+
seen.authors = authors.get(path)?.size ?? 0;
|
|
1328
1411
|
return churn;
|
|
1329
1412
|
}
|
|
1330
1413
|
|
|
@@ -1427,27 +1510,27 @@ var DEFAULT_HALF_LIFE = "90d";
|
|
|
1427
1510
|
var DEFAULT_COUNT = configuredNumber("hotspots", "limit", 20);
|
|
1428
1511
|
var USAGE = `hotspots [options] [dir]: ranks the source files under dir (here by default) by complexity times churn, the ones both hard to read and often edited first, honouring .gitignore
|
|
1429
1512
|
|
|
1430
|
-
Complexity is the count of decision points in the file (branches, loops, cases, catches, boolean operators, ternaries) plus one, churn the commits touching it since --since (${DEFAULT_SINCE}), score their product. A commit counts for less the older it is (half as much every --half-life, 0 for all alike) and a commit touching more than --bulk files, a format or rename sweep, is left out. Each file also shows its most complex declaration, found by indentation. Test files and generated or built files are left out unless --all.
|
|
1431
|
-
|
|
1432
|
-
Lists at most ${DEFAULT_COUNT} files, the count of the rest after them (--limit <n>, --full for all); --json is never cut unless --limit is given.
|
|
1513
|
+
Complexity is the count of decision points in the file (branches, loops, cases, catches, boolean operators, ternaries) plus one, churn the commits touching it since --since (${DEFAULT_SINCE}), score their product. A commit counts for less the older it is (half as much every --half-life, 0 for all alike) and a commit touching more than --bulk files, a format or rename sweep, is left out. --by-lines scores the lines changed instead of the commits. Each file also shows how many lines changed, its author count ("solo" when one author wrote every change) and its most complex declaration, found by indentation. Test files and generated or built files are left out unless --all.
|
|
1433
1514
|
|
|
1434
|
-
|
|
1515
|
+
Lists at most ${DEFAULT_COUNT} files, the count of the rest after them (--limit <n>, --full for all); --json is never cut unless --limit is given.`;
|
|
1516
|
+
var EXITS = [[0, "it ranked the files"], [1, "no file has commits in the window"], [2, "a usage error or outside a git repository"]];
|
|
1435
1517
|
var OPTIONS = {
|
|
1436
1518
|
since: { type: "string", short: "s", description: `only count the commits since this date, as git reads it (${DEFAULT_SINCE})` },
|
|
1437
1519
|
"half-life": { type: "string", description: `how long until a commit counts half as much (${DEFAULT_HALF_LIFE}), 0 for no decay` },
|
|
1438
1520
|
bulk: { type: "string", description: `leave out the commits touching more files than this (${DEFAULT_BULK})` },
|
|
1439
1521
|
...limitOptions(DEFAULT_COUNT),
|
|
1440
1522
|
all: { type: "boolean", short: "a", description: "keep test files and generated files" },
|
|
1441
|
-
|
|
1523
|
+
"by-lines": { type: "boolean", description: "score complexity times the lines changed (decayed like the commits) instead of the commits" },
|
|
1524
|
+
json: jsonOption("[{rank, path, score, churn, recent, changed, authors, solo, complexity, worst, lines}], never cut unless --limit is given; changed counts the lines added and deleted, solo being true for a file one author edited")
|
|
1442
1525
|
};
|
|
1443
1526
|
var HOT = 0.66;
|
|
1444
1527
|
var WARM = 0.33;
|
|
1445
1528
|
async function hotspots(args) {
|
|
1446
|
-
const { values, positionals } = parse(args, USAGE, OPTIONS, { positionals: ["[dir]"], replaces: "guessing which files are worth splitting first", examples: ["hotspots", 'hotspots src --since "3 months ago" --limit 10'] });
|
|
1529
|
+
const { values, positionals } = parse(args, USAGE, OPTIONS, { exits: EXITS, positionals: ["[dir]"], replaces: "guessing which files are worth splitting first", examples: ["hotspots", 'hotspots src --since "3 months ago" --limit 10'] });
|
|
1447
1530
|
if (positionals.length > 1)
|
|
1448
1531
|
badUsage("give one folder");
|
|
1449
1532
|
const count = limitOf(values, DEFAULT_COUNT);
|
|
1450
|
-
const cwd =
|
|
1533
|
+
const cwd = process16.cwd();
|
|
1451
1534
|
const bulk = Number(values.bulk ?? DEFAULT_BULK);
|
|
1452
1535
|
if (!Number.isInteger(bulk) || bulk < 1)
|
|
1453
1536
|
badUsage(`--bulk takes a number of files, not ${values.bulk}`);
|
|
@@ -1465,7 +1548,7 @@ async function hotspots(args) {
|
|
|
1465
1548
|
continue;
|
|
1466
1549
|
const complexity = complexityOf(text);
|
|
1467
1550
|
const worst = worstUnit(text, path);
|
|
1468
|
-
ranked.push({ path, score: Math.round(complexity * touched.weight), churn: touched.commits, recent: Math.round(touched.weight * 10) / 10, complexity, worst: worst === undefined ? undefined : { name: worst.name, line: worst.line, complexity: worst.complexity }, lines: text.split(`
|
|
1551
|
+
ranked.push({ path, score: Math.round(complexity * (values["by-lines"] === true ? touched.linesWeight : touched.weight)), churn: touched.commits, recent: Math.round(touched.weight * 10) / 10, changed: touched.lines, authors: touched.authors, solo: touched.authors === 1, complexity, worst: worst === undefined ? undefined : { name: worst.name, line: worst.line, complexity: worst.complexity }, lines: text.split(`
|
|
1469
1552
|
`).length - (text.endsWith(`
|
|
1470
1553
|
`) ? 1 : 0) });
|
|
1471
1554
|
}
|
|
@@ -1478,8 +1561,8 @@ async function hotspots(args) {
|
|
|
1478
1561
|
printJson(shown);
|
|
1479
1562
|
return 0;
|
|
1480
1563
|
}
|
|
1481
|
-
const colors = paint(
|
|
1482
|
-
const path = role("path",
|
|
1564
|
+
const colors = paint(process16.stdout);
|
|
1565
|
+
const path = role("path", process16.stdout);
|
|
1483
1566
|
const top = shown.reduce((highest, row) => Math.max(highest, row.score), 0);
|
|
1484
1567
|
const heat = (score, text) => {
|
|
1485
1568
|
if (top > 0 && score >= top * HOT)
|
|
@@ -1487,22 +1570,24 @@ async function hotspots(args) {
|
|
|
1487
1570
|
return top > 0 && score >= top * WARM ? colors.yellow(text) : text;
|
|
1488
1571
|
};
|
|
1489
1572
|
printHeader("hotspots", `${basename(cwd)} \xB7 since ${values.since ?? DEFAULT_SINCE}`);
|
|
1490
|
-
console.log(table([["rank", "score", "churn", "recent", "complexity", "lines", "file", "most complex declaration"], ...shown.map((row) => [colors.dim(String(row.rank)), heat(row.score, String(row.score)), ...[row.churn, row.recent, row.complexity, row.lines].map(String), fileLink(path(row.path), row.path,
|
|
1573
|
+
console.log(table([["rank", "score", "churn", "recent", "changed", "authors", "complexity", "lines", "file", "most complex declaration"], ...shown.map((row) => [colors.dim(String(row.rank)), heat(row.score, String(row.score)), ...[row.churn, row.recent, row.changed].map(String), row.solo ? colors.dim("1 solo") : String(row.authors), ...[row.complexity, row.lines].map(String), fileLink(path(row.path), row.path, process16.stdout, cwd), row.worst === undefined ? "" : `${row.worst.name} (${row.worst.complexity}, line ${row.worst.line})`])], { header: true, align: ["right", "right", "right", "right", "right", "right", "right", "right", "left", "left"] }));
|
|
1491
1574
|
if (footer !== undefined)
|
|
1492
1575
|
console.log(footer);
|
|
1493
1576
|
return 0;
|
|
1494
1577
|
}
|
|
1495
1578
|
|
|
1496
1579
|
// src/peek.ts
|
|
1497
|
-
import { realpathSync as
|
|
1498
|
-
import { isAbsolute as isAbsolute2, join as join8, relative as relative2, resolve as
|
|
1499
|
-
import
|
|
1580
|
+
import { realpathSync as realpathSync3 } from "fs";
|
|
1581
|
+
import { isAbsolute as isAbsolute2, join as join8, relative as relative2, resolve as resolve5, sep } from "path";
|
|
1582
|
+
import process17 from "process";
|
|
1500
1583
|
|
|
1501
1584
|
// src/source.ts
|
|
1502
1585
|
var LOCATION = /^(?:\.\/)?([^\s:()]+)(?::(\d+)(?::\d+)?|\((\d+),\d+\))(?=[:\s)]|$)/;
|
|
1503
|
-
var DECLARATION = /^(?:
|
|
1504
|
-
var
|
|
1505
|
-
var
|
|
1586
|
+
var DECLARATION = /^(?:(?:export|default|declare|abstract|async|pub(?:\([^)]*\))?|public|private|protected|internal|final|open|sealed|static|suspend)\s+)*(?:function\*?|class|interface|type|enum|const|let|var|namespace|module|def|func|fun|fn|struct|trait|impl)\s/;
|
|
1587
|
+
var MODIFIER_WORDS = String.raw`(?:public|private|protected|internal|final|open|sealed|static|async|suspend|override|readonly|abstract|get|set|pub(?:\([^)]*\))?|function|fn|def|func|fun)\s+`;
|
|
1588
|
+
var RETURN_TYPE = String.raw`(?:[\w$.]+(?:<[^>]*>)?(?:\[\])*\??\s+(?=[#\w$]+\s*(?:<[^>]*>\s*)?\())?`;
|
|
1589
|
+
var MODIFIERS = new RegExp(String.raw`^(?:(?:${MODIFIER_WORDS})+${RETURN_TYPE})?`);
|
|
1590
|
+
var MEMBER = new RegExp(String.raw`^(?:(?:${MODIFIER_WORDS})+${RETURN_TYPE})?[#\w$]+\s*(?:<[^>]*>\s*)?\(`);
|
|
1506
1591
|
var RECEIVER = /^(?:\([^)]*\)\s*)?/;
|
|
1507
1592
|
var STAR = /^\*?\s*/;
|
|
1508
1593
|
var HOLDS_MEMBERS = /\b(?:class|interface|trait|impl|struct)\s/;
|
|
@@ -1632,7 +1717,7 @@ function outline(text, path) {
|
|
|
1632
1717
|
if (indent === 0 && DECLARATION.test(text) && !LOCAL_BINDING.test(text)) {
|
|
1633
1718
|
entries.push({ line: i + 1, depth: 0, text: signature(line) });
|
|
1634
1719
|
memberIndent = HOLDS_MEMBERS.test(text) ? -1 : undefined;
|
|
1635
|
-
} else if (indent === 0 && text !== "" && !text.startsWith("}") && !LEADING.test(text)) {
|
|
1720
|
+
} else if (indent === 0 && text !== "" && !text.startsWith("{") && !text.startsWith("}") && !LEADING.test(text)) {
|
|
1636
1721
|
memberIndent = undefined;
|
|
1637
1722
|
} else if (memberIndent !== undefined && indent > 0 && (memberIndent === -1 || indent === memberIndent) && MEMBER.test(text) && !CALL_KEYWORDS.test(text)) {
|
|
1638
1723
|
memberIndent = indent;
|
|
@@ -1681,9 +1766,8 @@ peek --around <regex> [-C 3] [path...] the lines around each match, overlapping
|
|
|
1681
1766
|
<output> | peek [-C 3] the lines around each path:line the output opens a line with (errs, rg -n, grep -n, tsc, linters)
|
|
1682
1767
|
The paths default to the files git keeps here (.gitignore holds).
|
|
1683
1768
|
--refs lists at most 100 lines and --around prints at most 20 spans, the count of the rest after them (--limit <n>, --full for all).
|
|
1684
|
-
--json prints spans as [{path, from, to, lines}], --refs as [{path, line, text}] ({definitions, references} with --defs-first), --outline as [{path, line, depth, text}], the lines never cut and the rows never counted off unless --limit is given
|
|
1685
|
-
|
|
1686
|
-
Exits 0 when it printed something, 1 when nothing is found, a file cannot be read or a span starts past the end, 2 on a usage error or a path outside the repository.`;
|
|
1769
|
+
--json prints spans as [{path, from, to, lines}], --refs as [{path, line, text}] ({definitions, references} with --defs-first), --outline as [{path, line, depth, text}], the lines never cut and the rows never counted off unless --limit is given.`;
|
|
1770
|
+
var EXITS2 = [[0, "it printed something"], [1, "nothing is found, a file cannot be read or a span starts past the end"], [2, "a usage error or a path outside the repository"]];
|
|
1687
1771
|
var REFS_LIMIT = 100;
|
|
1688
1772
|
var AROUND_LIMIT = 20;
|
|
1689
1773
|
var PARENT = `..${sep}`;
|
|
@@ -1704,13 +1788,13 @@ function cut(text) {
|
|
|
1704
1788
|
return text.length > LONGEST_LINE ? `${text.slice(0, LONGEST_LINE - 1)}\u2026` : text;
|
|
1705
1789
|
}
|
|
1706
1790
|
async function readableRoot() {
|
|
1707
|
-
const ran = await runCommand(["git", "rev-parse", "--show-toplevel"], { cwd:
|
|
1708
|
-
return
|
|
1791
|
+
const ran = await runCommand(["git", "rev-parse", "--show-toplevel"], { cwd: process17.cwd() });
|
|
1792
|
+
return realpathSync3(ran.code === 0 ? ran.text.trim() : process17.cwd());
|
|
1709
1793
|
}
|
|
1710
1794
|
async function isOutside(path) {
|
|
1711
1795
|
let real;
|
|
1712
1796
|
try {
|
|
1713
|
-
real =
|
|
1797
|
+
real = realpathSync3(resolve5(process17.cwd(), path));
|
|
1714
1798
|
} catch {
|
|
1715
1799
|
return false;
|
|
1716
1800
|
}
|
|
@@ -1724,7 +1808,7 @@ async function checkInside(path) {
|
|
|
1724
1808
|
async function pipedSpans(text, context) {
|
|
1725
1809
|
const spans = [];
|
|
1726
1810
|
for (const [path, numbers] of locations(text)) {
|
|
1727
|
-
const source = await isOutside(path) ? undefined : await readText(
|
|
1811
|
+
const source = await isOutside(path) ? undefined : await readText(resolve5(process17.cwd(), path));
|
|
1728
1812
|
if (source !== undefined)
|
|
1729
1813
|
spans.push(...spansAround(path, source.replace(TRAILING_NEWLINE2, "").split(`
|
|
1730
1814
|
`).length, numbers, context));
|
|
@@ -1733,7 +1817,7 @@ async function pipedSpans(text, context) {
|
|
|
1733
1817
|
}
|
|
1734
1818
|
async function textOf(path) {
|
|
1735
1819
|
await checkInside(path);
|
|
1736
|
-
const text = await readText(
|
|
1820
|
+
const text = await readText(resolve5(process17.cwd(), path));
|
|
1737
1821
|
if (text === undefined)
|
|
1738
1822
|
fail(`cannot read ${path} (missing, binary or too large)`, 1);
|
|
1739
1823
|
return text;
|
|
@@ -1791,8 +1875,8 @@ async function spanOf(target) {
|
|
|
1791
1875
|
async function* sources(paths) {
|
|
1792
1876
|
for (const path of paths)
|
|
1793
1877
|
await checkInside(path);
|
|
1794
|
-
for (const path of await listFiles(paths,
|
|
1795
|
-
const text = await readText(join8(
|
|
1878
|
+
for (const path of await listFiles(paths, process17.cwd())) {
|
|
1879
|
+
const text = await readText(join8(process17.cwd(), path));
|
|
1796
1880
|
if (text !== undefined)
|
|
1797
1881
|
yield { path, text };
|
|
1798
1882
|
}
|
|
@@ -1816,7 +1900,7 @@ async function definitionsOf(symbols, paths) {
|
|
|
1816
1900
|
return [...found.values()].flat();
|
|
1817
1901
|
}
|
|
1818
1902
|
async function peek(args) {
|
|
1819
|
-
const { values, positionals } = parse(args, USAGE2, OPTIONS2, { positionals: ["[target...]"], replaces: "sed -n N,Mp, grep -n chains and whole-file reads", examples: [["peek src/a.ts:120-140 src/b.ts:1-40", "two spans in one call"], ["peek --def parseArgs src", "a whole declaration"]] });
|
|
1903
|
+
const { values, positionals } = parse(args, USAGE2, OPTIONS2, { exits: EXITS2, positionals: ["[target...]"], replaces: "sed -n N,Mp, grep -n chains and whole-file reads", examples: [["peek src/a.ts:120-140 src/b.ts:1-40", "two spans in one call"], ["peek --def parseArgs src", "a whole declaration"]] });
|
|
1820
1904
|
const modes = [values.def?.length === 0 ? undefined : values.def, values.refs, values.outline, values.around].filter((mode) => mode !== undefined && mode !== false);
|
|
1821
1905
|
const json = values.json === true;
|
|
1822
1906
|
if (values["defs-first"] === true && values.refs === undefined)
|
|
@@ -1893,14 +1977,14 @@ async function peek(args) {
|
|
|
1893
1977
|
|
|
1894
1978
|
// src/todo-scan.ts
|
|
1895
1979
|
import { join as join9 } from "path";
|
|
1896
|
-
import
|
|
1980
|
+
import process18 from "process";
|
|
1897
1981
|
|
|
1898
1982
|
// src/todo.ts
|
|
1899
|
-
var
|
|
1983
|
+
var COMMENT = /(?<![:\w/])\/\/|\/\*|<!--|(?:^|\s)(?:#|--)(?=\s)|^\s*\*(?=\s|$)/;
|
|
1900
1984
|
var MARKUP = /\.(?:md|mdx|markdown|html?|xml)$/i;
|
|
1901
1985
|
var MARKUP_COMMENT = /<!--/;
|
|
1902
1986
|
var CLOSERS = /\s*(?:\*\/|-->)\s*$/;
|
|
1903
|
-
var MARKER = /^(?:@|\[)?(TODO|FIXME)\b/;
|
|
1987
|
+
var MARKER = /^(?:@|\[)?(TODO|FIXME|HACK|XXX)\b/;
|
|
1904
1988
|
var QUOTES = ["'", '"', "`"];
|
|
1905
1989
|
var ESCAPE2 = /\\./g;
|
|
1906
1990
|
var AFTER_FIRST_LINE = /\n[\s\S]*/;
|
|
@@ -1909,9 +1993,43 @@ function isQuoted(line, index) {
|
|
|
1909
1993
|
const before = line.slice(0, index).replaceAll(ESCAPE2, "");
|
|
1910
1994
|
return QUOTES.some((quote) => before.split(quote).length % 2 === 0);
|
|
1911
1995
|
}
|
|
1996
|
+
var BLAME_HEADER = /^[0-9a-f]{40} \d+ (\d+)/;
|
|
1997
|
+
var DAY_S = 86400;
|
|
1998
|
+
async function commitTimes(path, cwd) {
|
|
1999
|
+
const blamed = await runCommand(["git", "blame", "--porcelain", "--", path], { cwd });
|
|
2000
|
+
const times = new Map;
|
|
2001
|
+
if (blamed.code !== 0)
|
|
2002
|
+
return times;
|
|
2003
|
+
const bySha = new Map;
|
|
2004
|
+
let sha = "";
|
|
2005
|
+
let line = 0;
|
|
2006
|
+
for (const row of stdoutOf(blamed.chunks).split(`
|
|
2007
|
+
`)) {
|
|
2008
|
+
const header = BLAME_HEADER.exec(row);
|
|
2009
|
+
if (header !== null) {
|
|
2010
|
+
sha = row.slice(0, 40);
|
|
2011
|
+
line = Number(header[1]);
|
|
2012
|
+
} else if (row.startsWith("committer-time ")) {
|
|
2013
|
+
bySha.set(sha, Number(row.slice("committer-time ".length)));
|
|
2014
|
+
} else if (row.startsWith("\t")) {
|
|
2015
|
+
times.set(line, bySha.get(sha) ?? 0);
|
|
2016
|
+
}
|
|
2017
|
+
}
|
|
2018
|
+
return times;
|
|
2019
|
+
}
|
|
2020
|
+
async function addAges(marks, cwd, now = Date.now() / 1000) {
|
|
2021
|
+
await Promise.all([...Map.groupBy(marks, (mark) => mark.path)].map(async ([path, ofFile]) => {
|
|
2022
|
+
const times = await commitTimes(path, cwd);
|
|
2023
|
+
for (const mark of ofFile) {
|
|
2024
|
+
const time = times.get(mark.line);
|
|
2025
|
+
if (time !== undefined)
|
|
2026
|
+
mark.age = Math.max(0, Math.floor((now - time) / DAY_S));
|
|
2027
|
+
}
|
|
2028
|
+
}));
|
|
2029
|
+
}
|
|
1912
2030
|
function marksIn(text, path) {
|
|
1913
2031
|
const marks = [];
|
|
1914
|
-
const comment = MARKUP.test(path) ? MARKUP_COMMENT :
|
|
2032
|
+
const comment = MARKUP.test(path) ? MARKUP_COMMENT : COMMENT;
|
|
1915
2033
|
for (const [i, line] of text.split(`
|
|
1916
2034
|
`).entries()) {
|
|
1917
2035
|
const opener = comment.exec(line);
|
|
@@ -1964,18 +2082,21 @@ async function lookUp(refs, cwd) {
|
|
|
1964
2082
|
}
|
|
1965
2083
|
|
|
1966
2084
|
// src/todo-scan.ts
|
|
1967
|
-
var USAGE3 = `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
|
|
2085
|
+
var USAGE3 = `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
|
|
1968
2086
|
|
|
1969
|
-
--
|
|
2087
|
+
--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.
|
|
1970
2088
|
|
|
1971
|
-
|
|
2089
|
+
--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.
|
|
1972
2090
|
|
|
1973
|
-
|
|
2091
|
+
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.`;
|
|
2092
|
+
var EXITS3 = [[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)"]];
|
|
1974
2093
|
var LIST_LIMIT = 100;
|
|
2094
|
+
var DAY_MS3 = 86400000;
|
|
1975
2095
|
var OPTIONS3 = {
|
|
1976
2096
|
stale: { type: "boolean", description: "only the comments naming a closed issue, looked up with ft or gh" },
|
|
2097
|
+
older: { type: "string", description: "only the comments whose line last changed longer ago than this duration, from git blame" },
|
|
1977
2098
|
...limitOptions(LIST_LIMIT),
|
|
1978
|
-
json: jsonOption("[{path, line, kind, text, refs: [{repo, number, state?}]}]")
|
|
2099
|
+
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")
|
|
1979
2100
|
};
|
|
1980
2101
|
function printLines(lines, footer) {
|
|
1981
2102
|
const all = [...lines, ...footer === undefined ? [] : [footer]];
|
|
@@ -1984,21 +2105,28 @@ function printLines(lines, footer) {
|
|
|
1984
2105
|
`));
|
|
1985
2106
|
}
|
|
1986
2107
|
async function todoScan(args) {
|
|
1987
|
-
const { values, positionals } = parse(args, USAGE3, OPTIONS3, { 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"]] });
|
|
1988
|
-
const cwd =
|
|
2108
|
+
const { values, positionals } = parse(args, USAGE3, OPTIONS3, { exits: EXITS3, 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"]] });
|
|
2109
|
+
const cwd = process18.cwd();
|
|
1989
2110
|
const limit = limitOf(values, LIST_LIMIT);
|
|
1990
|
-
const
|
|
2111
|
+
const found = [];
|
|
1991
2112
|
for (const path of await listFiles(positionals, cwd)) {
|
|
1992
2113
|
const text = await readText(join9(cwd, path));
|
|
1993
2114
|
if (text !== undefined)
|
|
1994
|
-
|
|
1995
|
-
}
|
|
2115
|
+
found.push(...marksIn(text, path));
|
|
2116
|
+
}
|
|
2117
|
+
const older = values.older === undefined ? undefined : duration(values.older, "older", 0, "m") / DAY_MS3;
|
|
2118
|
+
let marks = found;
|
|
2119
|
+
if (older !== undefined || values.json === true)
|
|
2120
|
+
await addAges(found, cwd);
|
|
2121
|
+
const ageNote = (mark) => older === undefined || mark.age === undefined ? "" : ` [${mark.age}d]`;
|
|
2122
|
+
if (older !== undefined)
|
|
2123
|
+
marks = found.filter((mark) => mark.age !== undefined && mark.age >= older);
|
|
1996
2124
|
if (values.stale !== true) {
|
|
1997
2125
|
const { shown, footer } = capped(marks, limit);
|
|
1998
2126
|
if (values.json === true)
|
|
1999
2127
|
printJson(shown);
|
|
2000
2128
|
else
|
|
2001
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}`), footer);
|
|
2129
|
+
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}${ageNote(mark)}`), footer);
|
|
2002
2130
|
return 0;
|
|
2003
2131
|
}
|
|
2004
2132
|
const { states, failed } = await lookUp(marks.flatMap((mark) => mark.refs), cwd);
|
|
@@ -2009,14 +2137,14 @@ async function todoScan(args) {
|
|
|
2009
2137
|
if (values.json === true)
|
|
2010
2138
|
printJson(shown.map((mark) => ({ ...mark, refs: mark.refs.map((ref) => ({ ...ref, state: states.get(refKey(ref)) })) })));
|
|
2011
2139
|
else
|
|
2012
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.refs.filter((ref) => states.get(refKey(ref)) === "closed").map(refKey).join(", ")} closed: ${mark.text}`), footer);
|
|
2140
|
+
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);
|
|
2013
2141
|
if (stale.length > 0)
|
|
2014
2142
|
return 1;
|
|
2015
2143
|
return failed.size > 0 ? 2 : 0;
|
|
2016
2144
|
}
|
|
2017
2145
|
|
|
2018
2146
|
// src/cli.ts
|
|
2019
|
-
|
|
2147
|
+
process19.exitCode = await runCli({
|
|
2020
2148
|
name: "src",
|
|
2021
2149
|
about: "reads and ranks the source of a folder: line spans, TODO comments and the files worth splitting",
|
|
2022
2150
|
replaces: "sed -n N,Mp, grep -n chains and grep -rn TODO",
|