refactor(dev-infra): several code style and typo fixes (angular#39135)

This commit addresses comments from [my review][1] on PR angular#38656 (which
was merged without comments addressed). The changes are mostly related
to code style and typos.

[1]: angular#38656 (review)

PR Close angular#39135

Author: gkalpak

.ng-dev/release.ts

@@ -26,7 +26,7 @@ export const release: ReleaseConfig = {
   ],
   // TODO: Implement release package building here.
   buildPackages: async () => [],
-  // TODO: This can be removed once there is a org-wide tool for changelog generation.
+  // TODO: This can be removed once there is an org-wide tool for changelog generation.
   generateReleaseNotesForHead: async () => {
     exec('yarn -s gulp changelog', {cwd: join(__dirname, '../')});
   },

dev-infra/pr/merge/defaults/labels.ts

@@ -41,8 +41,8 @@ export async function getDefaultTargetLabelConfiguration(
         // allow merging of PRs with `target: major`.
         if (!next.isMajor) {
           throw new InvalidTargetLabelError(
-              `Unable to merge pull request. The "${nextBranchName}" branch will be ` +
-              `released as a minor version.`);
+              `Unable to merge pull request. The "${nextBranchName}" branch will be released as ` +
+              'a minor version.');
         }
         return [nextBranchName];
       },

dev-infra/pr/merge/defaults/lts-branch.ts

@@ -30,8 +30,8 @@ export async function assertActiveLtsBranch(
   const ltsNpmTag = getLtsNpmDistTagOfMajor(version.major);
   const ltsVersion = semver.parse(distTags[ltsNpmTag]);
 
-  // Ensure that there is a LTS version tagged for the given version-branch major. e.g.
-  // if the version branch is `9.2.x` then we want to make sure that there is a LTS
+  // Ensure that there is an LTS version tagged for the given version-branch major. e.g.
+  // if the version branch is `9.2.x` then we want to make sure that there is an LTS
   // version tagged in NPM for `v9`, following the `v{major}-lts` tag convention.
   if (ltsVersion === null) {
     throw new InvalidTargetBranchError(`No LTS version tagged for v${version.major} in NPM.`);

dev-infra/pr/merge/index.ts

@@ -33,7 +33,7 @@ export async function mergePullRequest(
     prNumber: number, githubToken: string, projectRoot: string = getRepoBaseDir(),
     config?: MergeConfigWithRemote) {
   // Set the environment variable to skip all git commit hooks triggered by husky. We are unable to
-  // rely on `---no-verify` as some hooks still run, notably the `prepare-commit-msg` hook.
+  // rely on `--no-verify` as some hooks still run, notably the `prepare-commit-msg` hook.
   process.env['HUSKY_SKIP_HOOKS'] = '1';
 
   const api = await createPullRequestMergeTask(githubToken, projectRoot, config);

dev-infra/release/build/build.spec.ts

@@ -60,7 +60,7 @@ describe('ng-dev release build', () => {
   });
 
   it('should error if package has not been built', async () => {
-    // Set up a NPM package that is not built.
+    // Set up an NPM package that is not built.
     npmPackages.push('@angular/non-existent');
 
     spyOn(console, 'error');

dev-infra/release/publish/actions.ts

@@ -7,7 +7,7 @@
  */
 
 import {promises as fs} from 'fs';
-import * as Ora from 'ora';
+import * as ora from 'ora';
 import {join} from 'path';
 import * as semver from 'semver';
 
@@ -44,7 +44,7 @@ export interface PullRequest {
   forkBranch: string;
 }
 
-/** Constructor type for a instantiating a release action */
+/** Constructor type for instantiating a release action */
 export interface ReleaseActionConstructor<T extends ReleaseAction = ReleaseAction> {
   /** Whether the release action is currently active. */
   isActive(active: ActiveReleaseTrains): Promise<boolean>;
@@ -107,25 +107,22 @@ export abstract class ReleaseAction {
     if (state === 'failure') {
       error(
           red(`  ✘   Cannot stage release. Commit "${commitSha}" does not pass all github ` +
-              `status checks. Please make sure this commit passes all checks before re-running.`));
+              'status checks. Please make sure this commit passes all checks before re-running.'));
       error(`      Please have a look at: ${branchCommitsUrl}`);
 
       if (await promptConfirm('Do you want to ignore the Github status and proceed?')) {
         info(yellow(
-            `  ⚠   Upstream commit is failing CI checks, but status has been ` +
-            `forcibly ignored.`));
+            '  ⚠   Upstream commit is failing CI checks, but status has been forcibly ignored.'));
         return;
       }
       throw new UserAbortedReleaseActionError();
     } else if (state === 'pending') {
       error(
           red(`  ✘   Commit "${commitSha}" still has pending github statuses that ` +
-              `need to succeed before staging a release.`));
+              'need to succeed before staging a release.'));
       error(red(`      Please have a look at: ${branchCommitsUrl}`));
       if (await promptConfirm('Do you want to ignore the Github status and proceed?')) {
-        info(yellow(
-            `  ⚠   Upstream commit is pending CI, but status has been ` +
-            `forcibly ignored.`));
+        info(yellow('  ⚠   Upstream commit is pending CI, but status has been forcibly ignored.'));
         return;
       }
       throw new UserAbortedReleaseActionError();
@@ -157,9 +154,9 @@ export abstract class ReleaseAction {
    */
   protected async waitForEditsAndCreateReleaseCommit(newVersion: semver.SemVer) {
     info(yellow(
-        `  ⚠   Please review the changelog and ensure that the log contains only changes ` +
-        `that apply to the public API surface. Manual changes can be made. When done, please ` +
-        `proceed with the prompt below.`));
+        '  ⚠   Please review the changelog and ensure that the log contains only changes ' +
+        'that apply to the public API surface. Manual changes can be made. When done, please ' +
+        'proceed with the prompt below.'));
 
     if (!await promptConfirm('Do you want to proceed and commit the changes?')) {
       throw new UserAbortedReleaseActionError();
@@ -188,7 +185,7 @@ export abstract class ReleaseAction {
     const forks = result.repository.forks.nodes;
 
     if (forks.length === 0) {
-      error(red(`  ✘   Unable to find fork for currently authenticated user.`));
+      error(red('  ✘   Unable to find fork for currently authenticated user.'));
       error(red(`      Please ensure you created a fork of: ${owner}/${name}.`));
       throw new FatalReleaseActionError();
     }
@@ -304,7 +301,7 @@ export abstract class ReleaseAction {
     return new Promise((resolve, reject) => {
       debug(`Waiting for pull request #${id} to be merged.`);
 
-      const spinner = Ora().start(`Waiting for pull request #${id} to be merged.`);
+      const spinner = ora().start(`Waiting for pull request #${id} to be merged.`);
       const intervalId = setInterval(async () => {
         const prState = await getPullRequestState(this.git, id);
         if (prState === 'merged') {
@@ -451,7 +448,7 @@ export abstract class ReleaseAction {
 
     info(green(
         `  ✓   Pull request for cherry-picking the changelog into "${nextBranch}" ` +
-        `has been created.`));
+        'has been created.'));
     info(yellow(`      Please ask team members to review: ${url}.`));
     return true;
   }
@@ -490,7 +487,7 @@ export abstract class ReleaseAction {
 
     if (!await this._isCommitForVersionStaging(newVersion, versionBumpCommitSha)) {
       error(red(`  ✘   Latest commit in "${publishBranch}" branch is not a staging commit.`));
-      error(red(`      Please make sure the staging pull request has been merged.`));
+      error(red('      Please make sure the staging pull request has been merged.'));
       throw new FatalReleaseActionError();
     }
 
@@ -514,13 +511,13 @@ export abstract class ReleaseAction {
       await this._publishBuiltPackageToNpm(builtPackage, npmDistTag);
     }
 
-    info(green(`  ✓   Published all packages successfully`));
+    info(green('  ✓   Published all packages successfully'));
   }
 
   /** Publishes the given built package to NPM with the specified NPM dist tag. */
   private async _publishBuiltPackageToNpm(pkg: BuiltPackage, npmDistTag: string) {
     debug(`Starting publish of "${pkg.name}".`);
-    const spinner = Ora().start(`Publishing "${pkg.name}"`);
+    const spinner = ora().start(`Publishing "${pkg.name}"`);
 
     try {
       await runNpmPublish(pkg.outputPath, npmDistTag, this.config.publishRegistry);

dev-infra/release/publish/actions/cut-lts-patch.ts

@@ -65,14 +65,14 @@ export class CutLongTermSupportPatchAction extends ReleaseAction {
           {
             name: 'activeLtsBranch',
             type: 'list',
-            message: 'Please select a version for which you want to cut a LTS patch',
+            message: 'Please select a version for which you want to cut an LTS patch',
             choices: activeBranchChoices,
           },
           {
             name: 'inactiveLtsBranch',
             type: 'list',
             when: o => o.activeLtsBranch === null,
-            message: 'Please select an inactive LTS version for which you want to cut a LTS patch',
+            message: 'Please select an inactive LTS version for which you want to cut an LTS patch',
             choices: inactive.map(branch => this._getChoiceForLtsBranch(branch)),
           }
         ]);

dev-infra/release/publish/external-commands.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as Ora from 'ora';
+import * as ora from 'ora';
 import * as semver from 'semver';
 
 import {spawnWithDebugOutput} from '../../utils/child-process';
@@ -19,11 +19,11 @@ import {FatalReleaseActionError} from './actions-error';
  * ###############################################################
  *
  * This file contains helpers for invoking external `ng-dev` commands. A subset of actions,
- * like building release output or setting a NPM dist tag for release packages, cannot be
+ * like building release output or setting aν NPM dist tag for release packages, cannot be
  * performed directly as part of the release tool and need to be delegated to external `ng-dev`
  * commands that exist across arbitrary version branches.
  *
- * In an concrete example: Consider a new patch version is released and that a new release
+ * In a concrete example: Consider a new patch version is released and that a new release
  * package has been added to the `next` branch. The patch branch will not contain the new
  * release package, so we could not build the release output for it. To work around this, we
  * call the ng-dev build command for the patch version branch and expect it to return a list
@@ -44,7 +44,7 @@ export async function invokeSetNpmDistCommand(npmDistTag: string, version: semve
     info(green(`  ✓   Set "${npmDistTag}" NPM dist tag for all packages to v${version}.`));
   } catch (e) {
     error(e);
-    error(red(`  ✘   An error occurred while setting the NPM dist tag for ${npmDistTag}.`));
+    error(red('  ✘   An error occurred while setting the NPM dist tag for "${npmDistTag}".'));
     throw new FatalReleaseActionError();
   }
 }
@@ -54,21 +54,21 @@ export async function invokeSetNpmDistCommand(npmDistTag: string, version: semve
  * packages for the currently checked out branch.
  */
 export async function invokeReleaseBuildCommand(): Promise<BuiltPackage[]> {
-  const spinner = Ora().start('Building release output.');
+  const spinner = ora().start('Building release output.');
   try {
     // Since we expect JSON to be printed from the `ng-dev release build` command,
     // we spawn the process in silent mode. We have set up an Ora progress spinner.
     const {stdout} = await spawnWithDebugOutput(
         'yarn', ['--silent', 'ng-dev', 'release', 'build', '--json'], {mode: 'silent'});
     spinner.stop();
-    info(green(`  ✓   Built release output for all packages.`));
+    info(green('  ✓   Built release output for all packages.'));
     // The `ng-dev release build` command prints a JSON array to stdout
     // that represents the built release packages and their output paths.
     return JSON.parse(stdout.trim());
   } catch (e) {
     spinner.stop();
     error(e);
-    error(red(`  ✘   An error occurred while building the release packages.`));
+    error(red('  ✘   An error occurred while building the release packages.'));
     throw new FatalReleaseActionError();
   }
 }
@@ -83,10 +83,10 @@ export async function invokeYarnInstallCommand(projectDir: string): Promise<void
     // TODO: Consider using an Ora spinner instead to ensure minimal console output.
     await spawnWithDebugOutput(
         'yarn', ['install', '--frozen-lockfile', '--non-interactive'], {cwd: projectDir});
-    info(green(`  ✓   Installed project dependencies.`));
+    info(green('  ✓   Installed project dependencies.'));
   } catch (e) {
     error(e);
-    error(red(`  ✘   An error occurred while installing dependencies.`));
+    error(red('  ✘   An error occurred while installing dependencies.'));
     throw new FatalReleaseActionError();
   }
 }

dev-infra/release/publish/index.ts

@@ -66,8 +66,7 @@ export class ReleaseTool {
       // Only print the error message and stack if the error is not a known fatal release
       // action error (for which we print the error gracefully to the console with colors).
       if (!(e instanceof FatalReleaseActionError) && e instanceof Error) {
-        console.error(e.message);
-        console.error(e.stack);
+        console.error(e);
       }
       return CompletionState.FATAL_ERROR;
     } finally {
@@ -90,7 +89,7 @@ export class ReleaseTool {
       }
     }
 
-    info(`Please select the type of release you want to perform.`);
+    info('Please select the type of release you want to perform.');
 
     const {releaseAction} = await prompt<{releaseAction: ReleaseAction}>({
       name: 'releaseAction',
@@ -108,9 +107,7 @@ export class ReleaseTool {
    */
   private async _verifyNoUncommittedChanges(): Promise<boolean> {
     if (this._git.hasUncommittedChanges()) {
-      error(
-          red(`  ✘   There are changes which are not committed and should be ` +
-              `discarded.`));
+      error(red('  ✘   There are changes which are not committed and should be discarded.'));
       return false;
     }
     return true;
@@ -126,7 +123,7 @@ export class ReleaseTool {
         await this._git.github.repos.getBranch({...this._git.remoteParams, branch: nextBranchName});
 
     if (headSha !== data.commit.sha) {
-      error(red(`  ✘   Running release tool from an outdated local branch.`));
+      error(red('  ✘   Running release tool from an outdated local branch.'));
       error(red(`      Please make sure you are running from the "${nextBranchName}" branch.`));
       return false;
     }

dev-infra/release/publish/test/cut-lts-patch.spec.ts

@@ -13,7 +13,7 @@ import {CutLongTermSupportPatchAction} from '../actions/cut-lts-patch';
 
 import {expectStagingAndPublishWithCherryPick, fakeNpmPackageQueryRequest, getTestingMocksForReleaseAction, parse, setupReleaseActionForTesting, testTmpDir} from './test-utils';
 
-describe('cut a LTS patch action', () => {
+describe('cut an LTS patch action', () => {
   it('should be active', async () => {
     expect(await CutLongTermSupportPatchAction.isActive({
       releaseCandidate: null,

dev-infra/release/set-dist-tag/cli.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as Ora from 'ora';
+import * as ora from 'ora';
 import * as semver from 'semver';
 import {Arguments, Argv, CommandModule} from 'yargs';
 
@@ -15,7 +15,7 @@ import {getReleaseConfig} from '../config/index';
 import {setNpmTagForPackage} from '../versioning/npm-publish';
 
 
-/** Command line options for setting a NPM dist tag. */
+/** Command line options for setting an NPM dist tag. */
 export interface ReleaseSetDistTagOptions {
   tagName: string;
   targetVersion: string;
@@ -42,11 +42,11 @@ async function handler(args: Arguments<ReleaseSetDistTagOptions>) {
   const version = semver.parse(rawVersion);
 
   if (version === null) {
-    error(red(`Invalid version specified. Unable to set NPM dist tag.`));
+    error(red(`Invalid version specified (${rawVersion}). Unable to set NPM dist tag.`));
     process.exit(1);
   }
 
-  const spinner = Ora().start();
+  const spinner = ora().start();
   debug(`Setting "${tagName}" NPM dist tag for release packages to v${version}.`);
 
   for (const pkgName of npmPackages) {
@@ -69,7 +69,7 @@ async function handler(args: Arguments<ReleaseSetDistTagOptions>) {
   info(green(`      ${bold(tagName)} will now point to ${bold(`v${version}`)}.`));
 }
 
-/** CLI command module for setting a NPM dist tag. */
+/** CLI command module for setting an NPM dist tag. */
 export const ReleaseSetDistTagCommand: CommandModule<{}, ReleaseSetDistTagOptions> = {
   builder,
   handler,

dev-infra/release/set-dist-tag/set-dist-tag.spec.ts

@@ -66,7 +66,7 @@ describe('ng-dev release set-dist-tag', () => {
     await invokeCommand('latest', '10.0');
 
     expect(console.error)
-        .toHaveBeenCalledWith('Invalid version specified. Unable to set NPM dist tag.');
+        .toHaveBeenCalledWith('Invalid version specified (10.0). Unable to set NPM dist tag.');
     expect(process.exit).toHaveBeenCalledWith(1);
     expect(process.exit).toHaveBeenCalledTimes(1);
   });

dev-infra/release/versioning/README.md

@@ -1,5 +1,5 @@
 ## Versioning for the Angular organization
 
 The folder contains common tooling needed for implementing the versioning as proposed
-by [this design document](https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU/edit#heading=h.s3qlps8f4zq7).
+by [this design document](https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU).
 Primary tooling is the determination of _active_ release trains.

dev-infra/release/versioning/active-release-trains.ts

@@ -17,7 +17,7 @@ export interface ActiveReleaseTrains {
   releaseCandidate: ReleaseTrain|null;
   /** Release-train currently in the "latest" phase. */
   latest: ReleaseTrain;
-  /** Release-train in the `next` phase */
+  /** Release-train in the `next` phase. */
   next: ReleaseTrain;
 }