generate API reports for CLI packages

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-06-23 14:56:38 +02:00
parent e9fd938ede
commit 0bc7eb1642
5 changed files with 644 additions and 0 deletions
@@ -0,0 +1,425 @@
+## CLI Report file for "@backstage/cli"
+
+> Do not edit this file. It is a report generated by `yarn build:api-reports`
+
+### `backstage-cli`
+
+```
+Usage: backstage-cli [options] [command]
+
+Options:
+  -V, --version
+  -h, --help
+
+Commands:
+  create [options]
+  create-plugin [options]
+  plugin:diff [options]
+  test
+  config:docs [options]
+  config:print [options]
+  config:check [options]
+  config:schema [options]
+  repo [command]
+  package [command]
+  migrate [command]
+  versions:bump [options]
+  versions:check [options]
+  clean
+  build-workspace <workspace-dir> [packages...]
+  create-github-app <github-org>
+  info
+  help [command]
+```
+
+### `backstage-cli build-workspace`
+
+```
+Usage: backstage-cli build-workspace [options] <workspace-dir> [packages...]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli clean`
+
+```
+Usage: backstage-cli clean [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli config:check`
+
+```
+Usage: backstage-cli config:check [options]
+
+Options:
+  --package <name>
+  --lax
+  --frontend
+  --deprecated
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli config:docs`
+
+```
+Usage: backstage-cli config:docs [options]
+
+Options:
+  --package <name>
+  -h, --help
+```
+
+### `backstage-cli config:print`
+
+```
+Usage: backstage-cli config:print [options]
+
+Options:
+  --package <name>
+  --lax
+  --frontend
+  --with-secrets
+  --format <format>
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli config:schema`
+
+```
+Usage: backstage-cli config:schema [options]
+
+Options:
+  --package <name>
+  --format <format>
+  -h, --help
+```
+
+### `backstage-cli create`
+
+```
+Usage: backstage-cli create [options]
+
+Options:
+  --select <name>
+  --option <name>=<value>
+  --scope <scope>
+  --npm-registry <URL>
+  --no-private
+  -h, --help
+```
+
+### `backstage-cli create-github-app`
+
+```
+Usage: backstage-cli create-github-app [options] <github-org>
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli create-plugin`
+
+```
+Usage: backstage-cli create-plugin [options]
+
+Options:
+  --backend
+  --scope <scope>
+  --npm-registry <URL>
+  --no-private
+  -h, --help
+```
+
+### `backstage-cli info`
+
+```
+Usage: backstage-cli info [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate`
+
+```
+Usage: backstage-cli migrate [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  package-roles
+  package-scripts
+  package-lint-configs
+  help [command]
+```
+
+### `backstage-cli migrate package-lint-configs`
+
+```
+Usage: backstage-cli migrate package-lint-configs [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate package-roles`
+
+```
+Usage: backstage-cli migrate package-roles [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate package-scripts`
+
+```
+Usage: backstage-cli migrate package-scripts [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package`
+
+```
+Usage: backstage-cli package [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  start [options]
+  build [options]
+  lint [options] [directories...]
+  test
+  clean
+  prepack
+  postpack
+  help [command]
+```
+
+### `backstage-cli package build`
+
+```
+Usage: backstage-cli package build [options]
+
+Options:
+  --role <name>
+  --minify
+  --experimental-type-build
+  --skip-build-dependencies
+  --stats
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli package clean`
+
+```
+Usage: backstage-cli package clean [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package lint`
+
+```
+Usage: backstage-cli package lint [options] [directories...]
+
+Options:
+  --format <format>
+  --fix
+  -h, --help
+```
+
+### `backstage-cli package postpack`
+
+```
+Usage: backstage-cli package postpack [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package prepack`
+
+```
+Usage: backstage-cli package prepack [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package start`
+
+```
+Usage: backstage-cli package start [options]
+
+Options:
+  --config <path>
+  --role <name>
+  --check
+  --inspect
+  --inspect-brk
+  -h, --help
+```
+
+### `backstage-cli package test`
+
+```
+Usage: backstage-cli [--config=<pathToConfigFile>] [TestPathPattern]
+
+Options:
+  -h, --help
+  -v, --version
+  --all
+  --automock
+  -b, --bail
+  --cache
+  --cacheDirectory
+  --changedFilesWithAncestor
+  --changedSince
+  --ci
+  --clearCache
+  --clearMocks
+  --collectCoverage
+  --collectCoverageFrom
+  --collectCoverageOnlyFrom
+  --color
+  --colors
+  -c, --config
+  --coverage
+  --coverageDirectory
+  --coveragePathIgnorePatterns
+  --coverageProvider
+  --coverageReporters
+  --coverageThreshold
+  --debug
+  --detectLeaks
+  --detectOpenHandles
+  --env
+  --errorOnDeprecated
+  -e, --expand
+  --filter
+  --findRelatedTests
+  --forceExit
+```
+
+### `backstage-cli plugin:diff`
+
+```
+Usage: backstage-cli plugin:diff [options]
+
+Options:
+  --check
+  --yes
+  -h, --help
+```
+
+### `backstage-cli repo`
+
+```
+Usage: backstage-cli repo [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  build [options]
+  lint [options]
+  help [command]
+```
+
+### `backstage-cli repo build`
+
+```
+Usage: backstage-cli repo build [options]
+
+Options:
+  --all
+  --since <ref>
+  -h, --help
+```
+
+### `backstage-cli repo lint`
+
+```
+Usage: backstage-cli repo lint [options]
+
+Options:
+  --format <format>
+  --since <ref>
+  --fix
+  -h, --help
+```
+
+### `backstage-cli test`
+
+```
+Usage: backstage-cli [--config=<pathToConfigFile>] [TestPathPattern]
+
+Options:
+  -h, --help
+  -v, --version
+  --all
+  --automock
+  -b, --bail
+  --cache
+  --cacheDirectory
+  --changedFilesWithAncestor
+  --changedSince
+  --ci
+  --clearCache
+  --clearMocks
+  --collectCoverage
+  --collectCoverageFrom
+  --collectCoverageOnlyFrom
+  --color
+  --colors
+  -c, --config
+  --coverage
+  --coverageDirectory
+  --coveragePathIgnorePatterns
+  --coverageProvider
+  --coverageReporters
+  --coverageThreshold
+  --debug
+  --detectLeaks
+  --detectOpenHandles
+  --env
+  --errorOnDeprecated
+  -e, --expand
+  --filter
+  --findRelatedTests
+  --forceExit
+```
+
+### `backstage-cli versions:bump`
+
+```
+Usage: backstage-cli versions:bump [options]
+
+Options:
+  --pattern <glob>
+  --release <version|next|main>
+  -h, --help
+```
+
+### `backstage-cli versions:check`
+
+```
+Usage: backstage-cli versions:check [options]
+
+Options:
+  --fix
+  -h, --help
+```