Generate CLI reports for cli-module packages

Include cli-module role in CLI report generation alongside the
existing cli role. Packages without a bin field are silently skipped.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-03-15 23:12:59 +01:00
parent 55f6eb8c64
commit 6395e35c6a
13 changed files with 906 additions and 3 deletions
+96
View File
@@ -0,0 +1,96 @@
## CLI Report file for "@backstage/cli-module-auth"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-auth`
```
Usage: @backstage/cli-module-auth [options] [command]
Options:
-V, --version
-h, --help
Commands:
auth [command]
help [command]
```
### `cli-module-auth auth`
```
Usage: @backstage/cli-module-auth auth [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
list
login
logout
print-token
select
show
```
### `cli-module-auth auth list`
```
Usage: @backstage/cli-module-auth auth list
Options:
-h, --help
```
### `cli-module-auth auth login`
```
Usage: @backstage/cli-module-auth auth login
Options:
--backend-url <string>
--instance <string>
--no-browser
-h, --help
```
### `cli-module-auth auth logout`
```
Usage: @backstage/cli-module-auth auth logout
Options:
--instance <string>
-h, --help
```
### `cli-module-auth auth print-token`
```
Usage: @backstage/cli-module-auth auth print-token
Options:
--instance <string>
-h, --help
```
### `cli-module-auth auth select`
```
Usage: @backstage/cli-module-auth auth select
Options:
--instance <string>
-h, --help
```
### `cli-module-auth auth show`
```
Usage: @backstage/cli-module-auth auth show
Options:
--instance <string>
-h, --help
```
+156
View File
@@ -0,0 +1,156 @@
## CLI Report file for "@backstage/cli-module-build"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-build`
```
Usage: @backstage/cli-module-build [options] [command]
Options:
-V, --version
-h, --help
Commands:
build-workspace
help [command]
package [command]
repo [command]
```
### `cli-module-build build-workspace`
```
Usage: @backstage/cli-module-build build-workspace <workspace-dir> [packages...]
Options:
--always-pack
-h, --help
```
### `cli-module-build package`
```
Usage: @backstage/cli-module-build package [options] [command] [command]
Options:
-h, --help
Commands:
build
clean
help [command]
postpack
prepack
start
```
### `cli-module-build package build`
```
Usage: @backstage/cli-module-build package build
Options:
--config <string>
--minify
--module-federation
--role <string>
--skip-build-dependencies
--stats
-h, --help
```
### `cli-module-build package clean`
```
Usage: @backstage/cli-module-build package clean
Options:
-h, --help
```
### `cli-module-build package postpack`
```
Usage: @backstage/cli-module-build package postpack
Options:
-h, --help
```
### `cli-module-build package prepack`
```
Usage: @backstage/cli-module-build package prepack
Options:
-h, --help
```
### `cli-module-build package start`
```
Usage: @backstage/cli-module-build package start
Options:
--check
--config <string>
--entrypoint <string>
--inspect <string>
--inspect-brk <string>
--link <string>
--require <string>
--role <string>
-h, --help
```
### `cli-module-build repo`
```
Usage: @backstage/cli-module-build repo [options] [command] [command]
Options:
-h, --help
Commands:
build
clean
help [command]
start
```
### `cli-module-build repo build`
```
Usage: @backstage/cli-module-build repo build
Options:
--all
--minify
--since <string>
-h, --help
```
### `cli-module-build repo clean`
```
Usage: @backstage/cli-module-build repo clean
Options:
-h, --help
```
### `cli-module-build repo start`
```
Usage: @backstage/cli-module-build repo start [packages...]
Options:
--config <string>
--inspect <string>
--inspect-brk <string>
--link <string>
--plugin <string>
--require <string>
-h, --help
```
+109
View File
@@ -0,0 +1,109 @@
## CLI Report file for "@backstage/cli-module-config"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-config`
```
Usage: @backstage/cli-module-config [options] [command]
Options:
-V, --version
-h, --help
Commands:
config [command]
config:check
config:docs
config:print
config:schema
help [command]
```
### `cli-module-config config`
```
Usage: @backstage/cli-module-config config [options] [command] [command]
Options:
-h, --help
Commands:
docs
help [command]
schema
```
### `cli-module-config config docs`
```
Usage: @backstage/cli-module-config config docs
Options:
--package <string>
-h, --help
```
### `cli-module-config config schema`
```
Usage: @backstage/cli-module-config config schema
Options:
--format <string>
--merge
--package <string>
-h, --help
```
### `cli-module-config config:check`
```
Usage: @backstage/cli-module-config config:check
Options:
--config <string>
--deprecated
--frontend
--lax
--package <string>
--strict
-h, --help
```
### `cli-module-config config:docs`
```
Usage: @backstage/cli-module-config config:docs
Options:
--package <string>
-h, --help
```
### `cli-module-config config:print`
```
Usage: @backstage/cli-module-config config:print
Options:
--config <string>
--format <string>
--frontend
--lax
--package <string>
--with-secrets
-h, --help
```
### `cli-module-config config:schema`
```
Usage: @backstage/cli-module-config config:schema
Options:
--format <string>
--merge
--package <string>
-h, --help
```
@@ -0,0 +1,26 @@
## CLI Report file for "@backstage/cli-module-create-github-app"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-create-github-app`
```
Usage: @backstage/cli-module-create-github-app [options] [command]
Options:
-V, --version
-h, --help
Commands:
create-github-app
help [command]
```
### `cli-module-create-github-app create-github-app`
```
Usage: @backstage/cli-module-create-github-app create-github-app <github-org>
Options:
-h, --help
```
+28
View File
@@ -0,0 +1,28 @@
## CLI Report file for "@backstage/cli-module-info"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-info`
```
Usage: @backstage/cli-module-info [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
info
```
### `cli-module-info info`
```
Usage: @backstage/cli-module-info info
Options:
--format <string>
--include <string>
-h, --help
```
+73
View File
@@ -0,0 +1,73 @@
## CLI Report file for "@backstage/cli-module-lint"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-lint`
```
Usage: @backstage/cli-module-lint [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
package [command]
repo [command]
```
### `cli-module-lint package`
```
Usage: @backstage/cli-module-lint package [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
lint
```
### `cli-module-lint package lint`
```
Usage: @backstage/cli-module-lint package lint [directories...]
Options:
--fix
--format <string>
--max-warnings <string>
--output-file <string>
-h, --help
```
### `cli-module-lint repo`
```
Usage: @backstage/cli-module-lint repo [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
lint
```
### `cli-module-lint repo lint`
```
Usage: @backstage/cli-module-lint repo lint
Options:
--fix
--format <string>
--max-warnings <string>
--output-file <string>
--since <string>
--success-cache
--success-cache-dir <string>
-h, --help
```
@@ -0,0 +1,52 @@
## CLI Report file for "@backstage/cli-module-maintenance"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-maintenance`
```
Usage: @backstage/cli-module-maintenance [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
repo [command]
```
### `cli-module-maintenance repo`
```
Usage: @backstage/cli-module-maintenance repo [options] [command] [command]
Options:
-h, --help
Commands:
fix
help [command]
list-deprecations
```
### `cli-module-maintenance repo fix`
```
Usage: @backstage/cli-module-maintenance repo fix
Options:
--check
--publish
-h, --help
```
### `cli-module-maintenance repo list-deprecations`
```
Usage: @backstage/cli-module-maintenance repo list-deprecations
Options:
--json
-h, --help
```
+105
View File
@@ -0,0 +1,105 @@
## CLI Report file for "@backstage/cli-module-migrate"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-migrate`
```
Usage: @backstage/cli-module-migrate [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
migrate [command]
versions:bump
versions:migrate
```
### `cli-module-migrate migrate`
```
Usage: @backstage/cli-module-migrate migrate [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
package-exports
package-lint-configs
package-roles
package-scripts
react-router-deps
```
### `cli-module-migrate migrate package-exports`
```
Usage: @backstage/cli-module-migrate migrate package-exports
Options:
-h, --help
```
### `cli-module-migrate migrate package-lint-configs`
```
Usage: @backstage/cli-module-migrate migrate package-lint-configs
Options:
-h, --help
```
### `cli-module-migrate migrate package-roles`
```
Usage: @backstage/cli-module-migrate migrate package-roles
Options:
-h, --help
```
### `cli-module-migrate migrate package-scripts`
```
Usage: @backstage/cli-module-migrate migrate package-scripts
Options:
-h, --help
```
### `cli-module-migrate migrate react-router-deps`
```
Usage: @backstage/cli-module-migrate migrate react-router-deps
Options:
-h, --help
```
### `cli-module-migrate versions:bump`
```
Usage: @backstage/cli-module-migrate versions:bump
Options:
--pattern <string>
--release <string>
--skip-install
--skip-migrate
-h, --help
```
### `cli-module-migrate versions:migrate`
```
Usage: @backstage/cli-module-migrate versions:migrate
Options:
--pattern <string>
--skip-code-changes
-h, --help
```
+34
View File
@@ -0,0 +1,34 @@
## CLI Report file for "@backstage/cli-module-new"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-new`
```
Usage: @backstage/cli-module-new [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
new
```
### `cli-module-new new`
```
Usage: @backstage/cli-module-new new
Options:
--base-version <string>
--license <string>
--npm-registry <string>
--option <string>
--private
--scope <string>
--select <string>
--skip-install
-h, --help
```
+170
View File
@@ -0,0 +1,170 @@
## CLI Report file for "@backstage/cli-module-test-jest"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-test-jest`
```
Usage: @backstage/cli-module-test-jest [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
package [command]
repo [command]
```
### `cli-module-test-jest package`
```
Usage: @backstage/cli-module-test-jest package [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
test
```
### `cli-module-test-jest package test`
```
Usage: cli-module-test-jest [--config=<pathToConfigFile>] [TestPathPatterns]
Options:
--all
--automock
--cache
--cacheDirectory
--changedFilesWithAncestor
--changedSince
--ci
--clearCache
--clearMocks
--collectCoverage
--collectCoverageFrom
--color
--colors
--coverage
--coverageDirectory
--coveragePathIgnorePatterns
--coverageProvider
--coverageReporters
--coverageThreshold
--debug
--detectLeaks
--detectOpenHandles
--errorOnDeprecated
--filter
--findRelatedTests
--forceExit
--globalSetup
--globalTeardown
--globals
--haste
--ignoreProjects
--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, --env
--testEnvironmentOptions
--testFailureExitCode
--testLocationInResults
--testMatch
--testPathIgnorePatterns
--testPathPatterns
--testRegex
--testResultsProcessor
--testRunner
--testSequencer
--testTimeout
--transform
--transformIgnorePatterns
--unmockedModulePathPatterns
--useStderr
--verbose
--version
--waitForUnhandledRejections
--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
```
### `cli-module-test-jest repo`
```
Usage: @backstage/cli-module-test-jest repo [options] [command] [command]
Options:
-h, --help
Commands:
help [command]
test
```
### `cli-module-test-jest repo test`
```
Usage: @backstage/cli-module-test-jest repo test
Options:
--jest-help
--since <string>
--success-cache
--success-cache-dir <string>
-h, --help
```
@@ -0,0 +1,53 @@
## CLI Report file for "@backstage/cli-module-translations"
> Do not edit this file. It is a report generated by `yarn build:api-reports`
### `cli-module-translations`
```
Usage: @backstage/cli-module-translations [options] [command]
Options:
-V, --version
-h, --help
Commands:
help [command]
translations [command]
```
### `cli-module-translations translations`
```
Usage: @backstage/cli-module-translations translations [options] [command] [command]
Options:
-h, --help
Commands:
export
help [command]
import
```
### `cli-module-translations translations export`
```
Usage: @backstage/cli-module-translations translations export
Options:
--output <string>
--pattern <string>
-h, --help
```
### `cli-module-translations translations import`
```
Usage: @backstage/cli-module-translations translations import
Options:
--input <string>
--output <string>
-h, --help
```
@@ -54,9 +54,10 @@ export async function categorizePackageDirs(packageDirs: string[]) {
if (pkgJson?.backstage?.inline) {
return;
}
if (role === 'cli') {
if (role === 'cli' || role === 'cli-module') {
cliPackageDirs.push(dir);
} else if (role !== 'frontend' && role !== 'backend') {
}
if (role !== 'cli' && role !== 'frontend' && role !== 'backend') {
tsPackageDirs.push(dir);
}
}
@@ -132,7 +132,7 @@ export async function runCliExtraction({
const pkgJson = await fs.readJson(resolvePath(fullDir, 'package.json'));
if (!pkgJson.bin) {
throw new Error(`CLI Package in ${packageDir} has no bin field`);
continue;
}
const models = new Array<CliModel>();