@kaynooo/cli-code 0.14.3 → 0.15.1
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 +257 -68
- package/dist/hotspots-cli.js +186 -44
- package/dist/peek-cli.js +170 -36
- package/dist/todo-scan-cli.js +210 -33
- 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,7 +499,7 @@ 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)) {
|
|
@@ -521,29 +538,40 @@ function exampleRows(examples, colors = paint(process8.stdout)) {
|
|
|
521
538
|
return [];
|
|
522
539
|
return ["", colors.bold("Examples:"), ...examples.map((example) => typeof example === "string" ? ` ${example}` : ` ${example[0]} ${colors.dim(`# ${example[1]}`)}`)];
|
|
523
540
|
}
|
|
541
|
+
var MAX_INLINE_CHOICES = 24;
|
|
524
542
|
function optionRows(options, colors = paint(process8.stdout)) {
|
|
525
543
|
const rows = Object.entries(options).map(([name, option]) => {
|
|
526
544
|
const short = option.short === undefined ? " " : `${colors.cyan(`-${option.short}`)}, `;
|
|
527
|
-
const
|
|
545
|
+
const choices = option.choices?.join("|");
|
|
546
|
+
const inline = choices !== undefined && choices.length <= MAX_INLINE_CHOICES;
|
|
547
|
+
const named = inline ? `<${choices}>` : "<value>";
|
|
528
548
|
const placeholder = option.optional === undefined ? named : `[${named}]`;
|
|
529
549
|
const value = option.type === "string" ? ` ${colors.dim(placeholder)}` : "";
|
|
530
|
-
|
|
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 };
|
|
531
552
|
});
|
|
532
553
|
const width = Math.max(0, ...rows.map((row) => row.width));
|
|
533
554
|
return rows.map((row) => row.description === "" ? ` ${row.flag}` : ` ${row.flag}${" ".repeat(width - row.width)} ${colors.dim(row.description)}`);
|
|
534
555
|
}
|
|
535
556
|
|
|
536
557
|
// ../kit/src/text.ts
|
|
537
|
-
var ANSI = new RegExp(`${String.fromCharCode(27)}\\[[\\d;?]*[a-z]`, "gi");
|
|
538
558
|
function distance(a, b) {
|
|
539
|
-
|
|
540
|
-
|
|
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()) {
|
|
541
564
|
const current = [i + 1];
|
|
542
|
-
for (const [j,
|
|
543
|
-
|
|
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;
|
|
544
572
|
previous = current;
|
|
545
573
|
}
|
|
546
|
-
return previous[
|
|
574
|
+
return previous[right.length] ?? 0;
|
|
547
575
|
}
|
|
548
576
|
function closest(name, names) {
|
|
549
577
|
const started = names.find((known) => known.startsWith(name));
|
|
@@ -624,7 +652,7 @@ class Completing {
|
|
|
624
652
|
}
|
|
625
653
|
var completion = { active: false };
|
|
626
654
|
var OUTPUT_OPTIONS = {
|
|
627
|
-
color: { type: "string", description: "auto (on a terminal alone
|
|
655
|
+
color: { type: "string", choices: ["auto", "always", "never"], description: "auto (the default) colours on a terminal alone" },
|
|
628
656
|
plain: { type: "boolean", description: "plain text, no colour or spinner: --color never" }
|
|
629
657
|
};
|
|
630
658
|
function applyOutput(color, plain, env = process9.env) {
|
|
@@ -918,13 +946,91 @@ var CLOSE_LINK = `${ESC}]8;;${ESC}\\`;
|
|
|
918
946
|
// ../kit/src/cli.ts
|
|
919
947
|
import { readFileSync as readFileSync4, realpathSync as realpathSync2 } from "fs";
|
|
920
948
|
import { dirname as dirname3, join as join5 } from "path";
|
|
921
|
-
import
|
|
949
|
+
import process14 from "process";
|
|
950
|
+
|
|
951
|
+
// ../kit/src/completions.ts
|
|
952
|
+
var COMPLETION_SHELLS = ["fish", "bash", "zsh"];
|
|
953
|
+
var FISH_FUNCTION = `functions -q __kaynooo_cli_complete; or function __kaynooo_cli_complete --argument-names bin --description 'what a @kaynooo/cli-kit bin offers for the word being typed'
|
|
954
|
+
set -l tokens (commandline -xpc 2>/dev/null; or commandline -opc)
|
|
955
|
+
set -l current (commandline -ct)
|
|
956
|
+
for line in ($bin __complete $tokens[2..-1] $current 2>/dev/null)
|
|
957
|
+
if test "$line" = __files__
|
|
958
|
+
__fish_complete_path $current
|
|
959
|
+
else
|
|
960
|
+
echo $line
|
|
961
|
+
end
|
|
962
|
+
end
|
|
963
|
+
end`;
|
|
964
|
+
var BASH_FUNCTION = `__kaynooo_cli_complete() {
|
|
965
|
+
local IFS=$'\\n' cur=\${COMP_WORDS[COMP_CWORD]} line words=
|
|
966
|
+
local -a lines
|
|
967
|
+
COMPREPLY=()
|
|
968
|
+
lines=($("\${COMP_WORDS[0]}" __complete "\${COMP_WORDS[@]:1:COMP_CWORD}" 2>/dev/null))
|
|
969
|
+
for line in "\${lines[@]}"; do
|
|
970
|
+
if [[ $line == __files__ ]]; then
|
|
971
|
+
COMPREPLY+=($(compgen -f -- "$cur"))
|
|
972
|
+
else
|
|
973
|
+
words+="\${line%%$'\\t'*}"$'\\n'
|
|
974
|
+
fi
|
|
975
|
+
done
|
|
976
|
+
COMPREPLY+=($(compgen -W "$words" -- "$cur"))
|
|
977
|
+
}`;
|
|
978
|
+
var ZSH_FUNCTION = `__kaynooo_cli_complete() {
|
|
979
|
+
local line
|
|
980
|
+
local -a described plain
|
|
981
|
+
for line in \${(f)"$("\${words[1]}" __complete "\${(@)words[2,CURRENT]}" 2>/dev/null)"}; do
|
|
982
|
+
if [[ $line == __files__ ]]; then
|
|
983
|
+
_files
|
|
984
|
+
elif [[ $line == *$'\\t'* ]]; then
|
|
985
|
+
described+=("\${\${line%%$'\\t'*}//:/\\\\:}:\${line#*$'\\t'}")
|
|
986
|
+
else
|
|
987
|
+
plain+=("$line")
|
|
988
|
+
fi
|
|
989
|
+
done
|
|
990
|
+
(( \${#described} )) && _describe -V value described
|
|
991
|
+
(( \${#plain} )) && compadd -- "\${plain[@]}"
|
|
992
|
+
return 0
|
|
993
|
+
}`;
|
|
994
|
+
function completionScript(shell, bins, header = `# Generated by \`${bins[0]} --completions ${shell}\``) {
|
|
995
|
+
if (shell === "fish")
|
|
996
|
+
return `${header}
|
|
997
|
+
${FISH_FUNCTION}
|
|
998
|
+
${bins.map((bin) => `complete -c ${bin} -f -a '(__kaynooo_cli_complete ${bin})'
|
|
999
|
+
`).join("")}`;
|
|
1000
|
+
if (shell === "bash")
|
|
1001
|
+
return `${header}
|
|
1002
|
+
${BASH_FUNCTION}
|
|
1003
|
+
complete -F __kaynooo_cli_complete ${bins.join(" ")}
|
|
1004
|
+
`;
|
|
1005
|
+
return `${header}
|
|
1006
|
+
${ZSH_FUNCTION}
|
|
1007
|
+
compdef __kaynooo_cli_complete ${bins.join(" ")}
|
|
1008
|
+
`;
|
|
1009
|
+
}
|
|
1010
|
+
|
|
1011
|
+
// ../kit/src/notify.ts
|
|
1012
|
+
import process12 from "process";
|
|
1013
|
+
var NOTIFY_AFTER_MS = 1e4;
|
|
1014
|
+
var CANCELLED = 130;
|
|
1015
|
+
function base64(text) {
|
|
1016
|
+
return Buffer.from(text).toString("base64");
|
|
1017
|
+
}
|
|
1018
|
+
function notification(title, body, env = process12.env) {
|
|
1019
|
+
const id = `kit${process12.pid}`;
|
|
1020
|
+
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\\`];
|
|
1021
|
+
return codes.map((code) => env.TMUX === undefined || env.TMUX === "" ? code : `\x1BPtmux;${code.replaceAll("\x1B", "\x1B\x1B")}\x1B\\`).join("");
|
|
1022
|
+
}
|
|
1023
|
+
function notifyEnd(command, code, ms, { stream = process12.stderr, env = process12.env } = {}) {
|
|
1024
|
+
if (ms < NOTIFY_AFTER_MS || code === CANCELLED || outputMode(stream, env) !== "terminal")
|
|
1025
|
+
return;
|
|
1026
|
+
stream.write(notification(command, code === 0 ? `done in ${formatDuration(ms)}` : `failed with exit ${code} after ${formatDuration(ms)}`, env));
|
|
1027
|
+
}
|
|
922
1028
|
|
|
923
1029
|
// ../kit/src/usage.ts
|
|
924
1030
|
import { appendFileSync, mkdirSync } from "fs";
|
|
925
1031
|
import { homedir as homedir3 } from "os";
|
|
926
1032
|
import { dirname as dirname2, isAbsolute, join as join4 } from "path";
|
|
927
|
-
import
|
|
1033
|
+
import process13 from "process";
|
|
928
1034
|
|
|
929
1035
|
// ../kit/src/logs.ts
|
|
930
1036
|
var DAY_MS = 24 * 60 * 60 * 1000;
|
|
@@ -938,14 +1044,14 @@ var usageError;
|
|
|
938
1044
|
function noteUsageError(message) {
|
|
939
1045
|
usageError = message;
|
|
940
1046
|
}
|
|
941
|
-
function stateHome(env =
|
|
1047
|
+
function stateHome(env = process13.env) {
|
|
942
1048
|
const dir = env.XDG_STATE_HOME;
|
|
943
1049
|
return dir !== undefined && isAbsolute(dir) ? dir : join4(homedir3(), ".local", "state");
|
|
944
1050
|
}
|
|
945
|
-
function usagePath(env =
|
|
1051
|
+
function usagePath(env = process13.env) {
|
|
946
1052
|
return join4(stateHome(env), CLI_FOLDER, "usage.jsonl");
|
|
947
1053
|
}
|
|
948
|
-
function usageRecorded(env =
|
|
1054
|
+
function usageRecorded(env = process13.env) {
|
|
949
1055
|
const off = env.KAYNOOO_CLI_NO_USAGE;
|
|
950
1056
|
return env.NODE_ENV !== "test" && (off === undefined || off === "" || off === "0");
|
|
951
1057
|
}
|
|
@@ -959,7 +1065,7 @@ function usageEntry(bin, command, argv, code, now = new Date) {
|
|
|
959
1065
|
usageError = undefined;
|
|
960
1066
|
return { at: now.toISOString(), bin, ...command === undefined ? {} : { command }, flags: flagNames(argv), code, ...unknown === undefined ? {} : { unknown } };
|
|
961
1067
|
}
|
|
962
|
-
function recordUsage(entry, env =
|
|
1068
|
+
function recordUsage(entry, env = process13.env) {
|
|
963
1069
|
if (!usageRecorded(env))
|
|
964
1070
|
return;
|
|
965
1071
|
try {
|
|
@@ -975,7 +1081,11 @@ var LEVEL_OPTIONS = {
|
|
|
975
1081
|
...OUTPUT_OPTIONS,
|
|
976
1082
|
help: { type: "boolean", short: "h", description: "show this help" }
|
|
977
1083
|
};
|
|
978
|
-
var TOP_OPTIONS = {
|
|
1084
|
+
var TOP_OPTIONS = {
|
|
1085
|
+
...LEVEL_OPTIONS,
|
|
1086
|
+
version: { type: "boolean", short: "v", description: "print the version" },
|
|
1087
|
+
completions: { type: "string", choices: COMPLETION_SHELLS, description: "print the shell completion script" }
|
|
1088
|
+
};
|
|
979
1089
|
async function commandRows(all, colors) {
|
|
980
1090
|
const commands = shown(all);
|
|
981
1091
|
const width = Math.max(0, ...Object.keys(commands).map((name) => name.length));
|
|
@@ -1049,8 +1159,8 @@ async function help2({ path, header, summary: lazySummary, commands, defaultComm
|
|
|
1049
1159
|
`);
|
|
1050
1160
|
}
|
|
1051
1161
|
function printError(prefix, message, hint, cause) {
|
|
1052
|
-
const colors = paint(
|
|
1053
|
-
const styled = takesControlCodes(
|
|
1162
|
+
const colors = paint(process14.stderr);
|
|
1163
|
+
const styled = takesControlCodes(process14.stderr);
|
|
1054
1164
|
const head = styled ? `${colors.red.bold("error")} ${colors.dim(`${prefix}:`)}` : `error: ${prefix}:`;
|
|
1055
1165
|
const under = (label, text, tint) => text === undefined ? "" : `
|
|
1056
1166
|
${styled ? tint(label) : `${label}:`} ${text}`;
|
|
@@ -1093,11 +1203,11 @@ async function dispatch(level, typed, { version, redact }) {
|
|
|
1093
1203
|
}
|
|
1094
1204
|
}
|
|
1095
1205
|
if (name === undefined && level.path.length > 1) {
|
|
1096
|
-
console.error(await help2(await expand(level, [...level.path.slice(1), ...argv]),
|
|
1206
|
+
console.error(await help2(await expand(level, [...level.path.slice(1), ...argv]), process14.stderr));
|
|
1097
1207
|
return 2;
|
|
1098
1208
|
}
|
|
1099
1209
|
if (name === undefined || name === "help" || name === "--help" || name === "-h") {
|
|
1100
|
-
console.log(await help2(await expand(level, [...level.path.slice(1), ...argv]),
|
|
1210
|
+
console.log(await help2(await expand(level, [...level.path.slice(1), ...argv]), process14.stdout));
|
|
1101
1211
|
return 0;
|
|
1102
1212
|
}
|
|
1103
1213
|
if (level.path.length === 1 && (name === "--version" || name === "-v")) {
|
|
@@ -1208,6 +1318,19 @@ async function candidates(scope, defaultCommand, words, before = []) {
|
|
|
1208
1318
|
}
|
|
1209
1319
|
return "commands" in command ? candidates(scopeOf(command.commands, command.extraCommands, command.aliases), undefined, rest, [...before, word]) : leafCandidates(command.run, rest);
|
|
1210
1320
|
}
|
|
1321
|
+
var COMPLETIONS = "--completions";
|
|
1322
|
+
function flagValue([flag = "", ...rest]) {
|
|
1323
|
+
return flag.includes("=") ? [flag.slice(flag.indexOf("=") + 1), ...rest] : rest;
|
|
1324
|
+
}
|
|
1325
|
+
function printCompletionScript(name, args) {
|
|
1326
|
+
const shell = COMPLETION_SHELLS.find((each) => each === args[0]);
|
|
1327
|
+
if (shell === undefined || args.length !== 1) {
|
|
1328
|
+
printError(name, `${COMPLETIONS} takes one of ${COMPLETION_SHELLS.join(", ")}`, `${name} ${COMPLETIONS} fish`);
|
|
1329
|
+
return 2;
|
|
1330
|
+
}
|
|
1331
|
+
console.log(completionScript(shell, [name]).trimEnd());
|
|
1332
|
+
return 0;
|
|
1333
|
+
}
|
|
1211
1334
|
async function printCandidates(found) {
|
|
1212
1335
|
for (const line of await found)
|
|
1213
1336
|
console.log(line);
|
|
@@ -1232,10 +1355,15 @@ async function runCli(cli, argv = scriptArgs()) {
|
|
|
1232
1355
|
const version = cli.version ?? packageVersion();
|
|
1233
1356
|
if (argv[0] === COMPLETE)
|
|
1234
1357
|
return printCandidates(candidates(scopeOf(cli.commands, cli.extraCommands, cli.aliases), cli.defaultCommand, argv.slice(1)));
|
|
1358
|
+
if (argv[0] === COMPLETIONS || argv[0]?.startsWith(`${COMPLETIONS}=`) === true)
|
|
1359
|
+
return printCompletionScript(cli.name, flagValue(argv));
|
|
1360
|
+
const started = performance.now();
|
|
1235
1361
|
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 });
|
|
1362
|
+
const command = commandPath(scopeOf(cli.commands, cli.extraCommands, cli.aliases), argv);
|
|
1363
|
+
notifyEnd(command === undefined ? cli.name : `${cli.name} ${command}`, code, performance.now() - started);
|
|
1236
1364
|
if (cli.usage !== false) {
|
|
1237
1365
|
try {
|
|
1238
|
-
recordUsage(usageEntry(cli.name,
|
|
1366
|
+
recordUsage(usageEntry(cli.name, command, argv, code));
|
|
1239
1367
|
} catch {}
|
|
1240
1368
|
}
|
|
1241
1369
|
return code;
|
|
@@ -1258,16 +1386,20 @@ function commandPath(scope, argv) {
|
|
|
1258
1386
|
async function runMain({ name, version, run, redact, usage }, argv = scriptArgs()) {
|
|
1259
1387
|
if (argv[0] === COMPLETE)
|
|
1260
1388
|
return printCandidates(leafCandidates(run, argv.slice(1)));
|
|
1389
|
+
if (argv[0] === COMPLETIONS || argv[0]?.startsWith(`${COMPLETIONS}=`) === true)
|
|
1390
|
+
return printCompletionScript(name, flagValue(argv));
|
|
1261
1391
|
if (argv.length === 1 && (argv[0] === "--version" || argv[0] === "-v")) {
|
|
1262
1392
|
console.log(version ?? packageVersion());
|
|
1263
1393
|
return 0;
|
|
1264
1394
|
}
|
|
1265
1395
|
let code;
|
|
1396
|
+
const started = performance.now();
|
|
1266
1397
|
try {
|
|
1267
1398
|
code = await run(argv);
|
|
1268
1399
|
} catch (error) {
|
|
1269
1400
|
code = reportThrown(name, error, redact, wantsJson(argv));
|
|
1270
1401
|
}
|
|
1402
|
+
notifyEnd(name, code, performance.now() - started);
|
|
1271
1403
|
if (usage !== false) {
|
|
1272
1404
|
try {
|
|
1273
1405
|
recordUsage(usageEntry(name, undefined, argv, code));
|
|
@@ -1311,7 +1443,7 @@ var SESSION_FILES = new Glob("*.json");
|
|
|
1311
1443
|
var ACCOUNT_DIRS = new Glob("*/sessions");
|
|
1312
1444
|
// src/todo-scan.ts
|
|
1313
1445
|
import { join as join7 } from "path";
|
|
1314
|
-
import
|
|
1446
|
+
import process16 from "process";
|
|
1315
1447
|
|
|
1316
1448
|
// src/files.ts
|
|
1317
1449
|
import { existsSync as existsSync4, readdirSync, statSync as statSync2 } from "fs";
|
|
@@ -1359,7 +1491,7 @@ var COMMENT = /(?<![:\w/])\/\/|\/\*|<!--|(?:^|\s)(?:#|--)(?=\s)|^\s*\*(?=\s|$)/;
|
|
|
1359
1491
|
var MARKUP = /\.(?:md|mdx|markdown|html?|xml)$/i;
|
|
1360
1492
|
var MARKUP_COMMENT = /<!--/;
|
|
1361
1493
|
var CLOSERS = /\s*(?:\*\/|-->)\s*$/;
|
|
1362
|
-
var MARKER = /^(?:@|\[)?(TODO|FIXME)\b/;
|
|
1494
|
+
var MARKER = /^(?:@|\[)?(TODO|FIXME|HACK|XXX)\b/;
|
|
1363
1495
|
var QUOTES = ["'", '"', "`"];
|
|
1364
1496
|
var ESCAPE2 = /\\./g;
|
|
1365
1497
|
var AFTER_FIRST_LINE = /\n[\s\S]*/;
|
|
@@ -1368,6 +1500,40 @@ function isQuoted(line, index) {
|
|
|
1368
1500
|
const before = line.slice(0, index).replaceAll(ESCAPE2, "");
|
|
1369
1501
|
return QUOTES.some((quote) => before.split(quote).length % 2 === 0);
|
|
1370
1502
|
}
|
|
1503
|
+
var BLAME_HEADER = /^[0-9a-f]{40} \d+ (\d+)/;
|
|
1504
|
+
var DAY_S = 86400;
|
|
1505
|
+
async function commitTimes(path, cwd) {
|
|
1506
|
+
const blamed = await runCommand(["git", "blame", "--porcelain", "--", path], { cwd });
|
|
1507
|
+
const times = new Map;
|
|
1508
|
+
if (blamed.code !== 0)
|
|
1509
|
+
return times;
|
|
1510
|
+
const bySha = new Map;
|
|
1511
|
+
let sha = "";
|
|
1512
|
+
let line = 0;
|
|
1513
|
+
for (const row of stdoutOf(blamed.chunks).split(`
|
|
1514
|
+
`)) {
|
|
1515
|
+
const header = BLAME_HEADER.exec(row);
|
|
1516
|
+
if (header !== null) {
|
|
1517
|
+
sha = row.slice(0, 40);
|
|
1518
|
+
line = Number(header[1]);
|
|
1519
|
+
} else if (row.startsWith("committer-time ")) {
|
|
1520
|
+
bySha.set(sha, Number(row.slice("committer-time ".length)));
|
|
1521
|
+
} else if (row.startsWith("\t")) {
|
|
1522
|
+
times.set(line, bySha.get(sha) ?? 0);
|
|
1523
|
+
}
|
|
1524
|
+
}
|
|
1525
|
+
return times;
|
|
1526
|
+
}
|
|
1527
|
+
async function addAges(marks, cwd, now = Date.now() / 1000) {
|
|
1528
|
+
await Promise.all([...Map.groupBy(marks, (mark) => mark.path)].map(async ([path, ofFile]) => {
|
|
1529
|
+
const times = await commitTimes(path, cwd);
|
|
1530
|
+
for (const mark of ofFile) {
|
|
1531
|
+
const time = times.get(mark.line);
|
|
1532
|
+
if (time !== undefined)
|
|
1533
|
+
mark.age = Math.max(0, Math.floor((now - time) / DAY_S));
|
|
1534
|
+
}
|
|
1535
|
+
}));
|
|
1536
|
+
}
|
|
1371
1537
|
function marksIn(text, path) {
|
|
1372
1538
|
const marks = [];
|
|
1373
1539
|
const comment = MARKUP.test(path) ? MARKUP_COMMENT : COMMENT;
|
|
@@ -1423,17 +1589,21 @@ async function lookUp(refs, cwd) {
|
|
|
1423
1589
|
}
|
|
1424
1590
|
|
|
1425
1591
|
// src/todo-scan.ts
|
|
1426
|
-
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
|
|
1592
|
+
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
|
|
1593
|
+
|
|
1594
|
+
--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.
|
|
1427
1595
|
|
|
1428
1596
|
--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.
|
|
1429
1597
|
|
|
1430
1598
|
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.`;
|
|
1431
1599
|
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)"]];
|
|
1432
1600
|
var LIST_LIMIT = 100;
|
|
1601
|
+
var DAY_MS2 = 86400000;
|
|
1433
1602
|
var OPTIONS = {
|
|
1434
1603
|
stale: { type: "boolean", description: "only the comments naming a closed issue, looked up with ft or gh" },
|
|
1604
|
+
older: { type: "string", description: "only the comments whose line last changed longer ago than this duration, from git blame" },
|
|
1435
1605
|
...limitOptions(LIST_LIMIT),
|
|
1436
|
-
json: jsonOption("[{path, line, kind, text, refs: [{repo, number, state?}]}]")
|
|
1606
|
+
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")
|
|
1437
1607
|
};
|
|
1438
1608
|
function printLines(lines, footer) {
|
|
1439
1609
|
const all = [...lines, ...footer === undefined ? [] : [footer]];
|
|
@@ -1443,20 +1613,27 @@ function printLines(lines, footer) {
|
|
|
1443
1613
|
}
|
|
1444
1614
|
async function todoScan(args) {
|
|
1445
1615
|
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"]] });
|
|
1446
|
-
const cwd =
|
|
1616
|
+
const cwd = process16.cwd();
|
|
1447
1617
|
const limit = limitOf(values, LIST_LIMIT);
|
|
1448
|
-
const
|
|
1618
|
+
const found = [];
|
|
1449
1619
|
for (const path of await listFiles(positionals, cwd)) {
|
|
1450
1620
|
const text = await readText(join7(cwd, path));
|
|
1451
1621
|
if (text !== undefined)
|
|
1452
|
-
|
|
1622
|
+
found.push(...marksIn(text, path));
|
|
1453
1623
|
}
|
|
1624
|
+
const older = values.older === undefined ? undefined : duration(values.older, "older", 0, "m") / DAY_MS2;
|
|
1625
|
+
let marks = found;
|
|
1626
|
+
if (older !== undefined || values.json === true)
|
|
1627
|
+
await addAges(found, cwd);
|
|
1628
|
+
const ageNote = (mark) => older === undefined || mark.age === undefined ? "" : ` [${mark.age}d]`;
|
|
1629
|
+
if (older !== undefined)
|
|
1630
|
+
marks = found.filter((mark) => mark.age !== undefined && mark.age >= older);
|
|
1454
1631
|
if (values.stale !== true) {
|
|
1455
1632
|
const { shown, footer } = capped(marks, limit);
|
|
1456
1633
|
if (values.json === true)
|
|
1457
1634
|
printJson(shown);
|
|
1458
1635
|
else
|
|
1459
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}`), footer);
|
|
1636
|
+
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.text}${ageNote(mark)}`), footer);
|
|
1460
1637
|
return 0;
|
|
1461
1638
|
}
|
|
1462
1639
|
const { states, failed } = await lookUp(marks.flatMap((mark) => mark.refs), cwd);
|
|
@@ -1467,11 +1644,11 @@ async function todoScan(args) {
|
|
|
1467
1644
|
if (values.json === true)
|
|
1468
1645
|
printJson(shown.map((mark) => ({ ...mark, refs: mark.refs.map((ref) => ({ ...ref, state: states.get(refKey(ref)) })) })));
|
|
1469
1646
|
else
|
|
1470
|
-
printLines(shown.map((mark) => `${mark.path}:${mark.line}: ${mark.refs.filter((ref) => states.get(refKey(ref)) === "closed").map(refKey).join(", ")} closed: ${mark.text}`), footer);
|
|
1647
|
+
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);
|
|
1471
1648
|
if (stale.length > 0)
|
|
1472
1649
|
return 1;
|
|
1473
1650
|
return failed.size > 0 ? 2 : 0;
|
|
1474
1651
|
}
|
|
1475
1652
|
|
|
1476
1653
|
// src/todo-scan-cli.ts
|
|
1477
|
-
|
|
1654
|
+
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.1",
|
|
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.41.0"
|
|
50
50
|
}
|
|
51
51
|
}
|