refactor(build-tools): rename run bundleStats to `publish bundleSta…

…ts` (#23275) Renamed `run bundleStats` command to `publish bundleStats` using oclif aliases. Deprecated current `run bundleStats` command.
microsoft · Dec 17, 2024 · 1abfabb · 1abfabb
1 parent 80d62b5
commit 1abfabb
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/build-tools/packages/build-cli/README.md b/build-tools/packages/build-cli/README.md
@@ -48,7 +48,6 @@ USAGE
 * [`flub release`](docs/release.md) - Release commands are used to manage the Fluid release process.
 * [`flub rename-types`](docs/rename-types.md) - Renames type declaration files from .d.ts to .d.mts.
 * [`flub report`](docs/report.md) - Report analysis about the codebase, like code coverage and bundle size measurements.
-* [`flub run`](docs/run.md) - Generate a report from input bundle stats collected through the collect bundleStats command.
 * [`flub transform`](docs/transform.md) - Transform commands are used to transform code, docs, etc. into alternative forms.
 * [`flub typetests`](docs/typetests.md) - Updates configuration for type tests in package.json files. If the previous version changes after running preparation, then npm install must be run before building.
 

diff --git a/build-tools/packages/build-cli/docs/publish.md b/build-tools/packages/build-cli/docs/publish.md
@@ -3,8 +3,33 @@
 
 Publish commands are used to publish packages to an npm registry.
 
+* [`flub publish bundleStats`](#flub-publish-bundlestats)
 * [`flub publish tarballs`](#flub-publish-tarballs)
 
+## `flub publish bundleStats`
+
+Generate a report from input bundle stats collected through the collect bundleStats command.
+
+```
+USAGE
+  $ flub publish bundleStats [-v | --quiet] [--dangerfile <value>]
+
+FLAGS
+  --dangerfile=<value>  Path to dangerfile
+
+LOGGING FLAGS
+  -v, --verbose  Enable verbose logging.
+      --quiet    Disable all logging.
+
+DESCRIPTION
+  Generate a report from input bundle stats collected through the collect bundleStats command.
+
+ALIASES
+  $ flub run bundleStats
+```
+
+_See code: [src/commands/publish/bundleStats.ts](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/build-cli/src/commands/publish/bundleStats.ts)_
+
 ## `flub publish tarballs`
 
 Publishes tarballs to the package registry unless the version is already published.

diff --git a/build-tools/packages/build-cli/docs/run.md b/build-tools/packages/build-cli/docs/run.md
@@ -22,6 +22,9 @@ LOGGING FLAGS
 
 DESCRIPTION
   Generate a report from input bundle stats collected through the collect bundleStats command.
+
+ALIASES
+  $ flub publish bundleStats
 ```
 
 _See code: [src/commands/run/bundleStats.ts](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/build-cli/src/commands/run/bundleStats.ts)_
diff --git a/...build-cli/src/commands/run/bundleStats.ts → ...d-cli/src/commands/publish/bundleStats.ts b/...build-cli/src/commands/run/bundleStats.ts → ...d-cli/src/commands/publish/bundleStats.ts
@@ -12,10 +12,13 @@ import { BaseCommand } from "../../library/index.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-export default class RunBundlestats extends BaseCommand<typeof RunBundlestats> {
+export default class Bundlestats extends BaseCommand<typeof Bundlestats> {
 	static readonly description =
 		`Generate a report from input bundle stats collected through the collect bundleStats command.`;
 
+	static readonly aliases = ["run:bundleStats"];
+	static readonly deprecateAliases = true;
+
 	static readonly flags = {
 		dangerfile: Flags.file({
 			description: "Path to dangerfile",