@kaynooo/cli-code 0.14.2 → 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 +314 -105
- package/dist/hotspots-cli.js +235 -71
- package/dist/peek-cli.js +221 -65
- package/dist/todo-scan-cli.js +259 -60
- 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));
|
|
@@ -628,7 +652,7 @@ class Completing {
|
|
|
628
652
|
}
|
|
629
653
|
var completion = { active: false };
|
|
630
654
|
var OUTPUT_OPTIONS = {
|
|
631
|
-
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" },
|
|
632
656
|
plain: { type: "boolean", description: "plain text, no colour or spinner: --color never" }
|
|
633
657
|
};
|
|
634
658
|
function applyOutput(color, plain, env = process9.env) {
|
|
@@ -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,93 @@ 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/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
|
|
901
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
|
+
}
|
|
902
1028
|
|
|
903
1029
|
// ../kit/src/usage.ts
|
|
904
1030
|
import { appendFileSync, mkdirSync } from "fs";
|
|
905
1031
|
import { homedir as homedir3 } from "os";
|
|
906
1032
|
import { dirname as dirname2, isAbsolute, join as join4 } from "path";
|
|
907
|
-
import
|
|
1033
|
+
import process13 from "process";
|
|
908
1034
|
|
|
909
1035
|
// ../kit/src/logs.ts
|
|
910
1036
|
var DAY_MS = 24 * 60 * 60 * 1000;
|
|
@@ -918,14 +1044,14 @@ var usageError;
|
|
|
918
1044
|
function noteUsageError(message) {
|
|
919
1045
|
usageError = message;
|
|
920
1046
|
}
|
|
921
|
-
function stateHome(env =
|
|
1047
|
+
function stateHome(env = process13.env) {
|
|
922
1048
|
const dir = env.XDG_STATE_HOME;
|
|
923
1049
|
return dir !== undefined && isAbsolute(dir) ? dir : join4(homedir3(), ".local", "state");
|
|
924
1050
|
}
|
|
925
|
-
function usagePath(env =
|
|
1051
|
+
function usagePath(env = process13.env) {
|
|
926
1052
|
return join4(stateHome(env), CLI_FOLDER, "usage.jsonl");
|
|
927
1053
|
}
|
|
928
|
-
function usageRecorded(env =
|
|
1054
|
+
function usageRecorded(env = process13.env) {
|
|
929
1055
|
const off = env.KAYNOOO_CLI_NO_USAGE;
|
|
930
1056
|
return env.NODE_ENV !== "test" && (off === undefined || off === "" || off === "0");
|
|
931
1057
|
}
|
|
@@ -939,7 +1065,7 @@ function usageEntry(bin, command, argv, code, now = new Date) {
|
|
|
939
1065
|
usageError = undefined;
|
|
940
1066
|
return { at: now.toISOString(), bin, ...command === undefined ? {} : { command }, flags: flagNames(argv), code, ...unknown === undefined ? {} : { unknown } };
|
|
941
1067
|
}
|
|
942
|
-
function recordUsage(entry, env =
|
|
1068
|
+
function recordUsage(entry, env = process13.env) {
|
|
943
1069
|
if (!usageRecorded(env))
|
|
944
1070
|
return;
|
|
945
1071
|
try {
|
|
@@ -955,7 +1081,11 @@ var LEVEL_OPTIONS = {
|
|
|
955
1081
|
...OUTPUT_OPTIONS,
|
|
956
1082
|
help: { type: "boolean", short: "h", description: "show this help" }
|
|
957
1083
|
};
|
|
958
|
-
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
|
+
};
|
|
959
1089
|
async function commandRows(all, colors) {
|
|
960
1090
|
const commands = shown(all);
|
|
961
1091
|
const width = Math.max(0, ...Object.keys(commands).map((name) => name.length));
|
|
@@ -1016,7 +1146,6 @@ async function help2({ path, header, summary: lazySummary, commands, defaultComm
|
|
|
1016
1146
|
header(colors, summary),
|
|
1017
1147
|
"",
|
|
1018
1148
|
usageLine(`${prefix} ${defaultCommand === undefined ? colors.cyan("<command>") : `[${colors.cyan("<command>")}]`} [options]`, colors),
|
|
1019
|
-
...replacesRows(replaces, colors),
|
|
1020
1149
|
"",
|
|
1021
1150
|
...await commandRows(commands, colors),
|
|
1022
1151
|
...own.length === 0 ? [] : ["", `${colors.bold(`Options of ${defaultCommand}:`)} ${colors.dim("the command run when none is named")}`, ...optionRows(Object.fromEntries(own), colors)],
|
|
@@ -1030,8 +1159,8 @@ async function help2({ path, header, summary: lazySummary, commands, defaultComm
|
|
|
1030
1159
|
`);
|
|
1031
1160
|
}
|
|
1032
1161
|
function printError(prefix, message, hint, cause) {
|
|
1033
|
-
const colors = paint(
|
|
1034
|
-
const styled = takesControlCodes(
|
|
1162
|
+
const colors = paint(process14.stderr);
|
|
1163
|
+
const styled = takesControlCodes(process14.stderr);
|
|
1035
1164
|
const head = styled ? `${colors.red.bold("error")} ${colors.dim(`${prefix}:`)}` : `error: ${prefix}:`;
|
|
1036
1165
|
const under = (label, text, tint) => text === undefined ? "" : `
|
|
1037
1166
|
${styled ? tint(label) : `${label}:`} ${text}`;
|
|
@@ -1074,11 +1203,11 @@ async function dispatch(level, typed, { version, redact }) {
|
|
|
1074
1203
|
}
|
|
1075
1204
|
}
|
|
1076
1205
|
if (name === undefined && level.path.length > 1) {
|
|
1077
|
-
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));
|
|
1078
1207
|
return 2;
|
|
1079
1208
|
}
|
|
1080
1209
|
if (name === undefined || name === "help" || name === "--help" || name === "-h") {
|
|
1081
|
-
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));
|
|
1082
1211
|
return 0;
|
|
1083
1212
|
}
|
|
1084
1213
|
if (level.path.length === 1 && (name === "--version" || name === "-v")) {
|
|
@@ -1134,24 +1263,24 @@ function candidateLine(candidate) {
|
|
|
1134
1263
|
}
|
|
1135
1264
|
function positionalBeingTyped(before, { options, positionals }) {
|
|
1136
1265
|
const takesValue = (word) => !word.includes("=") && Object.entries(options).some(([name, { short, type }]) => type === "string" && (word === `--${name}` || word === `-${short}`));
|
|
1137
|
-
|
|
1266
|
+
const typed = [];
|
|
1138
1267
|
let at = 0;
|
|
1139
1268
|
while (at < before.length) {
|
|
1140
1269
|
const word = before[at];
|
|
1141
1270
|
if (word === "--") {
|
|
1142
|
-
|
|
1271
|
+
typed.push(...before.slice(at + 1));
|
|
1143
1272
|
break;
|
|
1144
1273
|
}
|
|
1145
1274
|
if (!word.startsWith("-"))
|
|
1146
|
-
|
|
1275
|
+
typed.push(word);
|
|
1147
1276
|
else if (takesValue(word))
|
|
1148
1277
|
at++;
|
|
1149
1278
|
at++;
|
|
1150
1279
|
}
|
|
1151
1280
|
const last = positionals.at(-1);
|
|
1152
|
-
if (
|
|
1153
|
-
return positionals[
|
|
1154
|
-
return last?.replace("]", "").endsWith("...") === true ? last : undefined;
|
|
1281
|
+
if (typed.length < positionals.length)
|
|
1282
|
+
return { name: positionals[typed.length], typed };
|
|
1283
|
+
return { name: last?.replace("]", "").endsWith("...") === true ? last : undefined, typed };
|
|
1155
1284
|
}
|
|
1156
1285
|
async function leafCandidates(run, words) {
|
|
1157
1286
|
const completing = await completingOf(run);
|
|
@@ -1159,12 +1288,12 @@ async function leafCandidates(run, words) {
|
|
|
1159
1288
|
return Object.entries(completing.options).map(([name, option]) => option.description === undefined ? `--${name}` : `--${name} ${option.description}`);
|
|
1160
1289
|
const flag = words.at(-2);
|
|
1161
1290
|
const option = flag?.startsWith("-") === true ? Object.entries(completing.options).find(([name, { short }]) => flag === `--${name}` || flag === `-${short}`)?.[1] : undefined;
|
|
1291
|
+
const { name, typed } = positionalBeingTyped(words.slice(0, -1), completing);
|
|
1162
1292
|
if (option?.type === "string") {
|
|
1163
|
-
const values = option.choices === undefined ? await option.candidates?.() : option.choices;
|
|
1293
|
+
const values = option.choices === undefined ? await option.candidates?.(typed) : option.choices;
|
|
1164
1294
|
return values === undefined ? [FILES] : values.map(candidateLine);
|
|
1165
1295
|
}
|
|
1166
|
-
const
|
|
1167
|
-
const values = name === undefined ? undefined : await completing.candidates[name]?.();
|
|
1296
|
+
const values = name === undefined ? undefined : await completing.candidates[name]?.(typed);
|
|
1168
1297
|
return values === undefined ? [FILES] : values.map(candidateLine);
|
|
1169
1298
|
}
|
|
1170
1299
|
async function candidates(scope, defaultCommand, words, before = []) {
|
|
@@ -1189,15 +1318,32 @@ async function candidates(scope, defaultCommand, words, before = []) {
|
|
|
1189
1318
|
}
|
|
1190
1319
|
return "commands" in command ? candidates(scopeOf(command.commands, command.extraCommands, command.aliases), undefined, rest, [...before, word]) : leafCandidates(command.run, rest);
|
|
1191
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
|
+
}
|
|
1192
1334
|
async function printCandidates(found) {
|
|
1193
1335
|
for (const line of await found)
|
|
1194
1336
|
console.log(line);
|
|
1195
1337
|
return 0;
|
|
1196
1338
|
}
|
|
1197
1339
|
function packageVersion(entry = Bun.main) {
|
|
1198
|
-
|
|
1340
|
+
let resolved = entry;
|
|
1341
|
+
try {
|
|
1342
|
+
resolved = realpathSync2(entry);
|
|
1343
|
+
} catch {}
|
|
1344
|
+
for (let dir = dirname3(resolved);; dir = dirname3(dir)) {
|
|
1199
1345
|
try {
|
|
1200
|
-
const { version } = JSON.parse(
|
|
1346
|
+
const { version } = JSON.parse(readFileSync4(join5(dir, "package.json"), "utf8"));
|
|
1201
1347
|
if (typeof version === "string")
|
|
1202
1348
|
return version;
|
|
1203
1349
|
} catch {}
|
|
@@ -1205,14 +1351,19 @@ function packageVersion(entry = Bun.main) {
|
|
|
1205
1351
|
return "0.0.0";
|
|
1206
1352
|
}
|
|
1207
1353
|
}
|
|
1208
|
-
async function runCli(cli, argv =
|
|
1354
|
+
async function runCli(cli, argv = scriptArgs()) {
|
|
1209
1355
|
const version = cli.version ?? packageVersion();
|
|
1210
1356
|
if (argv[0] === COMPLETE)
|
|
1211
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();
|
|
1212
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);
|
|
1213
1364
|
if (cli.usage !== false) {
|
|
1214
1365
|
try {
|
|
1215
|
-
recordUsage(usageEntry(cli.name,
|
|
1366
|
+
recordUsage(usageEntry(cli.name, command, argv, code));
|
|
1216
1367
|
} catch {}
|
|
1217
1368
|
}
|
|
1218
1369
|
return code;
|
|
@@ -1232,19 +1383,23 @@ function commandPath(scope, argv) {
|
|
|
1232
1383
|
}
|
|
1233
1384
|
return path.length === 0 ? undefined : path.join(" ");
|
|
1234
1385
|
}
|
|
1235
|
-
async function runMain({ name, version, run, redact, usage }, argv =
|
|
1386
|
+
async function runMain({ name, version, run, redact, usage }, argv = scriptArgs()) {
|
|
1236
1387
|
if (argv[0] === COMPLETE)
|
|
1237
1388
|
return printCandidates(leafCandidates(run, argv.slice(1)));
|
|
1389
|
+
if (argv[0] === COMPLETIONS || argv[0]?.startsWith(`${COMPLETIONS}=`) === true)
|
|
1390
|
+
return printCompletionScript(name, flagValue(argv));
|
|
1238
1391
|
if (argv.length === 1 && (argv[0] === "--version" || argv[0] === "-v")) {
|
|
1239
1392
|
console.log(version ?? packageVersion());
|
|
1240
1393
|
return 0;
|
|
1241
1394
|
}
|
|
1242
1395
|
let code;
|
|
1396
|
+
const started = performance.now();
|
|
1243
1397
|
try {
|
|
1244
1398
|
code = await run(argv);
|
|
1245
1399
|
} catch (error) {
|
|
1246
1400
|
code = reportThrown(name, error, redact, wantsJson(argv));
|
|
1247
1401
|
}
|
|
1402
|
+
notifyEnd(name, code, performance.now() - started);
|
|
1248
1403
|
if (usage !== false) {
|
|
1249
1404
|
try {
|
|
1250
1405
|
recordUsage(usageEntry(name, undefined, argv, code));
|
|
@@ -1288,7 +1443,7 @@ var SESSION_FILES = new Glob("*.json");
|
|
|
1288
1443
|
var ACCOUNT_DIRS = new Glob("*/sessions");
|
|
1289
1444
|
// src/todo-scan.ts
|
|
1290
1445
|
import { join as join7 } from "path";
|
|
1291
|
-
import
|
|
1446
|
+
import process16 from "process";
|
|
1292
1447
|
|
|
1293
1448
|
// src/files.ts
|
|
1294
1449
|
import { existsSync as existsSync4, readdirSync, statSync as statSync2 } from "fs";
|
|
@@ -1336,7 +1491,7 @@ var COMMENT = /(?<![:\w/])\/\/|\/\*|<!--|(?:^|\s)(?:#|--)(?=\s)|^\s*\*(?=\s|$)/;
|
|
|
1336
1491
|
var MARKUP = /\.(?:md|mdx|markdown|html?|xml)$/i;
|
|
1337
1492
|
var MARKUP_COMMENT = /<!--/;
|
|
1338
1493
|
var CLOSERS = /\s*(?:\*\/|-->)\s*$/;
|
|
1339
|
-
var MARKER = /^(?:@|\[)?(TODO|FIXME)\b/;
|
|
1494
|
+
var MARKER = /^(?:@|\[)?(TODO|FIXME|HACK|XXX)\b/;
|
|
1340
1495
|
var QUOTES = ["'", '"', "`"];
|
|
1341
1496
|
var ESCAPE2 = /\\./g;
|
|
1342
1497
|
var AFTER_FIRST_LINE = /\n[\s\S]*/;
|
|
@@ -1345,6 +1500,40 @@ function isQuoted(line, index) {
|
|
|
1345
1500
|
const before = line.slice(0, index).replaceAll(ESCAPE2, "");
|
|
1346
1501
|
return QUOTES.some((quote) => before.split(quote).length % 2 === 0);
|
|
1347
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
|
+
}
|
|
1348
1537
|
function marksIn(text, path) {
|
|
1349
1538
|
const marks = [];
|
|
1350
1539
|
const comment = MARKUP.test(path) ? MARKUP_COMMENT : COMMENT;
|
|
@@ -1400,18 +1589,21 @@ async function lookUp(refs, cwd) {
|
|
|
1400
1589
|
}
|
|
1401
1590
|
|
|
1402
1591
|
// 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
|
|
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
|
|
1404
1593
|
|
|
1405
|
-
--
|
|
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.
|
|
1406
1595
|
|
|
1407
|
-
|
|
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.
|
|
1408
1597
|
|
|
1409
|
-
|
|
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.`;
|
|
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)"]];
|
|
1410
1600
|
var LIST_LIMIT = 100;
|
|
1601
|
+
var DAY_MS2 = 86400000;
|
|
1411
1602
|
var OPTIONS = {
|
|
1412
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" },
|
|
1413
1605
|
...limitOptions(LIST_LIMIT),
|
|
1414
|
-
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")
|
|
1415
1607
|
};
|
|
1416
1608
|
function printLines(lines, footer) {
|
|
1417
1609
|
const all = [...lines, ...footer === undefined ? [] : [footer]];
|
|
@@ -1420,21 +1612,28 @@ function printLines(lines, footer) {
|
|
|
1420
1612
|
`));
|
|
1421
1613
|
}
|
|
1422
1614
|
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 =
|
|
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"]] });
|
|
1616
|
+
const cwd = process16.cwd();
|
|
1425
1617
|
const limit = limitOf(values, LIST_LIMIT);
|
|
1426
|
-
const
|
|
1618
|
+
const found = [];
|
|
1427
1619
|
for (const path of await listFiles(positionals, cwd)) {
|
|
1428
1620
|
const text = await readText(join7(cwd, path));
|
|
1429
1621
|
if (text !== undefined)
|
|
1430
|
-
|
|
1622
|
+
found.push(...marksIn(text, path));
|
|
1431
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);
|
|
1432
1631
|
if (values.stale !== true) {
|
|
1433
1632
|
const { shown, footer } = capped(marks, limit);
|
|
1434
1633
|
if (values.json === true)
|
|
1435
1634
|
printJson(shown);
|
|
1436
1635
|
else
|
|
1437
|
-
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);
|
|
1438
1637
|
return 0;
|
|
1439
1638
|
}
|
|
1440
1639
|
const { states, failed } = await lookUp(marks.flatMap((mark) => mark.refs), cwd);
|
|
@@ -1445,11 +1644,11 @@ async function todoScan(args) {
|
|
|
1445
1644
|
if (values.json === true)
|
|
1446
1645
|
printJson(shown.map((mark) => ({ ...mark, refs: mark.refs.map((ref) => ({ ...ref, state: states.get(refKey(ref)) })) })));
|
|
1447
1646
|
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);
|
|
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);
|
|
1449
1648
|
if (stale.length > 0)
|
|
1450
1649
|
return 1;
|
|
1451
1650
|
return failed.size > 0 ? 2 : 0;
|
|
1452
1651
|
}
|
|
1453
1652
|
|
|
1454
1653
|
// src/todo-scan-cli.ts
|
|
1455
|
-
|
|
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
|
}
|