feat(cli): create rsdoctor/cli package (#187)

Author: easy1090

.changeset/fresh-paws-check.md

@@ -0,0 +1,5 @@
+---
+'@rsdoctor/cli': patch
+---
+
+feat(cli): create rsdoctor/cli package

packages/cli/CHANGELOG.md

@@ -0,0 +1,3 @@
+# @rsdoctor/cli
+
+## 0.1.1

packages/cli/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/cli/README.md

@@ -0,0 +1,28 @@
+# Rsdoctor Cli
+
+This is the cli package of Rsdoctor, you can use the capabilities of this package to open the analysis page without building.
+
+```
+
+npx @rsdoctor/cli analyze --profile [.rsdoctor/manifest.json filepath]
+
+```
+
+## features
+
+- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
+- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
+- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
+- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
+
+## Documentation
+
+https://rsdoctor.dev/
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rsdoctor is [MIT licensed](https://github.com/web-infra-dev/rsdoctor/blob/main/LICENSE).

packages/cli/bin/rsdoctor

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const { execute } = require('../dist/index.js');
+
+execute();

packages/cli/modern.config.ts

@@ -0,0 +1,3 @@
+import { baseBuildConfig } from '../../scripts/modern.base.config';
+
+export default baseBuildConfig;

packages/cli/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@rsdoctor/cli",
+  "version": "0.1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rsdoctor",
+    "directory": "packages/cli"
+  },
+  "bin": {
+    "rsdoctor": "./bin/rsdoctor"
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "npm run start",
+    "build": "modern build",
+    "start": "modern build -w",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@types/yargs": "17.0.13",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@rsdoctor/sdk": "workspace:*",
+    "@rsdoctor/types": "workspace:*",
+    "@rsdoctor/utils": "workspace:*",
+    "axios": "^1.6.1",
+    "chalk": "^4.1.2",
+    "ora": "^5.0.1",
+    "tslib": "2.4.1",
+    "yargs": "17.6.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  }
+}

packages/cli/src/commands/analyze.ts

@@ -0,0 +1,103 @@
+import { Manifest } from '@rsdoctor/utils/common';
+import { Constants, Manifest as ManifestType, SDK } from '@rsdoctor/types';
+import { RsdoctorWebpackSDK } from '@rsdoctor/sdk';
+import ora from 'ora';
+import { cyan, red } from 'chalk';
+import { Command } from '../types';
+import {
+  enhanceCommand,
+  loadJSON,
+  loadShardingFileWithSpinner,
+} from '../utils';
+import { Commands } from '../constants';
+
+interface Options {
+  profile: string;
+  open?: boolean;
+  port?: number;
+  type?: SDK.ToDataType;
+}
+
+export const analyze: Command<Commands.Analyze, Options, RsdoctorWebpackSDK> =
+  enhanceCommand(({ cwd, name, bin }) => ({
+    command: Commands.Analyze,
+    description: `
+use ${name} to open "${Constants.RsdoctorOutputManifestPath}" in browser for analysis.
+
+example: ${bin} ${Commands.Analyze} --profile "${Constants.RsdoctorOutputManifestPath}"
+
+`.trim(),
+    options(yargs) {
+      yargs
+        .option('profile', {
+          type: 'string',
+          description: 'profile for Rsdoctor server',
+          demandOption: true,
+        })
+        .option('open', {
+          type: 'boolean',
+          description: 'turn off it if you need not open browser automatically',
+          default: true,
+        })
+        .option('port', {
+          type: 'number',
+          description: 'port for Rsdoctor Server',
+        })
+        .option('type', {
+          type: 'boolean',
+          description: 'if need lite bundle mode',
+        });
+    },
+    async action({ profile, open = true, port, type = SDK.ToDataType.Normal }) {
+      const spinner = ora({ prefixText: cyan(`[${name}]`) }).start(
+        `start to loading "${profile}"`,
+      );
+
+      const json =
+        await loadJSON<ManifestType.RsdoctorManifestWithShardingFiles>(
+          profile,
+          cwd,
+        );
+
+      spinner.text = `start to loading data...`;
+
+      let dataValue: ManifestType.RsdoctorManifestData;
+
+      try {
+        dataValue = await Manifest.fetchShardingFiles(
+          json.data,
+          (url: string) => loadShardingFileWithSpinner(url, cwd, spinner),
+        );
+      } catch (error) {
+        spinner.fail(red((error as Error).message));
+        throw error;
+      }
+
+      spinner.text = `start server`;
+
+      const sdk = new RsdoctorWebpackSDK({ name, root: cwd, port, type });
+
+      await sdk.bootstrap();
+
+      sdk.getStoreData = () => dataValue;
+      sdk.getManifestData = () => json;
+
+      const manifestBuffer = Buffer.from(
+        JSON.stringify({ ...json, __LOCAL__SERVER__: true }),
+      );
+
+      sdk.server.proxy(SDK.ServerAPI.API.Manifest, 'GET', () => manifestBuffer);
+
+      if (open) {
+        spinner.text = `open browser automatically`;
+
+        await sdk.server.openClientPage('homepage');
+      }
+
+      spinner.succeed(
+        `the local url: ${cyan(sdk.server.getClientUrl('homepage'))}`,
+      );
+
+      return sdk;
+    },
+  }));

packages/cli/src/commands/index.ts

@@ -0,0 +1 @@
+export * from './analyze';

packages/cli/src/constants.ts

@@ -0,0 +1,11 @@
+export enum Commands {
+  Analyze = 'analyze',
+}
+
+export const pkg: {
+  name: string;
+  version: string;
+  bin: Record<string, string>;
+} = require('../package.json');
+
+export const bin = Object.keys(pkg.bin)[0];

packages/cli/src/index.ts

@@ -0,0 +1,67 @@
+import yargs from 'yargs/yargs';
+import { hideBin } from 'yargs/helpers';
+import chalk from 'chalk';
+import { Common } from '@rsdoctor/types';
+import { analyze } from './commands';
+import { Command, CommandContext, GetCommandArgumentsType } from './types';
+import { Commands, pkg, bin } from './constants';
+
+export async function execute<
+  T extends GetCommandArgumentsType<typeof analyze>,
+>(
+  command: Commands.Analyze | `${Commands.Analyze}`,
+  options: T['options'],
+): Promise<T['result']>;
+export async function execute(): Promise<void>;
+export async function execute(
+  command?: `${Commands}` | Commands,
+  options?: Common.PlainObject,
+): Promise<unknown> {
+  const cwd = process.cwd();
+  const { name, version } = pkg;
+
+  const ctx: CommandContext = { bin, cwd, name };
+
+  if (command === Commands.Analyze) {
+    const { action } = analyze(ctx);
+
+    return action(
+      options as GetCommandArgumentsType<typeof analyze>['options'],
+    );
+  }
+
+  const argv = hideBin(process.argv);
+  const args = yargs(argv).usage(`${bin} <command> [options]`);
+
+  args.version(version);
+
+  const commands: Command<string>[] = [analyze];
+
+  commands.forEach((cmd) => {
+    const { command, description, options, action } = cmd(ctx);
+
+    args.command(
+      command,
+      description,
+      (yargs) => {
+        return options(yargs.usage(`${bin} ${command} [options]`));
+      },
+      async (args) => {
+        try {
+          await action(args);
+        } catch (error) {
+          const { message, stack } = error as Error;
+          console.log('');
+          console.error(chalk.red(stack || message));
+          process.exit(1);
+        }
+      },
+    );
+  });
+
+  if (!argv.length) {
+    args.showHelp();
+  }
+
+  await args.parse();
+}

packages/cli/src/types.ts

@@ -0,0 +1,31 @@
+import { Common } from '@rsdoctor/types';
+import { Argv } from 'yargs';
+
+export interface Command<CMD, Options = Common.PlainObject, Result = unknown> {
+  (ctx: CommandContext): CommandOutput<CMD, Options, Result>;
+}
+
+export interface CommandContext {
+  name: string;
+  bin: string;
+  cwd: string;
+}
+
+export interface CommandOutput<CMD, Options, Result> {
+  command: CMD;
+  description: string;
+  options(yargs: Argv<Options>): void;
+  action(args: Options): Result | Promise<Result>;
+}
+
+export type GetCommandArgumentsType<T> = T extends Command<
+  infer C,
+  infer Options,
+  infer Result
+>
+  ? {
+      command: C;
+      options: Options;
+      result: Result;
+    }
+  : unknown;