Update install-run.ts copyAndTrim comment and add verbose comment to Utilities npmrc delete and copy log messages

darsi-an · iclanton · web-flow · commit a403ec16185e · 2020-02-01T23:42:28.000-05:00
Co-Authored-By: Ian Clanton-Thuon &lt;iclanton@users.noreply.github.com&gt;
diff --git a/apps/rush-lib/src/scripts/install-run.ts b/apps/rush-lib/src/scripts/install-run.ts
@@ -102,7 +102,7 @@ function _copyAndTrimNpmrcFile(sourceNpmrcPath: string, targetNpmrcPath: string)
  * syncNpmrc() copies the .npmrc file to the target folder, and also trims unusable lines from the .npmrc file.
  * If the source .npmrc file not exist, then syncNpmrc() will delete an .npmrc that is found in the target folder.
  *
- * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH _syncNpmrc() FROM scripts/install-run.ts
+ * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH Utilities._syncNpmrc()
  */
 function _syncNpmrc(sourceNpmrcFolder: string, targetNpmrcFolder: string, useNpmrcPublish?: boolean): void {
   const sourceNpmrcPath: string = path.join(sourceNpmrcFolder, !useNpmrcPublish ? '.npmrc' : '.npmrc-publish');
diff --git a/apps/rush-lib/src/utilities/Utilities.ts b/apps/rush-lib/src/utilities/Utilities.ts
@@ -515,7 +515,7 @@ export class Utilities {
    * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH _copyNpmrcFile() FROM scripts/install-run.ts
    */
   public static copyAndTrimNpmrcFile(sourceNpmrcPath: string, targetNpmrcPath: string): void {
-    console.log(`Copying ${sourceNpmrcPath} --> ${targetNpmrcPath}`);
+    console.log(`Copying ${sourceNpmrcPath} --> ${targetNpmrcPath}`); // Verbose
     let npmrcFileLines: string[] = FileSystem.readFile(sourceNpmrcPath).split('\n');
     npmrcFileLines = npmrcFileLines.map((line) => (line || '').trim());
     const resultLines: string[] = [];
@@ -562,7 +562,7 @@ export class Utilities {
         Utilities.copyAndTrimNpmrcFile(sourceNpmrcPath, targetNpmrcPath);
       } else if (FileSystem.exists(targetNpmrcPath)) {
         // If the source .npmrc doesn't exist and there is one in the target, delete the one in the target
-        console.log(`Deleting ${targetNpmrcPath}`);
+        console.log(`Deleting ${targetNpmrcPath}`); // Verbose
         FileSystem.deleteFile(targetNpmrcPath);
       }
     } catch (e) {

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ function _copyAndTrimNpmrcFile(sourceNpmrcPath: string, targetNpmrcPath: string)`
`102`	`102`	`* syncNpmrc() copies the .npmrc file to the target folder, and also trims unusable lines from the .npmrc file.`
`103`	`103`	`* If the source .npmrc file not exist, then syncNpmrc() will delete an .npmrc that is found in the target folder.`
`104`	`104`	`*`
`105`		`- * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH _syncNpmrc() FROM scripts/install-run.ts`
	`105`	`+ * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH Utilities._syncNpmrc()`
`106`	`106`	`*/`
`107`	`107`	`function _syncNpmrc(sourceNpmrcFolder: string, targetNpmrcFolder: string, useNpmrcPublish?: boolean): void {`
`108`	`108`	`const sourceNpmrcPath: string = path.join(sourceNpmrcFolder, !useNpmrcPublish ? '.npmrc' : '.npmrc-publish');`