@jondotsoy/flags
Version:
A Javascript arguments processor
182 lines • 15.4 kB
JavaScript
// Remove ANSI escape codes to calculate visible length
const stripAnsi = (text) => {
return text.replace(/\x1b\[[0-9;]*m/g, "");
};
const wrapText = (text, maxWidth) => {
if (maxWidth === Infinity) {
return [text];
}
const words = text.split(/\s+/);
const lines = [];
let currentLine = "";
for (const word of words) {
if (!currentLine) {
currentLine = word;
}
else {
const testLine = `${currentLine} ${word}`;
// Use visible length (without ANSI codes) for width calculation
const visibleLength = stripAnsi(testLine).length;
if (visibleLength <= maxWidth) {
currentLine = testLine;
}
else {
lines.push(currentLine);
currentLine = word;
}
}
}
if (currentLine) {
lines.push(currentLine);
}
return lines;
};
export const helpMessage = (flagsParser, schema, options) => {
const terminalWidth = options?.terminalWidth ?? process.stdout.columns ?? 80;
const noColor = options?.noColor ?? false;
const lines = [];
// Usage line
lines.push(`Usage: ${flagsParser.metadata.program}`);
lines.push("");
// Description
if (flagsParser.metadata.description) {
const wrappedLines = wrapText(flagsParser.metadata.description, terminalWidth);
lines.push(...wrappedLines);
lines.push("");
}
// Collect flags and commands
const flags = [];
const commands = [];
for (const [key, builder] of Object.entries(schema)) {
const spec = builder.spec;
const description = spec.hasMetadata("description")
? spec.getMetadata("description")
: undefined;
// Check if it's a command by checking the builder type
const builderName = builder.constructor.name;
const isCommand = builderName.includes("Command");
if (isCommand) {
// For commands, we need to extract the command name from the refiners
// Commands use argumentMatchRefine which checks for exact string match
const refiners = spec.getRefiners();
let commandName = key;
// Try to extract command name from the refiner
if (refiners.length > 0) {
// The argumentMatchRefine stores the match string in its closure
// We'll use the key as fallback
commandName = key;
}
commands.push({
name: commandName,
description,
});
}
else {
// It's a flag
const matches = spec.hasMetadata("matches")
? spec.getMetadata("matches")
: [];
if (matches.length > 0) {
const initial = spec.getInitial();
let type = "boolean";
let hasDefault = false;
// Determine type based on initial value
if (initial === null) {
type = "string"; // Could be number or string, default to string
}
else if (typeof initial === "number") {
type = "number";
hasDefault = true;
}
else if (typeof initial === "string") {
type = "string";
hasDefault = true;
}
else if (typeof initial === "boolean") {
type = "boolean";
}
else if (Array.isArray(initial)) {
type = "array";
}
flags.push({
names: matches,
type,
description,
hasDefault,
});
}
}
}
// Print Options section
if (flags.length > 0) {
lines.push("Options:");
for (const flag of flags) {
// Sort names: short flags first (single dash), then long flags (double dash)
const sortedNames = [...flag.names].sort((a, b) => {
const aIsShort = a.startsWith("-") && !a.startsWith("--");
const bIsShort = b.startsWith("-") && !b.startsWith("--");
if (aIsShort && !bIsShort)
return -1;
if (!aIsShort && bIsShort)
return 1;
return 0;
});
// Check if there's a short flag
const hasShortFlag = sortedNames.some((name) => name.startsWith("-") && !name.startsWith("--"));
const namesStr = sortedNames.join(", ");
// For boolean flags, add a period instead of type
// For flags with defaults, show the type
// For flags without defaults (null initial), don't show type
let flagPart;
if (flag.type === "boolean") {
flagPart = `${namesStr}.`;
}
else if (flag.hasDefault) {
flagPart = `${namesStr} <${flag.type}>`;
}
else {
flagPart = namesStr;
}
const descStr = flag.description || "";
// If there's no short flag, add extra padding to align with flags that have short flags
// Short flags are typically "-X, " which is 4 characters
const indent = hasShortFlag ? " " : " ";
const totalFlagLength = indent.length + flagPart.length;
const padding = " ".repeat(Math.max(1, 27 - totalFlagLength));
// Wrap description if it's too long
if (descStr) {
const descIndent = indent.length + flagPart.length + padding.length;
const availableWidth = terminalWidth - descIndent;
const descLines = wrapText(descStr, availableWidth);
if (descLines.length > 0) {
// First line goes on the same line as the flag
lines.push(`${indent}${flagPart}${padding}${descLines[0]}`);
// Subsequent lines are indented to align with the first line of description
const descIndentStr = " ".repeat(descIndent);
for (let i = 1; i < descLines.length; i++) {
lines.push(`${descIndentStr}${descLines[i]}`);
}
}
else {
lines.push(`${indent}${flagPart}${padding}`);
}
}
else {
lines.push(`${indent}${flagPart}${padding}`);
}
}
lines.push("");
}
// Print Commands section
if (commands.length > 0) {
lines.push("Commands:");
for (const cmd of commands) {
const nameStr = cmd.name;
const descStr = cmd.description || "";
const padding = " ".repeat(Math.max(1, 25 - nameStr.length));
lines.push(` ${nameStr}${padding}${descStr}`);
}
}
return lines.join("\n") + "\n";
};
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"help-message.js","sourceRoot":"","sources":["../../../src/utils/help-message.ts"],"names":[],"mappings":"AAQA,uDAAuD;AACvD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE;IACzC,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAY,EAAE;IAC5D,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,WAAW,GAAG,EAAE,CAAC;IAErB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC;YAC1C,gEAAgE;YAChE,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;YAEjD,IAAI,aAAa,IAAI,QAAQ,EAAE,CAAC;gBAC9B,WAAW,GAAG,QAAQ,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACxB,WAAW,GAAG,IAAI,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,WAA6B,EAC7B,MAAoC,EACpC,OAA4B,EACpB,EAAE;IACV,MAAM,aAAa,GAAG,OAAO,EAAE,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;IAC7E,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;IAE1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,aAAa;IACb,KAAK,CAAC,IAAI,CAAC,UAAU,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,cAAc;IACd,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,YAAY,GAAG,QAAQ,CAC3B,WAAW,CAAC,QAAQ,CAAC,WAAW,EAChC,aAAa,CACd,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,6BAA6B;IAC7B,MAAM,KAAK,GAKN,EAAE,CAAC;IACR,MAAM,QAAQ,GAAkD,EAAE,CAAC;IAEnE,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;YACjD,CAAC,CAAE,IAAI,CAAC,WAAW,CAAC,aAAa,CAAY;YAC7C,CAAC,CAAC,SAAS,CAAC;QAEd,uDAAuD;QACvD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QAC7C,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,sEAAsE;YACtE,uEAAuE;YACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,WAAW,GAAG,GAAG,CAAC;YAEtB,+CAA+C;YAC/C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,iEAAiE;gBACjE,gCAAgC;gBAChC,WAAW,GAAG,GAAG,CAAC;YACpB,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,WAAW;gBACjB,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,cAAc;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;gBACzC,CAAC,CAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAc;gBAC3C,CAAC,CAAC,EAAE,CAAC;YAEP,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,IAAI,GAAG,SAAS,CAAC;gBACrB,IAAI,UAAU,GAAG,KAAK,CAAC;gBAEvB,wCAAwC;gBACxC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACrB,IAAI,GAAG,QAAQ,CAAC,CAAC,+CAA+C;gBAClE,CAAC;qBAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;oBACvC,IAAI,GAAG,QAAQ,CAAC;oBAChB,UAAU,GAAG,IAAI,CAAC;gBACpB,CAAC;qBAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;oBACvC,IAAI,GAAG,QAAQ,CAAC;oBAChB,UAAU,GAAG,IAAI,CAAC;gBACpB,CAAC;qBAAM,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE,CAAC;oBACxC,IAAI,GAAG,SAAS,CAAC;gBACnB,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAClC,IAAI,GAAG,OAAO,CAAC;gBACjB,CAAC;gBAED,KAAK,CAAC,IAAI,CAAC;oBACT,KAAK,EAAE,OAAO;oBACd,IAAI;oBACJ,WAAW;oBACX,UAAU;iBACX,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,wBAAwB;IACxB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,6EAA6E;YAC7E,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBAChD,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC1D,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,QAAQ,IAAI,CAAC,QAAQ;oBAAE,OAAO,CAAC,CAAC,CAAC;gBACrC,IAAI,CAAC,QAAQ,IAAI,QAAQ;oBAAE,OAAO,CAAC,CAAC;gBACpC,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YAEH,gCAAgC;YAChC,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CACzD,CAAC;YAEF,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAExC,kDAAkD;YAClD,yCAAyC;YACzC,6DAA6D;YAC7D,IAAI,QAAgB,CAAC;YACrB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC5B,QAAQ,GAAG,GAAG,QAAQ,GAAG,CAAC;YAC5B,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC3B,QAAQ,GAAG,GAAG,QAAQ,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,QAAQ,GAAG,QAAQ,CAAC;YACtB,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YAEvC,wFAAwF;YACxF,yDAAyD;YACzD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;YAC9C,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YACxD,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC;YAE9D,oCAAoC;YACpC,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBACpE,MAAM,cAAc,GAAG,aAAa,GAAG,UAAU,CAAC;gBAClD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBAEpD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,+CAA+C;oBAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAE5D,4EAA4E;oBAC5E,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC1C,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAChD,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,EAAE,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,yBAAyB;IACzB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC;YACzB,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;YACtC,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7D,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AACjC,CAAC,CAAC"}