paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 41 Packages Projects Releases Wiki Activity

Fix CLI report generation and --help handling for loader-based commands

Browse Source 
Add cleye-based --help handling to all commands using the loader pattern.
Update the CLI report parser to support cleye's USAGE: and FLAGS: sections.
Revert accidental backstage.role addition to eslint-plugin.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2026-02-26 20:31:55 +01:00
parent 0d2d0f2e07
commit d5779e525c
12 changed files with 106 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/repo-tools/src/commands/api-reports/cli-reports/runCliExtraction.ts
+19 -6
View File
@@ -27,7 +27,14 @@ import { generateCliReport } from './generateCliReport';
import { logApiReportInstructions } from '../common';
function parseHelpPage(helpPageContent: string) {
const [, usage] = helpPageContent.match(/^\s*Usage: (.*)$/im) ?? [];
let usage: string | undefined;
// Commander format: "Usage: backstage-cli ..."
const commanderUsage = helpPageContent.match(/^\s*Usage: (.*)$/im);
if (commanderUsage) {
usage = commanderUsage[1];
}
const lines = helpPageContent.split(/\r?\n/);
let options = new Array<string>();
@@ -39,8 +46,8 @@ function parseHelpPage(helpPageContent: string) {
lines.shift();
}
if (lines.length > 0) {
// Start of a new section, e.g. "Options:"
const sectionName = lines.shift();
// Start of a new section, e.g. "Options:" or "FLAGS:"
const sectionName = lines.shift()?.toLocaleLowerCase('en-US');
// Take lines until we hit the next section or the end
const sectionEndIndex = lines.findIndex(
line => line && !line.match(/^\s/),
@@ -53,12 +60,18 @@ function parseHelpPage(helpPageContent: string) {
.map(line => line.match(/^\s{1,8}(.*?)\s\s+/)?.[1])
.filter(Boolean) as string[];
if (sectionName?.toLocaleLowerCase('en-US') === 'options:') {
if (sectionName === 'options:' || sectionName === 'flags:') {
options = sectionItems;
} else if (sectionName?.toLocaleLowerCase('en-US') === 'commands:') {
} else if (sectionName === 'commands:') {
commands = sectionItems;
} else if (sectionName?.toLocaleLowerCase('en-US') === 'arguments:') {
} else if (sectionName === 'arguments:') {
commandArguments = sectionItems;
} else if (sectionName === 'usage:') {
// cleye format: usage line is inside the USAGE: section
const usageLine = sectionLines.find(l => l.trim().length > 0)?.trim();
if (usageLine) {
usage = usageLine;
}
} else {
throw new Error(`Unknown CLI section: ${sectionName}`);
}