Merge pull request #83 from tiktok/feat-sparo-completion

[sparo] shell completion feature
tiktok · Aug 15, 2024 · 30a6efe · 30a6efe
2 parents cb2f0ea + 427acc5
commit 30a6efe
Show file tree

Hide file tree

Showing 89 changed files with 1,099 additions and 136 deletions.
diff --git a/.gitignore b/.gitignore
@@ -63,6 +63,8 @@ jspm_packages/
 .idea/
 *.iml
 
+.nvmrc
+
 # Rush temporary files
 common/deploy/
 common/temp/

diff --git a/apps/sparo-lib/src/cli/SparoCommandLine.ts b/apps/sparo-lib/src/cli/SparoCommandLine.ts
@@ -19,22 +19,25 @@ export class SparoCommandLine {
   private constructor() {}
 
   public static async launchAsync(launchOptions: ILaunchOptions): Promise<void> {
-    if (launchOptions.collectTelemetryAsync) {
-      const telemetryService: TelemetryService = await getFromContainerAsync(TelemetryService);
-      telemetryService.setCollectTelemetryFunction(launchOptions.collectTelemetryAsync);
-    }
+    const isCompletion: boolean = ['completion', '--get-yargs-completions'].includes(process.argv[2]);
+    if (!isCompletion) {
+      if (launchOptions.collectTelemetryAsync) {
+        const telemetryService: TelemetryService = await getFromContainerAsync(TelemetryService);
+        telemetryService.setCollectTelemetryFunction(launchOptions.collectTelemetryAsync);
+      }
 
-    if (GitVersionCompatibility.reportGitRequiredVersion()) {
-      process.exit(1);
-    }
-    SparoStartupBanner.logBanner({
-      callerPackageJson: launchOptions.callerPackageJson
-    });
+      if (GitVersionCompatibility.reportGitRequiredVersion()) {
+        process.exit(1);
+      }
+      SparoStartupBanner.logBanner({
+        callerPackageJson: launchOptions.callerPackageJson
+      });
 
-    if (launchOptions.additionalSkeletonFolders) {
-      const gitSparseCheckoutService: GitSparseCheckoutService =
-        await getFromContainerAsync(GitSparseCheckoutService);
-      gitSparseCheckoutService.setAdditionalSkeletonFolders(launchOptions.additionalSkeletonFolders);
+      if (launchOptions.additionalSkeletonFolders) {
+        const gitSparseCheckoutService: GitSparseCheckoutService =
+          await getFromContainerAsync(GitSparseCheckoutService);
+        gitSparseCheckoutService.setAdditionalSkeletonFolders(launchOptions.additionalSkeletonFolders);
+      }
     }
 
     const sparo: SparoCommandLine = new SparoCommandLine();
@@ -79,6 +82,6 @@ export class SparoCommandLine {
   }
 
   private _supportedCommand(commandName: string): boolean {
-    return this._commandsMap.has(commandName);
+    return this._commandsMap.has(commandName) || commandName === 'completion';
   }
 }
diff --git a/apps/sparo-lib/src/cli/commands/auto-config.ts b/apps/sparo-lib/src/cli/commands/auto-config.ts
@@ -28,6 +28,18 @@ export class AutoConfigCommand implements ICommand<IAutoConfigCommandOptions> {
         type: 'boolean',
         hidden: true,
         default: false
+      })
+      .completion('completion', false, (current, argv, done) => {
+        const longParameters: string[] = [argv.overwrite ? '' : '--overwrite'].filter(Boolean);
+        if (current.startsWith('--')) {
+          done(
+            longParameters.filter((parameter) => {
+              return parameter.startsWith(current);
+            })
+          );
+        } else {
+          done([]);
+        }
       });
   }
   public handler = async (
@@ -52,7 +64,4 @@ export class AutoConfigCommand implements ICommand<IAutoConfigCommandOptions> {
       throw e;
     }
   };
-  public getHelp(): string {
-    return '';
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/base.ts b/apps/sparo-lib/src/cli/commands/base.ts
@@ -17,5 +17,4 @@ export interface ICommand<O extends {}> {
 
   builder: (yargs: Argv<O>) => void;
   handler: (args: ArgumentsCamelCase<O>, terminalService: TerminalService) => Promise<void>;
-  getHelp: () => string;
 }
diff --git a/apps/sparo-lib/src/cli/commands/checkout.ts b/apps/sparo-lib/src/cli/commands/checkout.ts
@@ -1,5 +1,6 @@
 import * as child_process from 'child_process';
 import { inject } from 'inversify';
+import { JsonFile } from '@rushstack/node-core-library';
 import { Command } from '../../decorator';
 import { GitService } from '../../services/GitService';
 import { GitRemoteFetchConfigService } from '../../services/GitRemoteFetchConfigService';
@@ -32,7 +33,7 @@ export class CheckoutCommand implements ICommand<ICheckoutCommandOptions> {
   @inject(GitRemoteFetchConfigService) private _gitRemoteFetchConfigService!: GitRemoteFetchConfigService;
   @inject(SparoProfileService) private _sparoProfileService!: SparoProfileService;
 
-  public builder(yargs: Argv<{}>): void {
+  public builder = (yargs: Argv<{}>): void => {
     /**
      * git checkout [-q] [-f] [-m] [<branch>]
      * git checkout [-q] [-f] [-m] --detach [<branch>]
@@ -98,8 +99,114 @@ export class CheckoutCommand implements ICommand<ICheckoutCommandOptions> {
         default: [],
         description:
           'Checkout projects downstream from (and including itself and all its dependencies) project <from..>, can be used together with option --profile/--add-profile to form a union selection of the two options. The projects selectors here will never replace what have been checked out by profiles'
+      })
+      .completion('completion', false, (current, argv, done) => {
+        const isNoProfile: boolean = argv.profile.some(
+          (profile: string | boolean) => typeof profile === 'boolean' && profile === false
+        );
+        const shortParameters: string[] = [argv.b ? '' : '-b', argv.B ? '' : '-B'].filter(Boolean);
+        const longParameters: string[] = [
+          isNoProfile ? '' : '--no-profile',
+          isNoProfile ? '' : '--profile',
+          isNoProfile ? '' : '--add-profile',
+          '--to',
+          '--from'
+        ].filter(Boolean);
+
+        if (current === '-') {
+          done(shortParameters);
+        } else if (current === '--') {
+          done(longParameters);
+        } else if (current === '--profile' || current === '--add-profile') {
+          const profileNameSet: Set<string> = new Set(this._sparoProfileService.loadProfileNames());
+          for (const profile of argv.profile) {
+            if (typeof profile === 'string') {
+              profileNameSet.delete(profile);
+            }
+          }
+          for (const profile of argv.addProfile) {
+            if (typeof profile === 'string') {
+              profileNameSet.delete(profile);
+            }
+          }
+          done(Array.from(profileNameSet));
+        } else if (current === '--to' || current === '--from') {
+          let rushJson: { projects?: { packageName: string }[] } = {};
+          const root: string = this._gitService.getRepoInfo().root;
+          try {
+            rushJson = JsonFile.load(`${root}/rush.json`);
+          } catch (e) {
+            // no-catch
+          }
+          if (Array.isArray(rushJson.projects)) {
+            const packageNameSet: Set<string> = new Set<string>(
+              rushJson.projects.map((project) => project.packageName)
+            );
+            if (current === '--to') {
+              for (const packageName of argv.to) {
+                packageNameSet.delete(packageName);
+              }
+            }
+            if (current === '--from') {
+              for (const packageName of argv.from) {
+                packageNameSet.delete(packageName);
+              }
+            }
+            const packageNames: string[] = Array.from(packageNameSet).sort();
+            if (process.cwd() !== root) {
+              packageNames.unshift('.');
+            }
+            done(packageNames);
+          }
+          done([]);
+        } else if (current.startsWith('--')) {
+          done(longParameters.filter((parameter) => parameter.startsWith(current)));
+        } else {
+          const previous: string = process.argv.slice(-2)[0];
+          if (previous === '--profile' || previous === '--add-profile') {
+            const profileNameSet: Set<string> = new Set(this._sparoProfileService.loadProfileNames());
+            for (const profile of argv.profile) {
+              if (typeof profile === 'string') {
+                profileNameSet.delete(profile);
+              }
+            }
+            for (const profile of argv.addProfile) {
+              if (typeof profile === 'string') {
+                profileNameSet.delete(profile);
+              }
+            }
+            done(Array.from(profileNameSet).filter((profileName) => profileName.startsWith(current)));
+          } else if (previous === '--to' || previous === '--from') {
+            let rushJson: { projects?: { packageName: string }[] } = {};
+            const root: string = this._gitService.getRepoInfo().root;
+            try {
+              rushJson = JsonFile.load(`${root}/rush.json`);
+            } catch (e) {
+              // no-catch
+            }
+            if (Array.isArray(rushJson.projects)) {
+              const packageNameSet: Set<string> = new Set<string>(
+                rushJson.projects.map((project) => project.packageName)
+              );
+              if (previous === '--to') {
+                for (const packageName of argv.to) {
+                  packageNameSet.delete(packageName);
+                }
+              }
+              if (previous === '--from') {
+                for (const packageName of argv.from) {
+                  packageNameSet.delete(packageName);
+                }
+              }
+              const packageNames: string[] = Array.from(packageNameSet).sort();
+              done(packageNames.filter((packageName) => packageName.startsWith(current)));
+            }
+            done([]);
+          }
+          done([]);
+        }
       });
-  }
+  };
 
   public handler = async (
     args: ArgumentsCamelCase<ICheckoutCommandOptions>,
@@ -258,10 +365,6 @@ export class CheckoutCommand implements ICommand<ICheckoutCommandOptions> {
     }
   };
 
-  public getHelp(): string {
-    return '';
-  }
-
   private _ensureBranchInLocal(branch: string): boolean {
     // fetch from remote
     const remote: string = this._gitService.getBranchRemote(branch);

diff --git a/apps/sparo-lib/src/cli/commands/ci-checkout.ts b/apps/sparo-lib/src/cli/commands/ci-checkout.ts
@@ -44,7 +44,4 @@ export class CICheckoutCommand implements ICommand<ICICheckoutCommandOptions> {
       from
     });
   };
-  public getHelp(): string {
-    return 'sparse help';
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/ci-clone.ts b/apps/sparo-lib/src/cli/commands/ci-clone.ts
@@ -71,8 +71,4 @@ export class CICloneCommand implements ICommand<ICloneCommandOptions> {
 
     terminal.writeLine(`Remember to run "cd ${directory}"`);
   };
-
-  public getHelp(): string {
-    return `clone help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/clone.ts b/apps/sparo-lib/src/cli/commands/clone.ts
@@ -22,7 +22,7 @@ export interface ICloneCommandOptions {
 @Command()
 export class CloneCommand implements ICommand<ICloneCommandOptions> {
   public cmd: string = 'clone <repository> [directory]';
-  public description: string = '';
+  public description: string = 'Clone a repository into a new directory';
 
   @inject(GitService) private _gitService!: GitService;
   @inject(GitCloneService) private _gitCloneService!: GitCloneService;
@@ -61,6 +61,17 @@ export class CloneCommand implements ICommand<ICloneCommandOptions> {
           return 'You must specify a repository to clone.';
         }
         return true;
+      })
+      .completion('completion', false, (current, argv, done) => {
+        const longParameters: string[] = ['--profile', '--branch', '--full', '--skip-git-config'];
+
+        if (current === '--') {
+          done(longParameters);
+        } else if (current.startsWith('--')) {
+          done(longParameters.filter((parameter) => parameter.startsWith(current)));
+        } else {
+          done([]);
+        }
       });
   }
 
@@ -154,8 +165,4 @@ export class CloneCommand implements ICommand<ICloneCommandOptions> {
       terminal.writeLine('   ' + Colorize.cyan('sparo init-profile --profile <profile_name>'));
     }
   };
-
-  public getHelp(): string {
-    return `clone help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/fetch.ts b/apps/sparo-lib/src/cli/commands/fetch.ts
@@ -22,7 +22,7 @@ export class FetchCommand implements ICommand<IFetchCommandOptions> {
   @inject(GitService) private _gitService!: GitService;
   @inject(GitRemoteFetchConfigService) private _gitRemoteFetchConfigService!: GitRemoteFetchConfigService;
 
-  public builder(yargs: Argv<{}>): void {
+  public builder = (yargs: Argv<{}>): void => {
     /**
      * sparo fetch <remote> <branch> [--all]
      */
@@ -31,8 +31,31 @@ export class FetchCommand implements ICommand<IFetchCommandOptions> {
       .positional('branch', { type: 'string' })
       .string('remote')
       .string('branch')
-      .boolean('all');
-  }
+      .boolean('all')
+      .completion('completion', false, (current, argv, done) => {
+        const longParameters: string[] = [argv.all ? '' : '--all', argv.tags ? '' : '--tags'].filter(Boolean);
+        if (current === 'fetch') {
+          done(['origin']);
+        } else if (current === 'origin') {
+          const branchNames: string[] = this._gitRemoteFetchConfigService.getBranchNamesFromRemote('origin');
+          branchNames.unshift('HEAD');
+          done(branchNames);
+        } else if (current === '--') {
+          done(longParameters);
+        } else if (current.startsWith('--')) {
+          done(longParameters.filter((parameter) => parameter.startsWith(current)));
+        } else {
+          const previous: string = process.argv.slice(-2)[0];
+          if (previous === 'origin') {
+            const branchNames: string[] =
+              this._gitRemoteFetchConfigService.getBranchNamesFromRemote('origin');
+            branchNames.unshift('HEAD');
+            done(branchNames.filter((name) => name.startsWith(current)));
+          }
+          done([]);
+        }
+      });
+  };
 
   public handler = async (
     args: ArgumentsCamelCase<IFetchCommandOptions>,
@@ -75,8 +98,4 @@ export class FetchCommand implements ICommand<IFetchCommandOptions> {
 
     restoreSingleBranchCallback?.();
   };
-
-  public getHelp(): string {
-    return `fetch help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/git-checkout.ts b/apps/sparo-lib/src/cli/commands/git-checkout.ts
@@ -27,8 +27,4 @@ export class GitCheckoutCommand implements ICommand<{}> {
     terminal.writeDebugLine(`proxy args in git-checkout command: ${JSON.stringify(rawArgs)}`);
     gitService.executeGitCommand({ args: rawArgs });
   };
-
-  public getHelp(): string {
-    return `git-checkout help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/git-clone.ts b/apps/sparo-lib/src/cli/commands/git-clone.ts
@@ -27,8 +27,4 @@ export class GitCloneCommand implements ICommand<{}> {
     terminal.writeDebugLine(`proxy args in git-clone command: ${JSON.stringify(rawArgs)}`);
     gitService.executeGitCommand({ args: rawArgs });
   };
-
-  public getHelp(): string {
-    return `git-clone help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/git-fetch.ts b/apps/sparo-lib/src/cli/commands/git-fetch.ts
@@ -28,8 +28,4 @@ export class GitFetchCommand implements ICommand<{}> {
     terminal.writeDebugLine(`proxy args in git-fetch command: ${JSON.stringify(rawArgs)}`);
     gitService.executeGitCommand({ args: rawArgs });
   };
-
-  public getHelp(): string {
-    return `git-fetch help`;
-  }
 }
diff --git a/apps/sparo-lib/src/cli/commands/git-pull.ts b/apps/sparo-lib/src/cli/commands/git-pull.ts
@@ -27,7 +27,4 @@ export class GitPullCommand implements ICommand<{}> {
     terminal.writeDebugLine(`proxy args in git-pull command: ${JSON.stringify(rawArgs)}`);
     gitService.executeGitCommand({ args: rawArgs });
   };
-  public getHelp(): string {
-    return `git-pull help`;
-  }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -63,6 +63,8 @@ jspm_packages/ @@
     .idea/
     *.iml
+    .nvmrc
     # Rush temporary files
     common/deploy/
     common/temp/
@@ Expand Down @@