From 018094dbd6e5af8de75bf5566f6a134aaa7b52ec Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sun, 2 Mar 2025 08:54:07 -0600 Subject: [PATCH 1/3] feat: allow multiple CLI reports for easier diff Signed-off-by: aramissennyeydd --- .../cli/cli-report.backstage-cli-alpha.md | 181 ++++++++++++++++++ ...-report.md => cli-report.backstage-cli.md} | 121 +++++++----- packages/cli/package.json | 3 +- packages/cli/src/alpha.ts | 3 +- packages/cli/src/modules/config/alpha.ts | 36 ++++ .../cli-reports/generateCliReport.ts | 35 ++-- .../cli-reports/runCliExtraction.ts | 69 ++++--- yarn.lock | 1 + 8 files changed, 356 insertions(+), 93 deletions(-) create mode 100644 packages/cli/cli-report.backstage-cli-alpha.md rename packages/cli/{cli-report.md => cli-report.backstage-cli.md} (86%) diff --git a/packages/cli/cli-report.backstage-cli-alpha.md b/packages/cli/cli-report.backstage-cli-alpha.md new file mode 100644 index 0000000000..a5f857c893 --- /dev/null +++ b/packages/cli/cli-report.backstage-cli-alpha.md @@ -0,0 +1,181 @@ +## CLI Report file for "@backstage/cli" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +### `backstage-cli-alpha` + +``` +Usage: backstage-cli [options] [command] + +Options: + -V, --version + -h, --help + +Commands: + build-workspace + config [command] + config:check + config:docs + config:print + config:schema + help [command] + package [command] + repo [command] +``` + +### `backstage-cli-alpha build-workspace` + +``` +Usage: program [options] [packages...] + +Options: + --alwaysPack + -h, --help +``` + +### `backstage-cli-alpha config` + +``` +Usage: backstage-cli config [options] [command] [command] + +Options: + -h, --help + +Commands: + docs + help [command] + schema +``` + +### `backstage-cli-alpha config docs` + +``` +Usage: + +Options: + --help + --package + --version +``` + +### `backstage-cli-alpha config schema` + +``` +Usage: + +Options: + --format + --help + --merge + --no-merge + --package + --version +``` + +### `backstage-cli-alpha config:check` + +``` +Usage: + +Options: + --config + --deprecated + --frontend + --help + --lax + --package + --strict + --version +``` + +### `backstage-cli-alpha config:docs` + +``` +Usage: program [options] + +Options: + --package + -h, --help +``` + +### `backstage-cli-alpha config:print` + +``` +Usage: + +Options: + --config + --format + --frontend + --help + --lax + --package + --version + --with-secrets +``` + +### `backstage-cli-alpha config:schema` + +``` +Usage: + +Options: + --format + --help + --merge + --no-merge + --package + --version +``` + +### `backstage-cli-alpha package` + +``` +Usage: backstage-cli package [options] [command] [command] + +Options: + -h, --help + +Commands: + build + help [command] +``` + +### `backstage-cli-alpha package build` + +``` +Usage: program [options] + +Options: + --config + --minify + --role + --skip-build-dependencies + --stats + -h, --help +``` + +### `backstage-cli-alpha repo` + +``` +Usage: backstage-cli repo [options] [command] [command] + +Options: + -h, --help + +Commands: + build + help [command] +``` + +### `backstage-cli-alpha repo build` + +``` +Usage: program [options] [command] + +Options: + --all + --minify + --since + -h, --help +``` diff --git a/packages/cli/cli-report.md b/packages/cli/cli-report.backstage-cli.md similarity index 86% rename from packages/cli/cli-report.md rename to packages/cli/cli-report.backstage-cli.md index 699161966c..51f7b8c998 100644 --- a/packages/cli/cli-report.md +++ b/packages/cli/cli-report.backstage-cli.md @@ -12,10 +12,10 @@ Options: -h, --help Commands: - new [options] + build-workspace [options] [packages...] + config:check [options] config:docs [options] config:print [options] - config:check [options] config:schema [options] repo [command] package [command] @@ -26,6 +26,15 @@ Commands: info create-github-app help [command] + create-github-app + help [command] + info + migrate [command] + new [options] + package [command] + repo [command] + versions:bump [options] + versions:migrate [options] ``` ### `backstage-cli build-workspace` @@ -44,12 +53,12 @@ Options: Usage: backstage-cli config:check [options] Options: - --package - --lax - --frontend - --deprecated - --strict --config + --deprecated + --frontend + --lax + --package + --strict -h, --help ``` @@ -69,12 +78,12 @@ Options: Usage: backstage-cli config:print [options] Options: - --package - --lax - --frontend - --with-secrets - --format --config + --format + --frontend + --lax + --package + --with-secrets -h, --help ``` @@ -84,10 +93,10 @@ Options: Usage: backstage-cli config:schema [options] Options: - --package --format --merge --no-merge + --package -h, --help ``` @@ -118,12 +127,12 @@ Options: -h, --help Commands: - package-roles - package-scripts + help [command] package-exports package-lint-configs + package-roles + package-scripts react-router-deps - help [command] ``` ### `backstage-cli migrate package-exports` @@ -177,14 +186,14 @@ Options: Usage: backstage-cli new [options] Options: - --select - --option = - --skip-install - --scope - --npm-registry --baseVersion --license --no-private + --npm-registry + --option = + --scope + --select + --skip-install -h, --help ``` @@ -197,14 +206,22 @@ Options: -h, --help Commands: - start [options] build [options] +<<<<<<< HEAD:packages/cli/cli-report.md test clean prepack postpack lint [options] [directories...] +======= + clean +>>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md help [command] + lint [options] [directories...] + postpack + prepack + start [options] + test ``` ### `backstage-cli package build` @@ -213,11 +230,11 @@ Commands: Usage: backstage-cli package build [options] Options: - --role + --config --minify + --role --skip-build-dependencies --stats - --config -h, --help ``` @@ -236,10 +253,10 @@ Options: Usage: backstage-cli package lint [options] [directories...] Options: - --format - --output-file --fix + --format --max-warnings + --output-file -h, --help ``` @@ -267,13 +284,17 @@ Options: Usage: backstage-cli package start [options] Options: - --config - --role --check + --config --inspect [host] --inspect-brk [host] +<<<<<<< HEAD:packages/cli/cli-report.md --require +======= +>>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md --link + --require + --role -h, --help ``` @@ -283,11 +304,8 @@ Options: Usage: backstage-cli [--config=] [TestPathPattern] Options: - -h, --help - --version --all --automock - -b, --bail --cache --cacheDirectory --changedFilesWithAncestor @@ -299,7 +317,6 @@ Options: --collectCoverageFrom --color --colors - -c, --config --coverage --coverageDirectory --coveragePathIgnorePatterns @@ -311,7 +328,6 @@ Options: --detectOpenHandles --env --errorOnDeprecated - -e, --expand --filter --findRelatedTests --forceExit @@ -327,7 +343,6 @@ Options: --listTests --logHeapUsage --maxConcurrency - -w, --maxWorkers --moduleDirectories --moduleFileExtensions --moduleNameMapper @@ -336,8 +351,6 @@ Options: --noStackTrace --notify --notifyMode - -o, --onlyChanged - -f, --onlyFailures --openHandlesTimeout --outputFile --passWithNoTests @@ -352,7 +365,6 @@ Options: --restoreMocks --rootDir --roots - -i, --runInBand --runTestsByPath --runner --seed @@ -370,7 +382,6 @@ Options: --testFailureExitCode --testLocationInResults --testMatch - -t, --testNamePattern --testPathIgnorePatterns --testPathPattern --testRegex @@ -381,14 +392,24 @@ Options: --transform --transformIgnorePatterns --unmockedModulePathPatterns - -u, --updateSnapshot --useStderr --verbose + --version --watch --watchAll --watchPathIgnorePatterns --watchman --workerThreads + -b, --bail + -c, --config + -e, --expand + -f, --onlyFailures + -h, --help + -i, --runInBand + -o, --onlyChanged + -t, --testNamePattern + -u, --updateSnapshot + -w, --maxWorkers ``` ### `backstage-cli repo` @@ -401,12 +422,22 @@ Options: Commands: build [options] +<<<<<<< HEAD:packages/cli/cli-report.md test [options] lint [options] fix [options] +======= +>>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md clean - list-deprecations [options] + fix [options] help [command] + lint [options] + list-deprecations [options] +<<<<<<< HEAD:packages/cli/cli-report.md + help [command] +======= + test [options] +>>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md ``` ### `backstage-cli repo build` @@ -416,8 +447,8 @@ Usage: backstage-cli repo build [options] Options: --all - --since --minify + --since -h, --help ``` @@ -436,8 +467,8 @@ Options: Usage: backstage-cli repo fix [options] Options: - --publish --check + --publish -h, --help ``` @@ -447,13 +478,17 @@ Options: Usage: backstage-cli repo lint [options] Options: + --fix --format --output-file --since --successCache --successCacheDir +<<<<<<< HEAD:packages/cli/cli-report.md --max-warnings --fix +======= +>>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md -h, --help ``` @@ -473,10 +508,10 @@ Options: Usage: backstage-cli repo test [options] Options: + --jest-help --since --successCache --successCacheDir - --jest-help -h, --help ``` diff --git a/packages/cli/package.json b/packages/cli/package.json index 8f3f1764c6..52566341ce 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -20,7 +20,8 @@ "license": "Apache-2.0", "main": "dist/index.cjs.js", "bin": { - "backstage-cli": "bin/backstage-cli" + "backstage-cli": "bin/backstage-cli", + "backstage-cli-alpha": "bin/backstage-cli-alpha" }, "files": [ "asset-types", diff --git a/packages/cli/src/alpha.ts b/packages/cli/src/alpha.ts index 49e739bbdc..f1ccb65a53 100644 --- a/packages/cli/src/alpha.ts +++ b/packages/cli/src/alpha.ts @@ -18,7 +18,8 @@ import { CliInitializer } from './wiring/CliInitializer'; import chalk from 'chalk'; (async () => { - console.warn( + // Logging as stdout to prevent failures from stderr during api-report generation. + console.log( chalk.yellow( 'THIS ENTRYPOINT IS IN ALPHA AND MAY CHANGE IN THE FUTURE - DO NOT USE THIS FOR NORMAL DEVELOPMENT', ), diff --git a/packages/cli/src/modules/config/alpha.ts b/packages/cli/src/modules/config/alpha.ts index 8e5ff8b783..a0f2624922 100644 --- a/packages/cli/src/modules/config/alpha.ts +++ b/packages/cli/src/modules/config/alpha.ts @@ -97,5 +97,41 @@ export default createCliPlugin({ await m.default(argv); }, }); + + reg.addCommand({ + path: ['config:schema'], + description: 'Print the JSON schema for the given configuration', + execute: async ({ args }) => { + const argv = await yargs + .options({ + package: { type: 'string' }, + format: { type: 'string' }, + merge: { type: 'boolean' }, + 'no-merge': { type: 'boolean' }, + }) + .help() + .parse(args); + const m = await import('./commands/schema'); + await m.default(argv); + }, + }); + + reg.addCommand({ + path: ['config', 'schema'], + description: 'Print the JSON schema for the given configuration', + execute: async ({ args }) => { + const argv = await yargs + .options({ + package: { type: 'string' }, + format: { type: 'string' }, + merge: { type: 'boolean' }, + 'no-merge': { type: 'boolean' }, + }) + .help() + .parse(args); + const m = await import('./commands/schema'); + await m.default(argv); + }, + }); }, }); diff --git a/packages/repo-tools/src/commands/api-reports/cli-reports/generateCliReport.ts b/packages/repo-tools/src/commands/api-reports/cli-reports/generateCliReport.ts index 7df5058723..9876be997b 100644 --- a/packages/repo-tools/src/commands/api-reports/cli-reports/generateCliReport.ts +++ b/packages/repo-tools/src/commands/api-reports/cli-reports/generateCliReport.ts @@ -18,33 +18,32 @@ import { CliModel } from './types'; export function generateCliReport(options: { packageName: string; - models: CliModel[]; + model: CliModel; }): string { + const { model, packageName } = options; const content = [ - `## CLI Report file for "${options.packageName}"`, + `## CLI Report file for "${packageName}"`, '', '> Do not edit this file. It is a report generated by `yarn build:api-reports`', '', ]; - for (const model of options.models) { - for (const helpPage of model.helpPages) { - content.push( - `### \`${[model.name, ...helpPage.path].join(' ')}\``, - '', - '```', - `Usage: ${helpPage.usage ?? ''}`, - ); + for (const helpPage of model.helpPages) { + content.push( + `### \`${[model.name, ...helpPage.path].join(' ')}\``, + '', + '```', + `Usage: ${helpPage.usage ?? ''}`, + ); - if (helpPage.options.length > 0) { - content.push('', 'Options:', ...helpPage.options.map(l => ` ${l}`)); - } - - if (helpPage.commands.length > 0) { - content.push('', 'Commands:', ...helpPage.commands.map(l => ` ${l}`)); - } - content.push('```', ''); + if (helpPage.options.length > 0) { + content.push('', 'Options:', ...helpPage.options.map(l => ` ${l}`)); } + + if (helpPage.commands.length > 0) { + content.push('', 'Commands:', ...helpPage.commands.map(l => ` ${l}`)); + } + content.push('```', ''); } return content.join('\n'); diff --git a/packages/repo-tools/src/commands/api-reports/cli-reports/runCliExtraction.ts b/packages/repo-tools/src/commands/api-reports/cli-reports/runCliExtraction.ts index cb4256f2fc..6ab72024c8 100644 --- a/packages/repo-tools/src/commands/api-reports/cli-reports/runCliExtraction.ts +++ b/packages/repo-tools/src/commands/api-reports/cli-reports/runCliExtraction.ts @@ -65,6 +65,10 @@ function parseHelpPage(helpPageContent: string) { } } + options.sort(); + commands.sort(); + commandArguments.sort(); + return { usage, options, @@ -131,40 +135,45 @@ export async function runCliExtraction({ } } - const report = generateCliReport({ packageName: pkgJson.name, models }); + for (const model of models) { + const report = generateCliReport({ packageName: pkgJson.name, model }); - const reportPath = resolvePath(fullDir, 'cli-report.md'); - const existingReport = await fs - .readFile(reportPath, 'utf8') - .catch(error => { - if (error.code === 'ENOENT') { - return undefined; - } - throw error; - }); - - if (existingReport !== report) { - if (isLocalBuild) { - console.warn(`CLI report changed for ${packageDir}`); - await fs.writeFile(reportPath, report); - } else { - logApiReportInstructions(); - - if (existingReport) { - console.log(''); - console.log( - `The conflicting file is ${relativePath( - cliPaths.targetRoot, - reportPath, - )}, expecting the following content:`, - ); - console.log(''); - - console.log(report); + const reportPath = resolvePath( + fullDir, + `cli-report.${models.length === 1 ? '' : `${model.name}.`}md`, + ); + const existingReport = await fs + .readFile(reportPath, 'utf8') + .catch(error => { + if (error.code === 'ENOENT') { + return undefined; + } + throw error; + }); + if (existingReport !== report) { + if (isLocalBuild) { + console.warn(`CLI report changed for ${packageDir}`); + await fs.writeFile(reportPath, report); + } else { logApiReportInstructions(); + + if (existingReport) { + console.log(''); + console.log( + `The conflicting file is ${relativePath( + cliPaths.targetRoot, + reportPath, + )}, expecting the following content:`, + ); + console.log(''); + + console.log(report); + + logApiReportInstructions(); + } + throw new Error(`CLI report changed for ${packageDir}, `); } - throw new Error(`CLI report changed for ${packageDir}, `); } } } diff --git a/yarn.lock b/yarn.lock index 9b199ff03b..215e6ce4bf 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4035,6 +4035,7 @@ __metadata: optional: true bin: backstage-cli: bin/backstage-cli + backstage-cli-alpha: bin/backstage-cli-alpha languageName: unknown linkType: soft From 2be6a2253e484c3a8d2d815e200eb171874b685c Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sun, 2 Mar 2025 09:48:18 -0600 Subject: [PATCH 2/3] fix other api reports Signed-off-by: aramissennyeydd --- packages/codemods/cli-report.md | 2 +- packages/create-app/cli-report.md | 2 +- packages/e2e-test/cli-report.md | 2 +- packages/repo-tools/cli-report.md | 60 +++++++++---------- packages/techdocs-cli/cli-report.md | 90 ++++++++++++++--------------- 5 files changed, 78 insertions(+), 78 deletions(-) diff --git a/packages/codemods/cli-report.md b/packages/codemods/cli-report.md index 57d2198141..2924999eaa 100644 --- a/packages/codemods/cli-report.md +++ b/packages/codemods/cli-report.md @@ -13,8 +13,8 @@ Options: Commands: apply [target-dirs...] - list help [command] + list ``` ### `backstage-codemods apply` diff --git a/packages/create-app/cli-report.md b/packages/create-app/cli-report.md index 20aa695993..982661fbf5 100644 --- a/packages/create-app/cli-report.md +++ b/packages/create-app/cli-report.md @@ -8,9 +8,9 @@ Usage: backstage-create-app [options] Options: - -V, --version --path [directory] --skip-install --template-path [directory] + -V, --version -h, --help ``` diff --git a/packages/e2e-test/cli-report.md b/packages/e2e-test/cli-report.md index f72344f859..fb03e06280 100644 --- a/packages/e2e-test/cli-report.md +++ b/packages/e2e-test/cli-report.md @@ -12,8 +12,8 @@ Options: -h, --help Commands: - run [options] help [command] + run [options] ``` ### `e2e-test run` diff --git a/packages/repo-tools/cli-report.md b/packages/repo-tools/cli-report.md index 672c22944a..acde92d742 100644 --- a/packages/repo-tools/cli-report.md +++ b/packages/repo-tools/cli-report.md @@ -13,15 +13,15 @@ Options: Commands: api-reports [options] [paths...] - type-deps - peer-deps [options] generate-catalog-info [options] generate-patch [options] - knip-reports [options] [paths...] - package [command] - repo [command] - lint [command] help [command] + knip-reports [options] [paths...] + lint [command] + package [command] + peer-deps [options] + repo [command] + type-deps ``` ### `backstage-repo-tools api-reports` @@ -30,17 +30,17 @@ Commands: Usage: backstage-repo-tools api-reports [options] [paths...] Options: - --ci - --tsc - --docs - --sql-reports - --include - --exclude - -a, --allow-warnings --allow-all-warnings - -o, --omit-messages + --ci + --docs + --exclude + --include + --sql-reports + --tsc --validate-release-tags + -a, --allow-warnings -h, --help + -o, --omit-messages ``` ### `backstage-repo-tools generate-catalog-info` @@ -49,8 +49,8 @@ Options: Usage: backstage-repo-tools generate-catalog-info [options] Options: - --dry-run --ci + --dry-run -h, --help ``` @@ -60,11 +60,11 @@ Options: Usage: backstage-repo-tools generate-patch [options] Options: - --target - --registry-url --base-version --query + --registry-url --skip-install + --target -h, --help ``` @@ -87,8 +87,8 @@ Options: -h, --help Commands: - legacy-backend-exports [paths...] help [command] + legacy-backend-exports [paths...] ``` ### `backstage-repo-tools lint legacy-backend-exports` @@ -109,8 +109,8 @@ Options: -h, --help Commands: - schema [command] help [command] + schema [command] ``` ### `backstage-repo-tools package schema` @@ -122,8 +122,8 @@ Options: -h, --help Commands: - openapi [command] help [command] + openapi [command] ``` ### `backstage-repo-tools package schema openapi` @@ -135,10 +135,10 @@ Options: -h, --help Commands: - init - generate [options] fuzz [options] + generate [options] help [command] + init ``` ### `backstage-repo-tools package schema openapi fuzz` @@ -147,10 +147,10 @@ Commands: Usage: backstage-repo-tools package schema openapi fuzz [options] Options: - --limit - --workers --debug --exclude-checks + --limit + --workers -h, --help ``` @@ -192,8 +192,8 @@ Options: -h, --help Commands: - schema [command] help [command] + schema [command] ``` ### `backstage-repo-tools repo schema` @@ -205,8 +205,8 @@ Options: -h, --help Commands: - openapi [command] help [command] + openapi [command] ``` ### `backstage-repo-tools repo schema openapi` @@ -218,12 +218,12 @@ Options: -h, --help Commands: - verify [paths...] + diff [options] + fuzz [options] + help [command] lint [options] [paths...] test [options] [paths...] - fuzz [options] - diff [options] - help [command] + verify [paths...] ``` ### `backstage-repo-tools repo schema openapi diff` diff --git a/packages/techdocs-cli/cli-report.md b/packages/techdocs-cli/cli-report.md index 5b0f4c9857..4cb7988add 100644 --- a/packages/techdocs-cli/cli-report.md +++ b/packages/techdocs-cli/cli-report.md @@ -13,11 +13,11 @@ Options: Commands: generate|build [options] + help [command] migrate [options] publish [options] - serve:mkdocs [options] serve [options] - help [command] + serve:mkdocs [options] ``` ### `techdocs-cli generate` @@ -26,20 +26,20 @@ Commands: Usage: techdocs-cli generate|build [options] Options: - --source-dir - --output-dir - --docker-image - --no-pull - --no-docker - --techdocs-ref - --etag - --site-name - -v --verbose - --omitTechdocsCoreMkdocsPlugin - --legacyCopyReadmeMdToIndexMd --defaultPlugin [defaultPlugins...] + --docker-image + --etag + --legacyCopyReadmeMdToIndexMd + --no-docker + --no-pull + --omitTechdocsCoreMkdocsPlugin + --output-dir --runAsDefaultUser + --site-name + --source-dir + --techdocs-ref -h, --help + -v --verbose ``` ### `techdocs-cli migrate` @@ -48,21 +48,21 @@ Options: Usage: techdocs-cli migrate [options] Options: - --publisher-type - --storage-name - --azureAccountName - --azureAccountKey - --awsRoleArn --awsEndpoint + --awsRoleArn --awsS3ForcePathStyle + --azureAccountKey + --azureAccountName + --concurrency + --osAuthUrl --osCredentialId --osSecret - --osAuthUrl --osSwiftUrl + --publisher-type --removeOriginal - --concurrency - -v --verbose + --storage-name -h, --help + -v --verbose ``` ### `techdocs-cli publish` @@ -71,25 +71,25 @@ Options: Usage: techdocs-cli publish [options] Options: - --publisher-type - --storage-name - --entity - --legacyUseCaseSensitiveTripletPaths - --azureAccountName - --azureAccountKey - --awsRoleArn - --awsEndpoint - --awsProxy - --awsS3sse - --awsS3ForcePathStyle --awsBucketRootPath + --awsEndpoint --awsMaxAttempts + --awsProxy + --awsRoleArn + --awsS3ForcePathStyle + --awsS3sse + --azureAccountKey + --azureAccountName + --directory + --entity + --gcsBucketRootPath + --legacyUseCaseSensitiveTripletPaths + --osAuthUrl --osCredentialId --osSecret - --osAuthUrl --osSwiftUrl - --gcsBucketRootPath - --directory + --publisher-type + --storage-name -h, --help ``` @@ -99,20 +99,20 @@ Options: Usage: techdocs-cli serve [options] Options: - -i, --docker-image --docker-entrypoint --docker-option - --no-docker - --site-name - --mkdocs-port - -v --verbose - --preview-app-bundle-path - --preview-app-port - -c, --mkdocs-config-file-name --mkdocs-parameter-clean --mkdocs-parameter-dirtyreload --mkdocs-parameter-strict + --mkdocs-port + --no-docker + --preview-app-bundle-path + --preview-app-port + --site-name + -c, --mkdocs-config-file-name -h, --help + -i, --docker-image + -v --verbose ``` ### `techdocs-cli serve:mkdocs` @@ -121,12 +121,12 @@ Options: Usage: techdocs-cli serve:mkdocs [options] Options: - -i, --docker-image --docker-entrypoint --docker-option --no-docker --site-name + -h, --help + -i, --docker-image -p, --port -v --verbose - -h, --help ``` From 47503891e1b59efabbfa89041c71c6ef31a49d8d Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sat, 5 Apr 2025 16:17:59 -0400 Subject: [PATCH 3/3] rerun with latest Signed-off-by: aramissennyeydd --- .../cli/cli-report.backstage-cli-alpha.md | 260 ++++++++++++++++++ packages/cli/cli-report.backstage-cli.md | 39 +-- 2 files changed, 262 insertions(+), 37 deletions(-) diff --git a/packages/cli/cli-report.backstage-cli-alpha.md b/packages/cli/cli-report.backstage-cli-alpha.md index a5f857c893..b52d40c809 100644 --- a/packages/cli/cli-report.backstage-cli-alpha.md +++ b/packages/cli/cli-report.backstage-cli-alpha.md @@ -19,8 +19,12 @@ Commands: config:print config:schema help [command] + info + migrate [command] package [command] repo [command] + versions:bump + versions:migrate ``` ### `backstage-cli-alpha build-workspace` @@ -128,6 +132,78 @@ Options: --version ``` +### `backstage-cli-alpha info` + +``` +Usage: + +Options: + --help + --version +``` + +### `backstage-cli-alpha migrate` + +``` +Usage: backstage-cli migrate [options] [command] [command] + +Options: + -h, --help + +Commands: + help [command] + package-exports + package-lint-configs + package-roles + package-scripts + react-router-deps +``` + +### `backstage-cli-alpha migrate package-exports` + +``` +Usage: program [options] + +Options: + -h, --help +``` + +### `backstage-cli-alpha migrate package-lint-configs` + +``` +Usage: program [options] + +Options: + -h, --help +``` + +### `backstage-cli-alpha migrate package-roles` + +``` +Usage: program [options] + +Options: + -h, --help +``` + +### `backstage-cli-alpha migrate package-scripts` + +``` +Usage: program [options] + +Options: + -h, --help +``` + +### `backstage-cli-alpha migrate react-router-deps` + +``` +Usage: program [options] + +Options: + -h, --help +``` + ### `backstage-cli-alpha package` ``` @@ -139,6 +215,8 @@ Options: Commands: build help [command] + lint + test ``` ### `backstage-cli-alpha package build` @@ -155,6 +233,133 @@ Options: -h, --help ``` +### `backstage-cli-alpha package lint` + +``` +Usage: program [options] [directories...] + +Options: + --fix + --format + --max-warnings + --output-file + -h, --help +``` + +### `backstage-cli-alpha package test` + +``` +Usage: backstage-cli-alpha [--config=] [TestPathPattern] + +Options: + --all + --automock + --cache + --cacheDirectory + --changedFilesWithAncestor + --changedSince + --ci + --clearCache + --clearMocks + --collectCoverage + --collectCoverageFrom + --color + --colors + --coverage + --coverageDirectory + --coveragePathIgnorePatterns + --coverageProvider + --coverageReporters + --coverageThreshold + --debug + --detectLeaks + --detectOpenHandles + --env + --errorOnDeprecated + --filter + --findRelatedTests + --forceExit + --globalSetup + --globalTeardown + --globals + --haste + --ignoreProjects + --init + --injectGlobals + --json + --lastCommit + --listTests + --logHeapUsage + --maxConcurrency + --moduleDirectories + --moduleFileExtensions + --moduleNameMapper + --modulePathIgnorePatterns + --modulePaths + --noStackTrace + --notify + --notifyMode + --openHandlesTimeout + --outputFile + --passWithNoTests + --preset + --prettierPath + --projects + --randomize + --reporters + --resetMocks + --resetModules + --resolver + --restoreMocks + --rootDir + --roots + --runTestsByPath + --runner + --seed + --selectProjects + --setupFiles + --setupFilesAfterEnv + --shard + --showConfig + --showSeed + --silent + --skipFilter + --snapshotSerializers + --testEnvironment + --testEnvironmentOptions + --testFailureExitCode + --testLocationInResults + --testMatch + --testPathIgnorePatterns + --testPathPattern + --testRegex + --testResultsProcessor + --testRunner + --testSequencer + --testTimeout + --transform + --transformIgnorePatterns + --unmockedModulePathPatterns + --useStderr + --verbose + --version + --watch + --watchAll + --watchPathIgnorePatterns + --watchman + --workerThreads + -b, --bail + -c, --config + -e, --expand + -f, --onlyFailures + -h, --help + -i, --runInBand + -o, --onlyChanged + -t, --testNamePattern + -u, --updateSnapshot + -w, --maxWorkers +``` + ### `backstage-cli-alpha repo` ``` @@ -166,6 +371,8 @@ Options: Commands: build help [command] + lint + test ``` ### `backstage-cli-alpha repo build` @@ -179,3 +386,56 @@ Options: --since -h, --help ``` + +### `backstage-cli-alpha repo lint` + +``` +Usage: program [options] + +Options: + --fix + --format + --max-warnings + --output-file + --since + --successCache + --successCacheDir + -h, --help +``` + +### `backstage-cli-alpha repo test` + +``` +Usage: program [options] + +Options: + --jest-help + --since + --successCache + --successCacheDir + -h, --help +``` + +### `backstage-cli-alpha versions:bump` + +``` +Usage: program [options] + +Options: + --pattern + --release + --skip-install + --skip-migrate + -h, --help +``` + +### `backstage-cli-alpha versions:migrate` + +``` +Usage: program [options] + +Options: + --pattern + --skip-code-changes + -h, --help +``` diff --git a/packages/cli/cli-report.backstage-cli.md b/packages/cli/cli-report.backstage-cli.md index 51f7b8c998..03c2c387a9 100644 --- a/packages/cli/cli-report.backstage-cli.md +++ b/packages/cli/cli-report.backstage-cli.md @@ -17,15 +17,6 @@ Commands: config:docs [options] config:print [options] config:schema [options] - repo [command] - package [command] - versions:bump [options] - versions:migrate [options] - migrate [command] - build-workspace [options] [packages...] - info - create-github-app - help [command] create-github-app help [command] info @@ -207,15 +198,7 @@ Options: Commands: build [options] -<<<<<<< HEAD:packages/cli/cli-report.md - test clean - prepack - postpack - lint [options] [directories...] -======= - clean ->>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md help [command] lint [options] [directories...] postpack @@ -288,12 +271,8 @@ Options: --config --inspect [host] --inspect-brk [host] -<<<<<<< HEAD:packages/cli/cli-report.md - --require -======= ->>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md --link - --require + --require --role -h, --help ``` @@ -422,22 +401,12 @@ Options: Commands: build [options] -<<<<<<< HEAD:packages/cli/cli-report.md - test [options] - lint [options] - fix [options] -======= ->>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md clean fix [options] help [command] lint [options] list-deprecations [options] -<<<<<<< HEAD:packages/cli/cli-report.md - help [command] -======= test [options] ->>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md ``` ### `backstage-cli repo build` @@ -480,15 +449,11 @@ Usage: backstage-cli repo lint [options] Options: --fix --format + --max-warnings --output-file --since --successCache --successCacheDir -<<<<<<< HEAD:packages/cli/cli-report.md - --max-warnings - --fix -======= ->>>>>>> e27a77cb9a9d1 (feat: allow multiple CLI reports for easier diff):packages/cli/cli-report.backstage-cli.md -h, --help ```