Move .rush/package-deps.<command>.json files to .rush/temp/package-deps_<command>.json

iclanton · iclanton · commit c53b1e7c17c6 · 2019-09-09T21:28:52.000-07:00
diff --git a/apps/rush-lib/assets/rush-init/[dot]gitignore b/apps/rush-lib/assets/rush-init/[dot]gitignore
@@ -60,4 +60,4 @@ temp
 
 # Rush files
 common/temp/**
-package-deps.json
+.rush/temp/**
diff --git a/apps/rush-lib/src/api/RushConfigurationProject.ts b/apps/rush-lib/src/api/RushConfigurationProject.ts
@@ -13,6 +13,7 @@ import {
 import { RushConfiguration } from '../api/RushConfiguration';
 import { VersionPolicy, LockStepVersionPolicy } from './VersionPolicy';
 import { PackageJsonEditor } from './PackageJsonEditor';
+import { RushConstants } from '../logic/RushConstants';
 
 /**
  * This represents the JSON data object for a project entry in the rush.json configuration file.
@@ -36,6 +37,7 @@ export class RushConfigurationProject {
   private _packageName: string;
   private _projectFolder: string;
   private _projectRelativeFolder: string;
+  private _projectRushTempFolder: string;
   private _reviewCategory: string;
   private _packageJson: IPackageJson;
   private _packageJsonEditor: PackageJsonEditor;
@@ -50,9 +52,11 @@ export class RushConfigurationProject {
   private readonly _rushConfiguration: RushConfiguration;
 
   /** @internal */
-  constructor(projectJson: IRushConfigurationProjectJson,
-              rushConfiguration: RushConfiguration,
-              tempProjectName: string) {
+  constructor(
+    projectJson: IRushConfigurationProjectJson,
+    rushConfiguration: RushConfiguration,
+    tempProjectName: string
+  ) {
     this._rushConfiguration = rushConfiguration;
     this._packageName = projectJson.packageName;
     this._projectRelativeFolder = projectJson.projectFolder;
@@ -76,6 +80,12 @@ export class RushConfigurationProject {
       throw new Error(`Project folder not found: ${projectJson.projectFolder}`);
     }
 
+    this._projectRushTempFolder = path.join(
+      this._projectFolder,
+      RushConstants.projectRushFolderName,
+      RushConstants.rushTempFolderName
+    );
+
     // Are we using a package review file?
     if (rushConfiguration.approvedPackagesPolicy.enabled) {
       // If so, then every project needs to have a reviewCategory that was defined
@@ -148,6 +158,15 @@ export class RushConfigurationProject {
     return this._projectRelativeFolder;
   }
 
+  /**
+   * The project-specific Rush temp folder. This folder is used to store Rush-specific temporary files.
+   *
+   * Example: `C:\MyRepo\libraries\my-project\.rush\temp`
+   */
+  public get projectRushTempFolder(): string {
+    return this._projectRushTempFolder;
+  }
+
   /**
    * The review category name, or undefined if no category was assigned.
    * This name must be one of the valid choices listed in RushConfiguration.reviewCategories.
diff --git a/apps/rush-lib/src/cli/RushCommandLineParser.ts b/apps/rush-lib/src/cli/RushCommandLineParser.ts
@@ -207,7 +207,7 @@ export class RushCommandLineParser extends CommandLineParser {
           + ' source files that are tracked by Git and whose path is under the project folder. (For more details'
           + ' about this algorithm, see the documentation for the "package-deps-hash" NPM package.) The incremental'
           + ' build state is tracked in a folder called ".rush" which should NOT be added to Git. The build command is'
-          + ' tracked by the "arguments" field in the "package-deps.build.json" file contained therein; a full'
+          + ' tracked by the "arguments" field in the "package-deps_build.json" file contained therein; a full'
           + ' rebuild is forced whenever the command has changed (e.g. "--production" or not).',
         parser: this,
         commandLineConfiguration: commandLineConfiguration,
diff --git a/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap
@@ -107,7 +107,7 @@ whose path is under the project folder. (For more details about this
 algorithm, see the documentation for the \\"package-deps-hash\\" NPM package.) 
 The incremental build state is tracked in a folder called \\".rush\\" which 
 should NOT be added to Git. The build command is tracked by the \\"arguments\\" 
-field in the \\"package-deps.build.json\\" file contained therein; a full rebuild 
+field in the \\"package-deps_build.json\\" file contained therein; a full rebuild 
 is forced whenever the command has changed (e.g. \\"--production\\" or not).
 
 Optional arguments:
diff --git a/apps/rush-lib/src/logic/PackageChangeAnalyzer.ts b/apps/rush-lib/src/logic/PackageChangeAnalyzer.ts
@@ -72,7 +72,7 @@ export class PackageChangeAnalyzer {
         const excludes: string[] = commandLineConfiguration.commands.reduce(
           (filenames: string[], command: CommandJson) => {
             if (command.commandKind === 'bulk') {
-              filenames.push(`package-deps.${command.name}.json`);
+              filenames.push(`package-deps_${command.name}.json`);
             }
 
             return filenames;
@@ -116,10 +116,10 @@ export class PackageChangeAnalyzer {
      *
      * Temporarily revert below code in favor of replacing this solution with something more
      * flexible. Idea is essentially that we should have gulp-core-build (or other build tool)
-     * create the package-deps.json. The build tool would default to using the 'simple'
+     * create the package-deps_<command>.json. The build tool would default to using the 'simple'
      * algorithm (e.g. only files that are in a project folder are associated with the project), however it would
      * also provide a hook which would allow certain tasks to modify the package-deps-hash before being written.
-     * At the end of the build, a we would create a package-deps.json file like so:
+     * At the end of the build, a we would create a package-deps_<command>.json file like so:
      *
      *  {
      *    commandLine: ["--production"],
@@ -141,7 +141,7 @@ export class PackageChangeAnalyzer {
      *   Notes:
      *   * We need to store the command line arguments, which is currently done by rush instead of GCB
      *   * We need to store the hash/text of the a file which describes the state of the node_modules folder
-     *   * The package-deps.json should be a complete list of dependencies, and it should be extremely cheap
+     *   * The package-deps_<command>.json should be a complete list of dependencies, and it should be extremely cheap
      *       to validate/check the file (even if creating it is more computationally costly).
      */
 
@@ -157,11 +157,10 @@ export class PackageChangeAnalyzer {
     const variant: string | undefined = this._rushConfiguration.currentInstalledVariant;
 
     // Add the shrinkwrap file to every project's dependencies
-
-    const shrinkwrapFile: string =
-      path.relative(this._rushConfiguration.rushJsonFolder,
-        this._rushConfiguration.getCommittedShrinkwrapFilename(variant))
-        .replace(/\\/g, '/');
+    const shrinkwrapFile: string = path.relative(
+      this._rushConfiguration.rushJsonFolder,
+      this._rushConfiguration.getCommittedShrinkwrapFilename(variant)
+    ).replace(/\\/g, '/');
 
     for (const project of this._rushConfiguration.projects) {
       const shrinkwrapHash: string | undefined = noProjectHashes[shrinkwrapFile];
diff --git a/apps/rush-lib/src/logic/RushConstants.ts b/apps/rush-lib/src/logic/RushConstants.ts
@@ -45,7 +45,8 @@ export namespace RushConstants {
   export const rushTempNpmScope: string = '@rush-temp';
 
   /**
-   * The folder name ("temp") under the common folder where temporary files will be stored.
+   * The folder name ("temp") under the common folder, or under the .rush folder in each project's directory where
+   * temporary files will be stored.
    * Example: `C:\MyRepo\common\temp`
    */
   export const rushTempFolderName: string = 'temp';
@@ -114,10 +115,10 @@ export namespace RushConstants {
   export const commonVersionsFilename: string = 'common-versions.json';
 
   /**
-   * The name of the folder where package-deps files are stored, which are used
-   * by commands to determine if a particular project needs to be rebuilt.
+   * The name of the per-project folder where project-specific Rush files are stored. For example,
+   * the package-deps files, which are used by commands to determine if a particular project needs to be rebuilt.
    */
-  export const packageDepsFolderName: string = '.rush';
+  export const projectRushFolderName: string = '.rush';
 
   /**
    * Custom command line configuration file, which is used by rush for implementing
diff --git a/apps/rush-lib/src/logic/taskRunner/ProjectTask.ts b/apps/rush-lib/src/logic/taskRunner/ProjectTask.ts
@@ -9,7 +9,6 @@ import { IPackageDeps } from '@microsoft/package-deps-hash';
 
 import { RushConfiguration } from '../../api/RushConfiguration';
 import { RushConfigurationProject } from '../../api/RushConfigurationProject';
-import { RushConstants } from '../../logic/RushConstants';
 import { Utilities } from '../../utilities/Utilities';
 import { TaskStatus } from './TaskStatus';
 import { TaskError } from './TaskError';
@@ -94,10 +93,9 @@ export class ProjectTask implements ITaskDefinition {
 
       writer.writeLine(`>>> ${this.name}`);
 
-      const packageDepsFilename: string = `package-deps.${this._commandToRun}.json`;
+      const packageDepsFilename: string = `package-deps_${this._commandToRun}.json`;
       const currentDepsPath: string = path.join(
-        this._rushProject.projectFolder,
-        RushConstants.packageDepsFolderName,
+        this._rushProject.projectRushTempFolder,
         packageDepsFilename
       );
 
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
@@ -315,6 +315,7 @@ export class RushConfigurationProject {
     readonly packageName: string;
     readonly projectFolder: string;
     readonly projectRelativeFolder: string;
+    readonly projectRushTempFolder: string;
     readonly reviewCategory: string;
     readonly shouldPublish: boolean;
     readonly skipRushCheck: boolean;
