Merge pull request #4259 from D4N14L/user/danade/MorePackageExtractor…

…Patterns

[rush] Surface `patternsToInclude` and `patternsToExclude` on the deploy.json configuration

README.md

@@ -156,6 +156,10 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/build-tests/localization-plugin-test-01](./build-tests/localization-plugin-test-01/) | Building this project exercises @microsoft/localization-plugin. This tests that the plugin works correctly without any localized resources. |
 | [/build-tests/localization-plugin-test-02](./build-tests/localization-plugin-test-02/) | Building this project exercises @microsoft/localization-plugin. This tests that the loader works correctly with the exportAsDefault option unset. |
 | [/build-tests/localization-plugin-test-03](./build-tests/localization-plugin-test-03/) | Building this project exercises @microsoft/localization-plugin. This tests that the plugin works correctly with the exportAsDefault option set to true. |
+| [/build-tests/package-extractor-test-01](./build-tests/package-extractor-test-01/) | This project is used by tests in the @rushstack/package-extractor package. |
+| [/build-tests/package-extractor-test-02](./build-tests/package-extractor-test-02/) | This project is used by tests in the @rushstack/package-extractor package. |
+| [/build-tests/package-extractor-test-03](./build-tests/package-extractor-test-03/) | This project is used by tests in the @rushstack/package-extractor package. |
+| [/build-tests/package-extractor-test-04](./build-tests/package-extractor-test-04/) | This project is used by tests in the @rushstack/package-extractor package. |
 | [/build-tests/rush-amazon-s3-build-cache-plugin-integration-test](./build-tests/rush-amazon-s3-build-cache-plugin-integration-test/) | Tests connecting to an amazon S3 endpoint |
 | [/build-tests/rush-lib-declaration-paths-test](./build-tests/rush-lib-declaration-paths-test/) | This project ensures all of the paths in rush-lib/lib/... have imports that resolve correctly. If this project builds, all `lib/**/*.d.ts` files in the `@microsoft/rush-lib` package are valid. |
 | [/build-tests/rush-project-change-analyzer-test](./build-tests/rush-project-change-analyzer-test/) | This is an example project that uses rush-lib's ProjectChangeAnalyzer to  |

build-tests/package-extractor-test-01/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "package-extractor-test-01",
+  "description": "This project is used by tests in the @rushstack/package-extractor package.",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "_phase:build": ""
+  },
+  "dependencies": {
+    "package-extractor-test-02": "workspace:*"
+  },
+  "devDependencies": {
+    "package-extractor-test-03": "workspace:*"
+  }
+}

build-tests/package-extractor-test-01/src/index.js

@@ -0,0 +1 @@
+export {};

build-tests/package-extractor-test-02/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "package-extractor-test-02",
+  "description": "This project is used by tests in the @rushstack/package-extractor package.",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "_phase:build": ""
+  },
+  "dependencies": {
+    "package-extractor-test-03": "workspace:*"
+  }
+}

build-tests/package-extractor-test-02/src/index.js

@@ -0,0 +1 @@
+export {};

build-tests/package-extractor-test-03/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "package-extractor-test-03",
+  "description": "This project is used by tests in the @rushstack/package-extractor package.",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "_phase:build": ""
+  }
+}

build-tests/package-extractor-test-03/src/index.js

@@ -0,0 +1 @@
+export {};

build-tests/package-extractor-test-04/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "package-extractor-test-04",
+  "description": "This project is used by tests in the @rushstack/package-extractor package.",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "_phase:build": ""
+  },
+  "dependencies": {
+    "@rushstack/node-core-library": "workspace:*"
+  }
+}

build-tests/package-extractor-test-04/src/index.js

@@ -0,0 +1 @@
+export {};

common/changes/@microsoft/rush/user-danade-MorePackageExtractorPatterns_2023-08-01-09-05.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add `patternsToInclude` and `patternsToExclude` support to Rush deploy.json configurations. This will allow developers to include or exclude provided glob patterns within a local project when running `rush deploy`.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/node-core-library/user-danade-MorePackageExtractorPatterns_2023-08-01-09-05.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/node-core-library",
+      "comment": "Update error messages when modules or packages cannot be found using the \"Import.resolve*\" methods.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/node-core-library"
+}

common/changes/@rushstack/package-extractor/user-danade-MorePackageExtractorPatterns_2023-08-01-09-05.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/package-extractor",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/package-extractor"
+}

common/config/rush/nonbrowser-approved-packages.json

@@ -630,6 +630,14 @@
       "name": "open",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "package-extractor-test-02",
+      "allowedCategories": [ "tests" ]
+    },
+    {
+      "name": "package-extractor-test-03",
+      "allowedCategories": [ "tests" ]
+    },
     {
       "name": "postcss",
       "allowedCategories": [ "libraries", "tests" ]

common/config/rush/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "5b48f46bcf623f6b470ccb325aabfa560dac4337",
+  "pnpmShrinkwrapHash": "1acb86f1b88b96c9dfced5d5c8c20d96302b0b1f",
   "preferredVersionsHash": "1926a5b12ac8f4ab41e76503a0d1d0dccc9c0e06"
 }

libraries/node-core-library/src/Import.ts

@@ -292,8 +292,8 @@ export class Import {
         preserveSymlinks: false,
         realpathSync: getRealPath
       });
-    } catch (e) {
-      throw new Error(`Cannot find module "${modulePath}" from "${options.baseFolderPath}".`);
+    } catch (e: unknown) {
+      throw new Error(`Cannot find module "${modulePath}" from "${options.baseFolderPath}": ${e}`);
     }
   }
 
@@ -383,8 +383,8 @@ export class Import {
         }
       );
       return await resolvePromise;
-    } catch (e) {
-      throw new Error(`Cannot find module "${modulePath}" from "${options.baseFolderPath}".`);
+    } catch (e: unknown) {
+      throw new Error(`Cannot find module "${modulePath}" from "${options.baseFolderPath}": ${e}`);
     }
   }
 
@@ -444,8 +444,8 @@ export class Import {
 
       const packagePath: string = path.dirname(resolvedPath);
       return packagePath;
-    } catch {
-      throw new Error(`Cannot find package "${packageName}" from "${baseFolderPath}".`);
+    } catch (e: unknown) {
+      throw new Error(`Cannot find package "${packageName}" from "${baseFolderPath}": ${e}.`);
     }
   }
 
@@ -536,8 +536,8 @@ export class Import {
 
       const packagePath: string = path.dirname(resolvedPath);
       return packagePath;
-    } catch {
-      throw new Error(`Cannot find package "${packageName}" from "${baseFolderPath}".`);
+    } catch (e: unknown) {
+      throw new Error(`Cannot find package "${packageName}" from "${baseFolderPath}": ${e}`);
     }
   }
 

libraries/node-core-library/src/test/__snapshots__/Import.test.ts.snap

@@ -1,21 +1,21 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Import resolveModule allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 1`] = `"Cannot find module \\"@rushstack/node-core-library\\" from \\"<packageRoot>/lib/test\\"."`;
+exports[`Import resolveModule allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 1`] = `"Cannot find module \\"@rushstack/node-core-library\\" from \\"<packageRoot>/lib/test\\": Error: Cannot find module '@rushstack/node-core-library' from '<dirname>'"`;
 
-exports[`Import resolveModule allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 2`] = `"Cannot find module \\"@rushstack/node-core-library/lib/Constants.js\\" from \\"<packageRoot>/lib/test\\"."`;
+exports[`Import resolveModule allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 2`] = `"Cannot find module \\"@rushstack/node-core-library/lib/Constants.js\\" from \\"<packageRoot>/lib/test\\": Error: Cannot find module '@rushstack/node-core-library/lib/Constants.js' from '<dirname>'"`;
 
-exports[`Import resolveModule includeSystemModules throws on an attempt to resolve a non-existing path inside a system module with includeSystemModules turned on 1`] = `"Cannot find module \\"fs/foo/bar\\" from \\"<packageRoot>/lib/test\\"."`;
+exports[`Import resolveModule includeSystemModules throws on an attempt to resolve a non-existing path inside a system module with includeSystemModules turned on 1`] = `"Cannot find module \\"fs/foo/bar\\" from \\"<packageRoot>/lib/test\\": Error: Cannot find module 'fs/foo/bar' from '<dirname>'"`;
 
 exports[`Import resolveModule includeSystemModules throws on an attempt to resolve a system module without includeSystemModules turned on 1`] = `"Cannot find module \\"fs\\" from \\"<packageRoot>/lib/test\\"."`;
 
 exports[`Import resolvePackage allowSelfReference fails to resolve a path inside this package with allowSelfReference turned on 1`] = `"The package name \\"@rushstack/node-core-library/lib/Constants.js\\" contains an invalid character: \\"/\\""`;
 
-exports[`Import resolvePackage allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 1`] = `"Cannot find package \\"@rushstack/node-core-library\\" from \\"<packageRoot>/lib/test\\"."`;
+exports[`Import resolvePackage allowSelfReference throws on an attempt to reference this package without allowSelfReference turned on 1`] = `"Cannot find package \\"@rushstack/node-core-library\\" from \\"<packageRoot>/lib/test\\": Error: Cannot find module '@rushstack/node-core-library/' from '<dirname>'."`;
 
 exports[`Import resolvePackage fails to resolve a path inside a dependency 1`] = `"The package name \\"@rushstack/heft/lib/start.js\\" contains an invalid character: \\"/\\""`;
 
 exports[`Import resolvePackage fails to resolve a path inside a dependency of a dependency 1`] = `"The package name \\"@rushstack/ts-command-line/lib/Constants.js\\" contains an invalid character: \\"/\\""`;
 
 exports[`Import resolvePackage includeSystemModules throws on an attempt to resolve a non-existing path inside a system module with includeSystemModules turned on 1`] = `"The package name \\"fs/foo/bar\\" contains an invalid character: \\"/\\""`;
 
-exports[`Import resolvePackage includeSystemModules throws on an attempt to resolve a system module without includeSystemModules turned on 1`] = `"Cannot find package \\"fs\\" from \\"<packageRoot>/lib/test\\"."`;
+exports[`Import resolvePackage includeSystemModules throws on an attempt to resolve a system module without includeSystemModules turned on 1`] = `"Cannot find package \\"fs\\" from \\"<packageRoot>/lib/test\\": Error: Cannot find module 'fs/' from '<dirname>'."`;

libraries/package-extractor/.gitignore

@@ -1,2 +1 @@
-# Keep temp folders in mocked 'repos' that are used for unit tests
-!**/test/**/temp
+test-output

libraries/package-extractor/config/heft.json

@@ -16,6 +16,10 @@
           }
         }
       }
+    },
+
+    "test": {
+      "cleanFiles": [{ "sourcePath": "test-output" }]
     }
   }
 }