Merge pull request microsoft#1815 from iclanton/ianc/fix-spelling

[rush] Fix some spelling mistakes in rush-lib.

Author: iclanton

apps/rush-lib/src/api/ChangeManager.ts

@@ -4,7 +4,7 @@ import { ChangeFile } from './ChangeFile';
 import { IChangeFile } from './ChangeManagement';
 
 /**
- * A class that helps with programatically interacting with Rush's change files.
+ * A class that helps with programmatically interacting with Rush's change files.
  * @public
  */
 export class ChangeManager {

apps/rush-lib/src/api/Changelog.ts

@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 /**
- * Interface respresenting a changelog json object for a package used to represent the parsed
+ * Interface representing a changelog json object for a package used to represent the parsed
  * content of CHANGELOG.json
  */
 export interface IChangelog {
@@ -37,7 +37,7 @@ export interface IChangeLogEntry {
   date: string | undefined;
 
   /**
-   * Comments for the entry, where key respresents the ChangeType string (Example: major)
+   * Comments for the entry, where key represents the ChangeType string (Example: major)
    */
   comments: {
     /** Describes changes which cause a patch-level SemVer bump */

apps/rush-lib/src/api/RushConfiguration.ts

@@ -111,7 +111,7 @@ export type PnpmStoreOptions = 'local' | 'global';
  */
 export interface IPackageManagerOptionsJsonBase {
   /**
-   * Enviroment variables for the package manager
+   * Environment variables for the package manager
    */
   environmentVariables?: IConfigurationEnvironment
 }
@@ -249,7 +249,7 @@ export interface ICurrentVariantJson {
  */
 export abstract class PackageManagerOptionsConfigurationBase implements IPackageManagerOptionsJsonBase {
   /**
-   * Enviroment variables for the package manager
+   * Environment variables for the package manager
    */
   public readonly environmentVariables?: IConfigurationEnvironment
 

apps/rush-lib/src/cli/RushCommandLineParser.ts

@@ -188,7 +188,7 @@ export class RushCommandLineParser extends CommandLineParser {
       commandLineConfiguration = CommandLineConfiguration.loadFromFileOrDefault(commandLineConfigFile);
     }
 
-    // Build actions from the command line configuration supercede default build actions.
+    // Build actions from the command line configuration supersede default build actions.
     this._addCommandLineConfigActions(commandLineConfiguration);
     this._addDefaultBuildActions(commandLineConfiguration);
     this._validateCommandLineConfigParameterAssociations(commandLineConfiguration);

apps/rush-lib/src/cli/actions/BaseInstallAction.ts

@@ -104,7 +104,7 @@ export abstract class BaseInstallAction extends BaseRushAction {
       }
     }
 
-    // Because the 'defautltValue' option on the _maxInstallAttempts parameter is set,
+    // Because the 'defaultValue' option on the _maxInstallAttempts parameter is set,
     // it is safe to assume that the value is not null
     if (this._maxInstallAttempts.value! < 1) {
       throw new Error(`The value of "${this._maxInstallAttempts.longName}" must be positive and nonzero.`);

apps/rush-lib/src/cli/actions/InstallAction.ts

@@ -35,7 +35,7 @@ export class InstallAction extends BaseInstallAction {
       networkConcurrency: this._networkConcurrencyParameter.value,
       collectLogFile: this._debugPackageManagerParameter.value!,
       variant: this._variant.value,
-      // Because the 'defautltValue' option on the _maxInstallAttempts parameter is set,
+      // Because the 'defaultValue' option on the _maxInstallAttempts parameter is set,
       // it is safe to assume that the value is not null
       maxInstallAttempts: this._maxInstallAttempts.value!
     };

apps/rush-lib/src/cli/actions/ScanAction.ts

@@ -40,19 +40,19 @@ export class ScanAction extends BaseConfiglessRushAction {
     }
 
     const requireRegExps: RegExp[] = [
-      // Example: require('someting')
+      // Example: require('something')
       /\brequire\s*\(\s*[']([^']+\s*)[']\)/,
       /\brequire\s*\(\s*["]([^"]+)["]\s*\)/,
 
-      // Example: require.ensure('someting')
+      // Example: require.ensure('something')
       /\brequire.ensure\s*\(\s*[']([^']+\s*)[']\)/,
       /\brequire.ensure\s*\(\s*["]([^"]+)["]\s*\)/,
 
-      // Example: require.resolve('someting')
+      // Example: require.resolve('something')
       /\brequire.resolve\s*\(\s*[']([^']+\s*)[']\)/,
       /\brequire.resolve\s*\(\s*["]([^"]+)["]\s*\)/,
 
-      // Example: System.import('someting')
+      // Example: System.import('something')
       /\bSystem.import\s*\(\s*[']([^']+\s*)[']\)/,
       /\bSystem.import\s*\(\s*["]([^"]+)["]\s*\)/,
 

apps/rush-lib/src/cli/actions/UpdateAction.ts

@@ -63,7 +63,7 @@ export class UpdateAction extends BaseInstallAction {
       networkConcurrency: this._networkConcurrencyParameter.value,
       collectLogFile: this._debugPackageManagerParameter.value!,
       variant: this._variant.value,
-      // Because the 'defautltValue' option on the _maxInstallAttempts parameter is set,
+      // Because the 'defaultValue' option on the _maxInstallAttempts parameter is set,
       // it is safe to assume that the value is not null
       maxInstallAttempts: this._maxInstallAttempts.value!
     };

apps/rush-lib/src/logic/InstallManager.ts

@@ -1372,12 +1372,12 @@ export class InstallManager {
     const pathToDeleteWithoutStar: string = path.join(this._rushConfiguration.commonTempFolder,
       'node_modules', RushConstants.rushTempNpmScope);
     // Glob can't handle Windows paths
-    const normalizedpathToDeleteWithoutStar: string = Text.replaceAll(pathToDeleteWithoutStar, '\\', '/');
+    const normalizedPathToDeleteWithoutStar: string = Text.replaceAll(pathToDeleteWithoutStar, '\\', '/');
 
     let anyChanges: boolean = false;
 
     // Example: "C:/MyRepo/common/temp/node_modules/@rush-temp/*/package.json"
-    for (const packageJsonPath of glob.sync(globEscape(normalizedpathToDeleteWithoutStar) + '/*/package.json')) {
+    for (const packageJsonPath of glob.sync(globEscape(normalizedPathToDeleteWithoutStar) + '/*/package.json')) {
       // Example: "C:/MyRepo/common/temp/node_modules/@rush-temp/example/package.json"
       const packageJsonObject: IRushTempPackageJson = JsonFile.load(packageJsonPath);
 

apps/rush-lib/src/logic/PublishUtilities.ts

@@ -407,12 +407,12 @@ export class PublishUtilities {
             prereleaseToken.isPartialPrerelease &&
             depChange.changeType! < ChangeType.hotfix
           ) {
-            // FOr partial prereleases, do not version bump dependecies with the `prereleaseToken`
-            // value unless an actual change (hotfix, patch, minor, major) has occured
+            // For partial prereleases, do not version bump dependencies with the `prereleaseToken`
+            // value unless an actual change (hotfix, patch, minor, major) has occurred
             return;
           } else if (depChange && prereleaseToken && prereleaseToken.hasValue) {
             // TODO: treat prerelease version the same as non-prerelease version.
-            // For prelease, the newVersion needs to be appended with prerelease name.
+            // For prerelease, the newVersion needs to be appended with prerelease name.
             // And dependency should specify the specific prerelease version.
             dependencies[depName] = PublishUtilities._getChangeInfoNewVersion(depChange, prereleaseToken);
           } else if (depChange && depChange.changeType! >= ChangeType.hotfix) {

apps/rush-lib/src/logic/pnpm/PnpmLinkManager.ts

@@ -150,7 +150,7 @@ export class PnpmLinkManager extends BaseLinkManager {
     // creates for the installed version of each .TGZ package, all we need to do
     // is re-use that symlink in order to get linked to whatever PNPM thought was
     // appropriate. This folder is usually something like:
-    // C:\{uri-encoed-path-to-tgz}\node_modules\{package-name}
+    // C:\{uri-encoded-path-to-tgz}\node_modules\{package-name}
 
     // e.g.:
     //   file:projects/bentleyjs-core.tgz

apps/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts

@@ -311,7 +311,7 @@ export class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
     let value: string | undefined = BaseShrinkwrapFile.tryGetValue(this._shrinkwrapJson.dependencies, dependencyName);
     if (value) {
 
-      // Getting the top level depenedency version from a PNPM lockfile version 5.1
+      // Getting the top level dependency version from a PNPM lockfile version 5.1
       // --------------------------------------------------------------------------
       //
       // 1) Top-level tarball dependency entries in pnpm-lock.yaml look like:

apps/rush-lib/src/logic/versionMismatch/VersionMismatchFinder.ts

@@ -175,11 +175,11 @@ export class VersionMismatchFinder {
         };
         mismatchDependencyVersionArray.push(mismatchDependencyVersion);
       });
-      const mismatchDepency: IMismatchDependency = {
+      const mismatchDependency: IMismatchDependency = {
           dependencyName: dependency,
           versions: mismatchDependencyVersionArray
       };
-      mismatchDependencies.push(mismatchDepency);
+      mismatchDependencies.push(mismatchDependency);
     });
 
     const output: IMismatchDependencies = {

apps/rush-lib/src/schemas/rush.schema.json

@@ -6,7 +6,7 @@
 
   "definitions": {
     "environmentVariables": {
-      "description": "Enviroment variables for the package manager",
+      "description": "Environment variables for the package manager",
       "type": "object",
       "additionalProperties": {
         "type": "object",
@@ -73,7 +73,7 @@
       "type": "boolean"
     },
     "npmOptions": {
-      "description": "Options that are only used when the NPM pacakge manager is selected.",
+      "description": "Options that are only used when the NPM package manager is selected.",
       "type": "object",
       "properties": {
         "environmentVariables": {

common/changes/@microsoft/rush/ianc-fix-spelling_2020-04-06-00-43.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "[email protected]"
+}