Merge pull request #29025 from backstage/sennyeya/alpha-cli-report
feat: allow multiple CLI reports for easier diff
This commit is contained in:
Patrik Oldsberg
@@ -0,0 +1,441 @@
|
||||
## 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]
|
||||
info
|
||||
migrate [command]
|
||||
package [command]
|
||||
repo [command]
|
||||
versions:bump
|
||||
versions:migrate
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha build-workspace`
|
||||
|
||||
```
|
||||
Usage: program [options] <workspace-dir> [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: <none>
|
||||
|
||||
Options:
|
||||
--help
|
||||
--package
|
||||
--version
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha config schema`
|
||||
|
||||
```
|
||||
Usage: <none>
|
||||
|
||||
Options:
|
||||
--format
|
||||
--help
|
||||
--merge
|
||||
--no-merge
|
||||
--package
|
||||
--version
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha config:check`
|
||||
|
||||
```
|
||||
Usage: <none>
|
||||
|
||||
Options:
|
||||
--config
|
||||
--deprecated
|
||||
--frontend
|
||||
--help
|
||||
--lax
|
||||
--package
|
||||
--strict
|
||||
--version
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha config:docs`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--package <name>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha config:print`
|
||||
|
||||
```
|
||||
Usage: <none>
|
||||
|
||||
Options:
|
||||
--config
|
||||
--format
|
||||
--frontend
|
||||
--help
|
||||
--lax
|
||||
--package
|
||||
--version
|
||||
--with-secrets
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha config:schema`
|
||||
|
||||
```
|
||||
Usage: <none>
|
||||
|
||||
Options:
|
||||
--format
|
||||
--help
|
||||
--merge
|
||||
--no-merge
|
||||
--package
|
||||
--version
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha info`
|
||||
|
||||
```
|
||||
Usage: <none>
|
||||
|
||||
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`
|
||||
|
||||
```
|
||||
Usage: backstage-cli package [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
build
|
||||
help [command]
|
||||
lint
|
||||
test
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha package build`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--config <path>
|
||||
--minify
|
||||
--role <name>
|
||||
--skip-build-dependencies
|
||||
--stats
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha package lint`
|
||||
|
||||
```
|
||||
Usage: program [options] [directories...]
|
||||
|
||||
Options:
|
||||
--fix
|
||||
--format <format>
|
||||
--max-warnings <number>
|
||||
--output-file <path>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha package test`
|
||||
|
||||
```
|
||||
Usage: backstage-cli-alpha [--config=<pathToConfigFile>] [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`
|
||||
|
||||
```
|
||||
Usage: backstage-cli repo [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
build
|
||||
help [command]
|
||||
lint
|
||||
test
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha repo build`
|
||||
|
||||
```
|
||||
Usage: program [options] [command]
|
||||
|
||||
Options:
|
||||
--all
|
||||
--minify
|
||||
--since <ref>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha repo lint`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--fix
|
||||
--format <format>
|
||||
--max-warnings <number>
|
||||
--output-file <path>
|
||||
--since <ref>
|
||||
--successCache
|
||||
--successCacheDir <path>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha repo test`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--jest-help
|
||||
--since <ref>
|
||||
--successCache
|
||||
--successCacheDir <path>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha versions:bump`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--pattern <glob>
|
||||
--release <version|next|main>
|
||||
--skip-install
|
||||
--skip-migrate
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-cli-alpha versions:migrate`
|
||||
|
||||
```
|
||||
Usage: program [options]
|
||||
|
||||
Options:
|
||||
--pattern <glob>
|
||||
--skip-code-changes
|
||||
-h, --help
|
||||
```
|
||||
@@ -12,20 +12,20 @@ Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
new [options]
|
||||
build-workspace [options] <workspace-dir> [packages...]
|
||||
config:check [options]
|
||||
config:docs [options]
|
||||
config:print [options]
|
||||
config:check [options]
|
||||
config:schema [options]
|
||||
repo [command]
|
||||
package [command]
|
||||
versions:bump [options]
|
||||
versions:migrate [options]
|
||||
migrate [command]
|
||||
build-workspace [options] <workspace-dir> [packages...]
|
||||
info
|
||||
create-github-app <github-org>
|
||||
help [command]
|
||||
info
|
||||
migrate [command]
|
||||
new [options]
|
||||
package [command]
|
||||
repo [command]
|
||||
versions:bump [options]
|
||||
versions:migrate [options]
|
||||
```
|
||||
|
||||
### `backstage-cli build-workspace`
|
||||
@@ -44,12 +44,12 @@ Options:
|
||||
Usage: backstage-cli config:check [options]
|
||||
|
||||
Options:
|
||||
--package <name>
|
||||
--lax
|
||||
--frontend
|
||||
--deprecated
|
||||
--strict
|
||||
--config <path>
|
||||
--deprecated
|
||||
--frontend
|
||||
--lax
|
||||
--package <name>
|
||||
--strict
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -69,12 +69,12 @@ Options:
|
||||
Usage: backstage-cli config:print [options]
|
||||
|
||||
Options:
|
||||
--package <name>
|
||||
--lax
|
||||
--frontend
|
||||
--with-secrets
|
||||
--format <format>
|
||||
--config <path>
|
||||
--format <format>
|
||||
--frontend
|
||||
--lax
|
||||
--package <name>
|
||||
--with-secrets
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -84,10 +84,10 @@ Options:
|
||||
Usage: backstage-cli config:schema [options]
|
||||
|
||||
Options:
|
||||
--package <name>
|
||||
--format <format>
|
||||
--merge
|
||||
--no-merge
|
||||
--package <name>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -118,12 +118,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 +177,14 @@ Options:
|
||||
Usage: backstage-cli new [options]
|
||||
|
||||
Options:
|
||||
--select <name>
|
||||
--option <name>=<value>
|
||||
--skip-install
|
||||
--scope <scope>
|
||||
--npm-registry <URL>
|
||||
--baseVersion <version>
|
||||
--license <license>
|
||||
--no-private
|
||||
--npm-registry <URL>
|
||||
--option <name>=<value>
|
||||
--scope <scope>
|
||||
--select <name>
|
||||
--skip-install
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -197,14 +197,14 @@ Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
start [options]
|
||||
build [options]
|
||||
test
|
||||
clean
|
||||
prepack
|
||||
postpack
|
||||
lint [options] [directories...]
|
||||
help [command]
|
||||
lint [options] [directories...]
|
||||
postpack
|
||||
prepack
|
||||
start [options]
|
||||
test
|
||||
```
|
||||
|
||||
### `backstage-cli package build`
|
||||
@@ -213,11 +213,11 @@ Commands:
|
||||
Usage: backstage-cli package build [options]
|
||||
|
||||
Options:
|
||||
--role <name>
|
||||
--config <path>
|
||||
--minify
|
||||
--role <name>
|
||||
--skip-build-dependencies
|
||||
--stats
|
||||
--config <path>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -236,10 +236,10 @@ Options:
|
||||
Usage: backstage-cli package lint [options] [directories...]
|
||||
|
||||
Options:
|
||||
--format <format>
|
||||
--output-file <path>
|
||||
--fix
|
||||
--format <format>
|
||||
--max-warnings <number>
|
||||
--output-file <path>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -267,13 +267,13 @@ Options:
|
||||
Usage: backstage-cli package start [options]
|
||||
|
||||
Options:
|
||||
--config <path>
|
||||
--role <name>
|
||||
--check
|
||||
--config <path>
|
||||
--inspect [host]
|
||||
--inspect-brk [host]
|
||||
--require <path...>
|
||||
--link <path>
|
||||
--require <path...>
|
||||
--role <name>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -283,11 +283,8 @@ Options:
|
||||
Usage: backstage-cli [--config=<pathToConfigFile>] [TestPathPattern]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
--version
|
||||
--all
|
||||
--automock
|
||||
-b, --bail
|
||||
--cache
|
||||
--cacheDirectory
|
||||
--changedFilesWithAncestor
|
||||
@@ -299,7 +296,6 @@ Options:
|
||||
--collectCoverageFrom
|
||||
--color
|
||||
--colors
|
||||
-c, --config
|
||||
--coverage
|
||||
--coverageDirectory
|
||||
--coveragePathIgnorePatterns
|
||||
@@ -311,7 +307,6 @@ Options:
|
||||
--detectOpenHandles
|
||||
--env
|
||||
--errorOnDeprecated
|
||||
-e, --expand
|
||||
--filter
|
||||
--findRelatedTests
|
||||
--forceExit
|
||||
@@ -327,7 +322,6 @@ Options:
|
||||
--listTests
|
||||
--logHeapUsage
|
||||
--maxConcurrency
|
||||
-w, --maxWorkers
|
||||
--moduleDirectories
|
||||
--moduleFileExtensions
|
||||
--moduleNameMapper
|
||||
@@ -336,8 +330,6 @@ Options:
|
||||
--noStackTrace
|
||||
--notify
|
||||
--notifyMode
|
||||
-o, --onlyChanged
|
||||
-f, --onlyFailures
|
||||
--openHandlesTimeout
|
||||
--outputFile
|
||||
--passWithNoTests
|
||||
@@ -352,7 +344,6 @@ Options:
|
||||
--restoreMocks
|
||||
--rootDir
|
||||
--roots
|
||||
-i, --runInBand
|
||||
--runTestsByPath
|
||||
--runner
|
||||
--seed
|
||||
@@ -370,7 +361,6 @@ Options:
|
||||
--testFailureExitCode
|
||||
--testLocationInResults
|
||||
--testMatch
|
||||
-t, --testNamePattern
|
||||
--testPathIgnorePatterns
|
||||
--testPathPattern
|
||||
--testRegex
|
||||
@@ -381,14 +371,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 +401,12 @@ Options:
|
||||
|
||||
Commands:
|
||||
build [options]
|
||||
test [options]
|
||||
lint [options]
|
||||
fix [options]
|
||||
clean
|
||||
list-deprecations [options]
|
||||
fix [options]
|
||||
help [command]
|
||||
lint [options]
|
||||
list-deprecations [options]
|
||||
test [options]
|
||||
```
|
||||
|
||||
### `backstage-cli repo build`
|
||||
@@ -416,8 +416,8 @@ Usage: backstage-cli repo build [options]
|
||||
|
||||
Options:
|
||||
--all
|
||||
--since <ref>
|
||||
--minify
|
||||
--since <ref>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -436,8 +436,8 @@ Options:
|
||||
Usage: backstage-cli repo fix [options]
|
||||
|
||||
Options:
|
||||
--publish
|
||||
--check
|
||||
--publish
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -447,13 +447,13 @@ Options:
|
||||
Usage: backstage-cli repo lint [options]
|
||||
|
||||
Options:
|
||||
--fix
|
||||
--format <format>
|
||||
--max-warnings <number>
|
||||
--output-file <path>
|
||||
--since <ref>
|
||||
--successCache
|
||||
--successCacheDir <path>
|
||||
--max-warnings <number>
|
||||
--fix
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -473,10 +473,10 @@ Options:
|
||||
Usage: backstage-cli repo test [options]
|
||||
|
||||
Options:
|
||||
--jest-help
|
||||
--since <ref>
|
||||
--successCache
|
||||
--successCacheDir <path>
|
||||
--jest-help
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -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',
|
||||
),
|
||||
|
||||
@@ -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);
|
||||
},
|
||||
});
|
||||
},
|
||||
});
|
||||
|
||||
@@ -13,8 +13,8 @@ Options:
|
||||
|
||||
Commands:
|
||||
apply <codemod> [target-dirs...]
|
||||
list
|
||||
help [command]
|
||||
list
|
||||
```
|
||||
|
||||
### `backstage-codemods apply`
|
||||
|
||||
@@ -8,9 +8,9 @@
|
||||
Usage: backstage-create-app [options]
|
||||
|
||||
Options:
|
||||
-V, --version
|
||||
--path [directory]
|
||||
--skip-install
|
||||
--template-path [directory]
|
||||
-V, --version
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -12,8 +12,8 @@ Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
run [options]
|
||||
help [command]
|
||||
run [options]
|
||||
```
|
||||
|
||||
### `e2e-test run`
|
||||
|
||||
@@ -13,15 +13,15 @@ Options:
|
||||
|
||||
Commands:
|
||||
api-reports [options] [paths...]
|
||||
type-deps
|
||||
peer-deps [options]
|
||||
generate-catalog-info [options]
|
||||
generate-patch [options] <package>
|
||||
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 <pattern>
|
||||
--exclude <pattern>
|
||||
-a, --allow-warnings <allowWarningsPaths>
|
||||
--allow-all-warnings
|
||||
-o, --omit-messages <messageCodes>
|
||||
--ci
|
||||
--docs
|
||||
--exclude <pattern>
|
||||
--include <pattern>
|
||||
--sql-reports
|
||||
--tsc
|
||||
--validate-release-tags
|
||||
-a, --allow-warnings <allowWarningsPaths>
|
||||
-h, --help
|
||||
-o, --omit-messages <messageCodes>
|
||||
```
|
||||
|
||||
### `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] <package>
|
||||
|
||||
Options:
|
||||
--target <target-repo>
|
||||
--registry-url <registry-url>
|
||||
--base-version <version>
|
||||
--query <query>
|
||||
--registry-url <registry-url>
|
||||
--skip-install
|
||||
--target <target-repo>
|
||||
-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 <limit>
|
||||
--workers <workers>
|
||||
--debug
|
||||
--exclude-checks <excludeChecks>
|
||||
--limit <limit>
|
||||
--workers <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`
|
||||
|
||||
@@ -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 ?? '<none>'}`,
|
||||
);
|
||||
for (const helpPage of model.helpPages) {
|
||||
content.push(
|
||||
`### \`${[model.name, ...helpPage.path].join(' ')}\``,
|
||||
'',
|
||||
'```',
|
||||
`Usage: ${helpPage.usage ?? '<none>'}`,
|
||||
);
|
||||
|
||||
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');
|
||||
|
||||
@@ -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}, `);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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 <PATH>
|
||||
--output-dir <PATH>
|
||||
--docker-image <DOCKER_IMAGE>
|
||||
--no-pull
|
||||
--no-docker
|
||||
--techdocs-ref <HOST_TYPE:URL>
|
||||
--etag <ETAG>
|
||||
--site-name
|
||||
-v --verbose
|
||||
--omitTechdocsCoreMkdocsPlugin
|
||||
--legacyCopyReadmeMdToIndexMd
|
||||
--defaultPlugin [defaultPlugins...]
|
||||
--docker-image <DOCKER_IMAGE>
|
||||
--etag <ETAG>
|
||||
--legacyCopyReadmeMdToIndexMd
|
||||
--no-docker
|
||||
--no-pull
|
||||
--omitTechdocsCoreMkdocsPlugin
|
||||
--output-dir <PATH>
|
||||
--runAsDefaultUser
|
||||
--site-name
|
||||
--source-dir <PATH>
|
||||
--techdocs-ref <HOST_TYPE:URL>
|
||||
-h, --help
|
||||
-v --verbose
|
||||
```
|
||||
|
||||
### `techdocs-cli migrate`
|
||||
@@ -48,21 +48,21 @@ Options:
|
||||
Usage: techdocs-cli migrate [options]
|
||||
|
||||
Options:
|
||||
--publisher-type <TYPE>
|
||||
--storage-name <BUCKET/CONTAINER NAME>
|
||||
--azureAccountName <AZURE ACCOUNT NAME>
|
||||
--azureAccountKey <AZURE ACCOUNT KEY>
|
||||
--awsRoleArn <AWS ROLE ARN>
|
||||
--awsEndpoint <AWS ENDPOINT>
|
||||
--awsRoleArn <AWS ROLE ARN>
|
||||
--awsS3ForcePathStyle
|
||||
--azureAccountKey <AZURE ACCOUNT KEY>
|
||||
--azureAccountName <AZURE ACCOUNT NAME>
|
||||
--concurrency <MAX CONCURRENT REQS>
|
||||
--osAuthUrl <OPENSTACK SWIFT AUTHURL>
|
||||
--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>
|
||||
--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>
|
||||
--osAuthUrl <OPENSTACK SWIFT AUTHURL>
|
||||
--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>
|
||||
--publisher-type <TYPE>
|
||||
--removeOriginal
|
||||
--concurrency <MAX CONCURRENT REQS>
|
||||
-v --verbose
|
||||
--storage-name <BUCKET/CONTAINER NAME>
|
||||
-h, --help
|
||||
-v --verbose
|
||||
```
|
||||
|
||||
### `techdocs-cli publish`
|
||||
@@ -71,25 +71,25 @@ Options:
|
||||
Usage: techdocs-cli publish [options]
|
||||
|
||||
Options:
|
||||
--publisher-type <TYPE>
|
||||
--storage-name <BUCKET/CONTAINER NAME>
|
||||
--entity <NAMESPACE/KIND/NAME>
|
||||
--legacyUseCaseSensitiveTripletPaths
|
||||
--azureAccountName <AZURE ACCOUNT NAME>
|
||||
--azureAccountKey <AZURE ACCOUNT KEY>
|
||||
--awsRoleArn <AWS ROLE ARN>
|
||||
--awsEndpoint <AWS ENDPOINT>
|
||||
--awsProxy <HTTPS Proxy>
|
||||
--awsS3sse <AWS SSE>
|
||||
--awsS3ForcePathStyle
|
||||
--awsBucketRootPath <AWS BUCKET ROOT PATH>
|
||||
--awsEndpoint <AWS ENDPOINT>
|
||||
--awsMaxAttempts <AWS MAX ATTEMPTS>
|
||||
--awsProxy <HTTPS Proxy>
|
||||
--awsRoleArn <AWS ROLE ARN>
|
||||
--awsS3ForcePathStyle
|
||||
--awsS3sse <AWS SSE>
|
||||
--azureAccountKey <AZURE ACCOUNT KEY>
|
||||
--azureAccountName <AZURE ACCOUNT NAME>
|
||||
--directory <PATH>
|
||||
--entity <NAMESPACE/KIND/NAME>
|
||||
--gcsBucketRootPath <GCS BUCKET ROOT PATH>
|
||||
--legacyUseCaseSensitiveTripletPaths
|
||||
--osAuthUrl <OPENSTACK SWIFT AUTHURL>
|
||||
--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>
|
||||
--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>
|
||||
--osAuthUrl <OPENSTACK SWIFT AUTHURL>
|
||||
--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>
|
||||
--gcsBucketRootPath <GCS BUCKET ROOT PATH>
|
||||
--directory <PATH>
|
||||
--publisher-type <TYPE>
|
||||
--storage-name <BUCKET/CONTAINER NAME>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
@@ -99,20 +99,20 @@ Options:
|
||||
Usage: techdocs-cli serve [options]
|
||||
|
||||
Options:
|
||||
-i, --docker-image <DOCKER_IMAGE>
|
||||
--docker-entrypoint <DOCKER_ENTRYPOINT>
|
||||
--docker-option <DOCKER_OPTION...>
|
||||
--no-docker
|
||||
--site-name
|
||||
--mkdocs-port <PORT>
|
||||
-v --verbose
|
||||
--preview-app-bundle-path <PATH_TO_BUNDLE>
|
||||
--preview-app-port <PORT>
|
||||
-c, --mkdocs-config-file-name <FILENAME>
|
||||
--mkdocs-parameter-clean
|
||||
--mkdocs-parameter-dirtyreload
|
||||
--mkdocs-parameter-strict
|
||||
--mkdocs-port <PORT>
|
||||
--no-docker
|
||||
--preview-app-bundle-path <PATH_TO_BUNDLE>
|
||||
--preview-app-port <PORT>
|
||||
--site-name
|
||||
-c, --mkdocs-config-file-name <FILENAME>
|
||||
-h, --help
|
||||
-i, --docker-image <DOCKER_IMAGE>
|
||||
-v --verbose
|
||||
```
|
||||
|
||||
### `techdocs-cli serve:mkdocs`
|
||||
@@ -121,12 +121,12 @@ Options:
|
||||
Usage: techdocs-cli serve:mkdocs [options]
|
||||
|
||||
Options:
|
||||
-i, --docker-image <DOCKER_IMAGE>
|
||||
--docker-entrypoint <DOCKER_ENTRYPOINT>
|
||||
--docker-option <DOCKER_OPTION...>
|
||||
--no-docker
|
||||
--site-name
|
||||
-h, --help
|
||||
-i, --docker-image <DOCKER_IMAGE>
|
||||
-p, --port <PORT>
|
||||
-v --verbose
|
||||
-h, --help
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user