@nx/devkit 0.0.0-pr-22179-271588f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +68 -0
  3. package/index.d.ts +14 -0
  4. package/index.js +18 -0
  5. package/migrations.json +18 -0
  6. package/ngcli-adapter.d.ts +4 -0
  7. package/ngcli-adapter.js +11 -0
  8. package/nx.d.ts +1 -0
  9. package/nx.js +19 -0
  10. package/package.json +50 -0
  11. package/public-api.d.ts +78 -0
  12. package/public-api.js +100 -0
  13. package/src/executors/parse-target-string.d.ts +44 -0
  14. package/src/executors/parse-target-string.js +55 -0
  15. package/src/executors/read-target-options.d.ts +8 -0
  16. package/src/executors/read-target-options.js +38 -0
  17. package/src/generators/add-build-target-defaults.d.ts +2 -0
  18. package/src/generators/add-build-target-defaults.js +18 -0
  19. package/src/generators/artifact-name-and-directory-utils.d.ts +48 -0
  20. package/src/generators/artifact-name-and-directory-utils.js +239 -0
  21. package/src/generators/executor-options-utils.d.ts +21 -0
  22. package/src/generators/executor-options-utils.js +49 -0
  23. package/src/generators/format-files.d.ts +6 -0
  24. package/src/generators/format-files.js +91 -0
  25. package/src/generators/generate-files.d.ts +26 -0
  26. package/src/generators/generate-files.js +91 -0
  27. package/src/generators/project-name-and-root-utils.d.ts +47 -0
  28. package/src/generators/project-name-and-root-utils.js +298 -0
  29. package/src/generators/run-tasks-in-serial.d.ts +7 -0
  30. package/src/generators/run-tasks-in-serial.js +16 -0
  31. package/src/generators/to-js.d.ts +11 -0
  32. package/src/generators/to-js.js +24 -0
  33. package/src/generators/typescript/insert-import.d.ts +1 -0
  34. package/src/generators/typescript/insert-import.js +5 -0
  35. package/src/generators/typescript/insert-statement.d.ts +1 -0
  36. package/src/generators/typescript/insert-statement.js +5 -0
  37. package/src/generators/update-ts-configs-to-js.d.ts +4 -0
  38. package/src/generators/update-ts-configs-to-js.js +49 -0
  39. package/src/generators/visit-not-ignored-files.d.ts +5 -0
  40. package/src/generators/visit-not-ignored-files.js +41 -0
  41. package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.d.ts +2 -0
  42. package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js +9 -0
  43. package/src/migrations/update-16-9-0/migrate-mf-util-usage.d.ts +4 -0
  44. package/src/migrations/update-16-9-0/migrate-mf-util-usage.js +201 -0
  45. package/src/tasks/install-packages-task.d.ts +10 -0
  46. package/src/tasks/install-packages-task.js +41 -0
  47. package/src/utils/async-iterable/combine-async-iterables.d.ts +3 -0
  48. package/src/utils/async-iterable/combine-async-iterables.js +58 -0
  49. package/src/utils/async-iterable/create-async-iterable.d.ts +6 -0
  50. package/src/utils/async-iterable/create-async-iterable.js +58 -0
  51. package/src/utils/async-iterable/index.d.ts +4 -0
  52. package/src/utils/async-iterable/index.js +7 -0
  53. package/src/utils/async-iterable/map-async-iteratable.d.ts +1 -0
  54. package/src/utils/async-iterable/map-async-iteratable.js +18 -0
  55. package/src/utils/async-iterable/tap-async-iteratable.d.ts +1 -0
  56. package/src/utils/async-iterable/tap-async-iteratable.js +11 -0
  57. package/src/utils/binary-extensions.d.ts +1 -0
  58. package/src/utils/binary-extensions.js +275 -0
  59. package/src/utils/calculate-hash-for-create-nodes.d.ts +2 -0
  60. package/src/utils/calculate-hash-for-create-nodes.js +16 -0
  61. package/src/utils/config-utils.d.ts +4 -0
  62. package/src/utils/config-utils.js +75 -0
  63. package/src/utils/convert-nx-executor.d.ts +7 -0
  64. package/src/utils/convert-nx-executor.js +89 -0
  65. package/src/utils/get-named-inputs.d.ts +8 -0
  66. package/src/utils/get-named-inputs.js +26 -0
  67. package/src/utils/get-workspace-layout.d.ts +24 -0
  68. package/src/utils/get-workspace-layout.js +52 -0
  69. package/src/utils/invoke-nx-generator.d.ts +6 -0
  70. package/src/utils/invoke-nx-generator.js +172 -0
  71. package/src/utils/log-show-project-command.d.ts +1 -0
  72. package/src/utils/log-show-project-command.js +14 -0
  73. package/src/utils/move-dir.d.ts +5 -0
  74. package/src/utils/move-dir.js +28 -0
  75. package/src/utils/names.d.ts +18 -0
  76. package/src/utils/names.js +63 -0
  77. package/src/utils/offset-from-root.d.ts +13 -0
  78. package/src/utils/offset-from-root.js +29 -0
  79. package/src/utils/package-json.d.ts +78 -0
  80. package/src/utils/package-json.js +375 -0
  81. package/src/utils/replace-package.d.ts +2 -0
  82. package/src/utils/replace-package.js +125 -0
  83. package/src/utils/replace-project-configuration-with-plugin.d.ts +3 -0
  84. package/src/utils/replace-project-configuration-with-plugin.js +136 -0
  85. package/src/utils/rxjs-for-await.d.ts +109 -0
  86. package/src/utils/rxjs-for-await.js +363 -0
  87. package/src/utils/semver.d.ts +1 -0
  88. package/src/utils/semver.js +18 -0
  89. package/src/utils/string-change.d.ts +62 -0
  90. package/src/utils/string-change.js +109 -0
  91. package/src/utils/string-utils.d.ts +95 -0
  92. package/src/utils/string-utils.js +147 -0
  93. package/src/utils/update-package-scripts.d.ts +3 -0
  94. package/src/utils/update-package-scripts.js +175 -0
  95. package/src/utils/versions.d.ts +1 -0
  96. package/src/utils/versions.js +4 -0
  97. package/testing.d.ts +1 -0
  98. package/testing.js +5 -0
@@ -0,0 +1,375 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NX_VERSION = exports.ensurePackage = exports.removeDependenciesFromPackageJson = exports.addDependenciesToPackageJson = void 0;
4
+ const child_process_1 = require("child_process");
5
+ const module_1 = require("module");
6
+ const semver_1 = require("semver");
7
+ const install_packages_task_1 = require("../tasks/install-packages-task");
8
+ const nx_1 = require("../../nx");
9
+ const tmp_1 = require("tmp");
10
+ const path_1 = require("path");
11
+ const fs_1 = require("fs");
12
+ const { readJson, updateJson, getPackageManagerCommand, workspaceRoot, detectPackageManager, createTempNpmDirectory, getPackageManagerVersion, } = (0, nx_1.requireNx)();
13
+ const UNIDENTIFIED_VERSION = 'UNIDENTIFIED_VERSION';
14
+ const NON_SEMVER_TAGS = {
15
+ '*': 2,
16
+ [UNIDENTIFIED_VERSION]: 2,
17
+ next: 1,
18
+ latest: 0,
19
+ previous: -1,
20
+ legacy: -2,
21
+ };
22
+ function filterExistingDependencies(dependencies, existingAltDependencies) {
23
+ if (!existingAltDependencies) {
24
+ return dependencies;
25
+ }
26
+ return Object.keys(dependencies ?? {})
27
+ .filter((d) => !existingAltDependencies[d])
28
+ .reduce((acc, d) => ({ ...acc, [d]: dependencies[d] }), {});
29
+ }
30
+ function cleanSemver(version) {
31
+ return (0, semver_1.clean)(version) ?? (0, semver_1.coerce)(version);
32
+ }
33
+ function isIncomingVersionGreater(incomingVersion, existingVersion) {
34
+ // if version is in the format of "latest", "next" or similar - keep it, otherwise try to parse it
35
+ const incomingVersionCompareBy = incomingVersion in NON_SEMVER_TAGS
36
+ ? incomingVersion
37
+ : cleanSemver(incomingVersion)?.toString() ?? UNIDENTIFIED_VERSION;
38
+ const existingVersionCompareBy = existingVersion in NON_SEMVER_TAGS
39
+ ? existingVersion
40
+ : cleanSemver(existingVersion)?.toString() ?? UNIDENTIFIED_VERSION;
41
+ if (incomingVersionCompareBy in NON_SEMVER_TAGS &&
42
+ existingVersionCompareBy in NON_SEMVER_TAGS) {
43
+ return (NON_SEMVER_TAGS[incomingVersionCompareBy] >
44
+ NON_SEMVER_TAGS[existingVersionCompareBy]);
45
+ }
46
+ if (incomingVersionCompareBy in NON_SEMVER_TAGS ||
47
+ existingVersionCompareBy in NON_SEMVER_TAGS) {
48
+ return true;
49
+ }
50
+ return (0, semver_1.gt)(cleanSemver(incomingVersion), cleanSemver(existingVersion));
51
+ }
52
+ function updateExistingAltDependenciesVersion(dependencies, existingAltDependencies) {
53
+ return Object.keys(existingAltDependencies || {})
54
+ .filter((d) => {
55
+ if (!dependencies[d]) {
56
+ return false;
57
+ }
58
+ const incomingVersion = dependencies[d];
59
+ const existingVersion = existingAltDependencies[d];
60
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
61
+ })
62
+ .reduce((acc, d) => ({ ...acc, [d]: dependencies[d] }), {});
63
+ }
64
+ function updateExistingDependenciesVersion(dependencies, existingDependencies = {}) {
65
+ return Object.keys(dependencies)
66
+ .filter((d) => {
67
+ if (!existingDependencies[d]) {
68
+ return true;
69
+ }
70
+ const incomingVersion = dependencies[d];
71
+ const existingVersion = existingDependencies[d];
72
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
73
+ })
74
+ .reduce((acc, d) => ({ ...acc, [d]: dependencies[d] }), {});
75
+ }
76
+ /**
77
+ * Add Dependencies and Dev Dependencies to package.json
78
+ *
79
+ * For example:
80
+ * ```typescript
81
+ * addDependenciesToPackageJson(tree, { react: 'latest' }, { jest: 'latest' })
82
+ * ```
83
+ * This will **add** `react` and `jest` to the dependencies and devDependencies sections of package.json respectively.
84
+ *
85
+ * @param tree Tree representing file system to modify
86
+ * @param dependencies Dependencies to be added to the dependencies section of package.json
87
+ * @param devDependencies Dependencies to be added to the devDependencies section of package.json
88
+ * @param packageJsonPath Path to package.json
89
+ * @param keepExistingVersions If true, prevents existing dependencies from being bumped to newer versions
90
+ * @returns Callback to install dependencies only if necessary, no-op otherwise
91
+ */
92
+ function addDependenciesToPackageJson(tree, dependencies, devDependencies, packageJsonPath = 'package.json', keepExistingVersions) {
93
+ const currentPackageJson = readJson(tree, packageJsonPath);
94
+ /** Dependencies to install that are not met in dev dependencies */
95
+ let filteredDependencies = filterExistingDependencies(dependencies, currentPackageJson.devDependencies);
96
+ /** Dev dependencies to install that are not met in dependencies */
97
+ let filteredDevDependencies = filterExistingDependencies(devDependencies, currentPackageJson.dependencies);
98
+ // filtered dependencies should consist of:
99
+ // - dependencies of the same type that are not present
100
+ // by default, filtered dependencies also include these (unless keepExistingVersions is true):
101
+ // - dependencies of the same type that have greater version
102
+ // - specified dependencies of the other type that have greater version and are already installed as current type
103
+ filteredDependencies = {
104
+ ...updateExistingDependenciesVersion(filteredDependencies, currentPackageJson.dependencies),
105
+ ...updateExistingAltDependenciesVersion(devDependencies, currentPackageJson.dependencies),
106
+ };
107
+ filteredDevDependencies = {
108
+ ...updateExistingDependenciesVersion(filteredDevDependencies, currentPackageJson.devDependencies),
109
+ ...updateExistingAltDependenciesVersion(dependencies, currentPackageJson.devDependencies),
110
+ };
111
+ if (keepExistingVersions) {
112
+ filteredDependencies = removeExistingDependencies(filteredDependencies, currentPackageJson.dependencies);
113
+ filteredDevDependencies = removeExistingDependencies(filteredDevDependencies, currentPackageJson.devDependencies);
114
+ }
115
+ else {
116
+ filteredDependencies = removeLowerVersions(filteredDependencies, currentPackageJson.dependencies);
117
+ filteredDevDependencies = removeLowerVersions(filteredDevDependencies, currentPackageJson.devDependencies);
118
+ }
119
+ if (requiresAddingOfPackages(currentPackageJson, filteredDependencies, filteredDevDependencies)) {
120
+ updateJson(tree, packageJsonPath, (json) => {
121
+ json.dependencies = {
122
+ ...(json.dependencies || {}),
123
+ ...filteredDependencies,
124
+ };
125
+ json.devDependencies = {
126
+ ...(json.devDependencies || {}),
127
+ ...filteredDevDependencies,
128
+ };
129
+ json.dependencies = sortObjectByKeys(json.dependencies);
130
+ json.devDependencies = sortObjectByKeys(json.devDependencies);
131
+ return json;
132
+ });
133
+ return () => {
134
+ (0, install_packages_task_1.installPackagesTask)(tree);
135
+ };
136
+ }
137
+ return () => { };
138
+ }
139
+ exports.addDependenciesToPackageJson = addDependenciesToPackageJson;
140
+ /**
141
+ * @returns The the incoming dependencies that are higher than the existing verions
142
+ **/
143
+ function removeLowerVersions(incomingDeps, existingDeps) {
144
+ return Object.keys(incomingDeps).reduce((acc, d) => {
145
+ if (!existingDeps?.[d] ||
146
+ isIncomingVersionGreater(incomingDeps[d], existingDeps[d])) {
147
+ acc[d] = incomingDeps[d];
148
+ }
149
+ return acc;
150
+ }, {});
151
+ }
152
+ function removeExistingDependencies(incomingDeps, existingDeps) {
153
+ return Object.keys(incomingDeps).reduce((acc, d) => {
154
+ if (!existingDeps?.[d]) {
155
+ acc[d] = incomingDeps[d];
156
+ }
157
+ return acc;
158
+ }, {});
159
+ }
160
+ /**
161
+ * Remove Dependencies and Dev Dependencies from package.json
162
+ *
163
+ * For example:
164
+ * ```typescript
165
+ * removeDependenciesFromPackageJson(tree, ['react'], ['jest'])
166
+ * ```
167
+ * This will **remove** `react` and `jest` from the dependencies and devDependencies sections of package.json respectively.
168
+ *
169
+ * @param dependencies Dependencies to be removed from the dependencies section of package.json
170
+ * @param devDependencies Dependencies to be removed from the devDependencies section of package.json
171
+ * @returns Callback to uninstall dependencies only if necessary. undefined is returned if changes are not necessary.
172
+ */
173
+ function removeDependenciesFromPackageJson(tree, dependencies, devDependencies, packageJsonPath = 'package.json') {
174
+ const currentPackageJson = readJson(tree, packageJsonPath);
175
+ if (requiresRemovingOfPackages(currentPackageJson, dependencies, devDependencies)) {
176
+ updateJson(tree, packageJsonPath, (json) => {
177
+ for (const dep of dependencies) {
178
+ delete json.dependencies[dep];
179
+ }
180
+ for (const devDep of devDependencies) {
181
+ delete json.devDependencies[devDep];
182
+ }
183
+ json.dependencies = sortObjectByKeys(json.dependencies);
184
+ json.devDependencies = sortObjectByKeys(json.devDependencies);
185
+ return json;
186
+ });
187
+ }
188
+ return () => {
189
+ (0, install_packages_task_1.installPackagesTask)(tree);
190
+ };
191
+ }
192
+ exports.removeDependenciesFromPackageJson = removeDependenciesFromPackageJson;
193
+ function sortObjectByKeys(obj) {
194
+ if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
195
+ return obj;
196
+ }
197
+ return Object.keys(obj)
198
+ .sort()
199
+ .reduce((result, key) => {
200
+ return {
201
+ ...result,
202
+ [key]: obj[key],
203
+ };
204
+ }, {});
205
+ }
206
+ /**
207
+ * Verifies whether the given packageJson dependencies require an update
208
+ * given the deps & devDeps passed in
209
+ */
210
+ function requiresAddingOfPackages(packageJsonFile, deps, devDeps) {
211
+ let needsDepsUpdate = false;
212
+ let needsDevDepsUpdate = false;
213
+ packageJsonFile.dependencies = packageJsonFile.dependencies || {};
214
+ packageJsonFile.devDependencies = packageJsonFile.devDependencies || {};
215
+ if (Object.keys(deps).length > 0) {
216
+ needsDepsUpdate = Object.keys(deps).some((entry) => {
217
+ const incomingVersion = deps[entry];
218
+ if (packageJsonFile.dependencies[entry]) {
219
+ const existingVersion = packageJsonFile.dependencies[entry];
220
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
221
+ }
222
+ if (packageJsonFile.devDependencies[entry]) {
223
+ const existingVersion = packageJsonFile.devDependencies[entry];
224
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
225
+ }
226
+ return true;
227
+ });
228
+ }
229
+ if (Object.keys(devDeps).length > 0) {
230
+ needsDevDepsUpdate = Object.keys(devDeps).some((entry) => {
231
+ const incomingVersion = devDeps[entry];
232
+ if (packageJsonFile.devDependencies[entry]) {
233
+ const existingVersion = packageJsonFile.devDependencies[entry];
234
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
235
+ }
236
+ if (packageJsonFile.dependencies[entry]) {
237
+ const existingVersion = packageJsonFile.dependencies[entry];
238
+ return isIncomingVersionGreater(incomingVersion, existingVersion);
239
+ }
240
+ return true;
241
+ });
242
+ }
243
+ return needsDepsUpdate || needsDevDepsUpdate;
244
+ }
245
+ /**
246
+ * Verifies whether the given packageJson dependencies require an update
247
+ * given the deps & devDeps passed in
248
+ */
249
+ function requiresRemovingOfPackages(packageJsonFile, deps, devDeps) {
250
+ let needsDepsUpdate = false;
251
+ let needsDevDepsUpdate = false;
252
+ packageJsonFile.dependencies = packageJsonFile.dependencies || {};
253
+ packageJsonFile.devDependencies = packageJsonFile.devDependencies || {};
254
+ if (deps.length > 0) {
255
+ needsDepsUpdate = deps.some((entry) => packageJsonFile.dependencies[entry]);
256
+ }
257
+ if (devDeps.length > 0) {
258
+ needsDevDepsUpdate = devDeps.some((entry) => packageJsonFile.devDependencies[entry]);
259
+ }
260
+ return needsDepsUpdate || needsDevDepsUpdate;
261
+ }
262
+ const packageMapCache = new Map();
263
+ function ensurePackage(pkgOrTree, requiredVersionOrPackage, maybeRequiredVersion, _) {
264
+ let pkg;
265
+ let requiredVersion;
266
+ if (typeof pkgOrTree === 'string') {
267
+ pkg = pkgOrTree;
268
+ requiredVersion = requiredVersionOrPackage;
269
+ }
270
+ else {
271
+ // Old Signature
272
+ pkg = requiredVersionOrPackage;
273
+ requiredVersion = maybeRequiredVersion;
274
+ }
275
+ if (packageMapCache.has(pkg)) {
276
+ return packageMapCache.get(pkg);
277
+ }
278
+ try {
279
+ return require(pkg);
280
+ }
281
+ catch (e) {
282
+ if (e.code === 'ERR_REQUIRE_ESM') {
283
+ // The package is installed, but is an ESM package.
284
+ // The consumer of this function can import it as needed.
285
+ return null;
286
+ }
287
+ else if (e.code !== 'MODULE_NOT_FOUND') {
288
+ throw e;
289
+ }
290
+ }
291
+ if (process.env.NX_DRY_RUN && process.env.NX_DRY_RUN !== 'false') {
292
+ throw new Error('NOTE: This generator does not support --dry-run. If you are running this in Nx Console, it should execute fine once you hit the "Generate" button.\n');
293
+ }
294
+ const { dir: tempDir } = createTempNpmDirectory?.() ?? {
295
+ dir: (0, tmp_1.dirSync)().name,
296
+ };
297
+ console.log(`Fetching ${pkg}...`);
298
+ const packageManager = detectPackageManager();
299
+ const isVerbose = process.env.NX_VERBOSE_LOGGING === 'true';
300
+ generatePackageManagerFiles(tempDir, packageManager);
301
+ const preInstallCommand = getPackageManagerCommand(packageManager).preInstall;
302
+ if (preInstallCommand) {
303
+ // ensure package.json and repo in tmp folder is set to a proper package manager state
304
+ (0, child_process_1.execSync)(preInstallCommand, {
305
+ cwd: tempDir,
306
+ stdio: isVerbose ? 'inherit' : 'ignore',
307
+ });
308
+ }
309
+ let addCommand = getPackageManagerCommand(packageManager).addDev;
310
+ if (packageManager === 'pnpm') {
311
+ addCommand = 'pnpm add -D'; // we need to ensure that we are not using workspace command
312
+ }
313
+ (0, child_process_1.execSync)(`${addCommand} ${pkg}@${requiredVersion}`, {
314
+ cwd: tempDir,
315
+ stdio: isVerbose ? 'inherit' : 'ignore',
316
+ });
317
+ addToNodePath((0, path_1.join)(workspaceRoot, 'node_modules'));
318
+ addToNodePath((0, path_1.join)(tempDir, 'node_modules'));
319
+ // Re-initialize the added paths into require
320
+ module_1.Module._initPaths();
321
+ try {
322
+ const result = require(require.resolve(pkg, {
323
+ paths: [tempDir],
324
+ }));
325
+ packageMapCache.set(pkg, result);
326
+ return result;
327
+ }
328
+ catch (e) {
329
+ if (e.code === 'ERR_REQUIRE_ESM') {
330
+ // The package is installed, but is an ESM package.
331
+ // The consumer of this function can import it as needed.
332
+ packageMapCache.set(pkg, null);
333
+ return null;
334
+ }
335
+ throw e;
336
+ }
337
+ }
338
+ exports.ensurePackage = ensurePackage;
339
+ /**
340
+ * Generates necessary files needed for the package manager to work
341
+ * and for the node_modules to be accessible.
342
+ */
343
+ function generatePackageManagerFiles(root, packageManager = detectPackageManager()) {
344
+ const [pmMajor] = getPackageManagerVersion(packageManager).split('.');
345
+ switch (packageManager) {
346
+ case 'yarn':
347
+ if (+pmMajor >= 2) {
348
+ (0, fs_1.writeFileSync)((0, path_1.join)(root, '.yarnrc.yml'), 'nodeLinker: node-modules\nenableScripts: false');
349
+ }
350
+ break;
351
+ }
352
+ }
353
+ function addToNodePath(dir) {
354
+ // NODE_PATH is a delimited list of paths.
355
+ // The delimiter is different for windows.
356
+ const delimiter = require('os').platform() === 'win32' ? ';' : ':';
357
+ const paths = process.env.NODE_PATH
358
+ ? process.env.NODE_PATH.split(delimiter)
359
+ : [];
360
+ // The path is already in the node path
361
+ if (paths.includes(dir)) {
362
+ return;
363
+ }
364
+ // Add the tmp path
365
+ paths.push(dir);
366
+ // Update the env variable.
367
+ process.env.NODE_PATH = paths.join(delimiter);
368
+ }
369
+ function getPackageVersion(pkg) {
370
+ return require((0, path_1.join)(pkg, 'package.json')).version;
371
+ }
372
+ /**
373
+ * @description The version of Nx used by the workspace. Returns null if no version is found.
374
+ */
375
+ exports.NX_VERSION = getPackageVersion('nx');
@@ -0,0 +1,2 @@
1
+ import type { Tree } from 'nx/src/generators/tree';
2
+ export declare function replaceNrwlPackageWithNxPackage(tree: Tree, oldPackageName: string, newPackageName: string): void;
@@ -0,0 +1,125 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.replaceNrwlPackageWithNxPackage = void 0;
4
+ const nx_1 = require("../../nx");
5
+ const visit_not_ignored_files_1 = require("../generators/visit-not-ignored-files");
6
+ const path_1 = require("path");
7
+ const binary_extensions_1 = require("./binary-extensions");
8
+ const { logger } = (0, nx_1.requireNx)();
9
+ const { getProjects, updateProjectConfiguration, readNxJson, updateNxJson, updateJson, } = (0, nx_1.requireNx)();
10
+ function replaceNrwlPackageWithNxPackage(tree, oldPackageName, newPackageName) {
11
+ replacePackageInDependencies(tree, oldPackageName, newPackageName);
12
+ replacePackageInProjectConfigurations(tree, oldPackageName, newPackageName);
13
+ replacePackageInNxJson(tree, oldPackageName, newPackageName);
14
+ replaceMentions(tree, oldPackageName, newPackageName);
15
+ }
16
+ exports.replaceNrwlPackageWithNxPackage = replaceNrwlPackageWithNxPackage;
17
+ function replacePackageInDependencies(tree, oldPackageName, newPackageName) {
18
+ (0, visit_not_ignored_files_1.visitNotIgnoredFiles)(tree, '.', (path) => {
19
+ if ((0, path_1.basename)(path) !== 'package.json') {
20
+ return;
21
+ }
22
+ try {
23
+ updateJson(tree, path, (packageJson) => {
24
+ for (const deps of [
25
+ packageJson.dependencies ?? {},
26
+ packageJson.devDependencies ?? {},
27
+ packageJson.peerDependencies ?? {},
28
+ packageJson.optionalDependencies ?? {},
29
+ ]) {
30
+ if (oldPackageName in deps) {
31
+ deps[newPackageName] = deps[oldPackageName];
32
+ delete deps[oldPackageName];
33
+ }
34
+ }
35
+ return packageJson;
36
+ });
37
+ }
38
+ catch (e) {
39
+ console.warn(`Could not replace ${oldPackageName} with ${newPackageName} in ${path}.`);
40
+ }
41
+ });
42
+ }
43
+ function replacePackageInProjectConfigurations(tree, oldPackageName, newPackageName) {
44
+ const projects = getProjects(tree);
45
+ for (const [projectName, projectConfiguration] of projects) {
46
+ let needsUpdate = false;
47
+ for (const [targetName, targetConfig] of Object.entries(projectConfiguration.targets ?? {})) {
48
+ if (!targetConfig.executor) {
49
+ continue;
50
+ }
51
+ const [pkg, executorName] = targetConfig.executor.split(':');
52
+ if (pkg === oldPackageName) {
53
+ needsUpdate = true;
54
+ projectConfiguration.targets[targetName].executor =
55
+ newPackageName + ':' + executorName;
56
+ }
57
+ }
58
+ for (const [collection, collectionDefaults] of Object.entries(projectConfiguration.generators ?? {})) {
59
+ if (collection === oldPackageName) {
60
+ needsUpdate = true;
61
+ projectConfiguration.generators[newPackageName] = collectionDefaults;
62
+ delete projectConfiguration.generators[collection];
63
+ }
64
+ }
65
+ if (needsUpdate) {
66
+ updateProjectConfiguration(tree, projectName, projectConfiguration);
67
+ }
68
+ }
69
+ }
70
+ function replacePackageInNxJson(tree, oldPackageName, newPackageName) {
71
+ if (!tree.exists('nx.json')) {
72
+ return;
73
+ }
74
+ const nxJson = readNxJson(tree);
75
+ let needsUpdate = false;
76
+ for (const [targetName, targetConfig] of Object.entries(nxJson.targetDefaults ?? {})) {
77
+ if (!targetConfig.executor) {
78
+ continue;
79
+ }
80
+ const [pkg, executorName] = targetConfig.executor.split(':');
81
+ if (pkg === oldPackageName) {
82
+ needsUpdate = true;
83
+ nxJson.targetDefaults[targetName].executor =
84
+ newPackageName + ':' + executorName;
85
+ }
86
+ }
87
+ for (const [collection, collectionDefaults] of Object.entries(nxJson.generators ?? {})) {
88
+ if (collection === oldPackageName) {
89
+ needsUpdate = true;
90
+ nxJson.generators[newPackageName] = collectionDefaults;
91
+ delete nxJson.generators[collection];
92
+ }
93
+ }
94
+ if (needsUpdate) {
95
+ updateNxJson(tree, nxJson);
96
+ }
97
+ }
98
+ function replaceMentions(tree, oldPackageName, newPackageName) {
99
+ (0, visit_not_ignored_files_1.visitNotIgnoredFiles)(tree, '.', (path) => {
100
+ if ((0, binary_extensions_1.isBinaryPath)(path)) {
101
+ return;
102
+ }
103
+ const ignoredFiles = [
104
+ 'yarn.lock',
105
+ 'package-lock.json',
106
+ 'pnpm-lock.yaml',
107
+ 'CHANGELOG.md',
108
+ ];
109
+ if (ignoredFiles.includes((0, path_1.basename)(path))) {
110
+ return;
111
+ }
112
+ try {
113
+ const contents = tree.read(path).toString();
114
+ if (!contents.includes(oldPackageName)) {
115
+ return;
116
+ }
117
+ tree.write(path, contents.replace(new RegExp(oldPackageName, 'g'), newPackageName));
118
+ }
119
+ catch {
120
+ // Its **probably** ok, contents can be null if the file is too large or
121
+ // there was an access exception.
122
+ logger.warn(`An error was thrown when trying to update ${path}. If you believe the migration should have updated it, be sure to review the file and open an issue.`);
123
+ }
124
+ });
125
+ }
@@ -0,0 +1,3 @@
1
+ import type { Tree } from 'nx/src/generators/tree';
2
+ import type { CreateNodes } from 'nx/src/utils/nx-plugin';
3
+ export declare function replaceProjectConfigurationsWithPlugin<T = unknown>(tree: Tree, rootMappings: Map<string, string>, pluginPath: string, createNodes: CreateNodes<T>, pluginOptions: T): Promise<void>;
@@ -0,0 +1,136 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.replaceProjectConfigurationsWithPlugin = void 0;
4
+ const nx_1 = require("../../nx");
5
+ const { readNxJson, updateNxJson, glob, hashObject, findProjectForPath, readProjectConfiguration, updateProjectConfiguration, } = (0, nx_1.requireNx)();
6
+ async function replaceProjectConfigurationsWithPlugin(tree, rootMappings, pluginPath, createNodes, pluginOptions) {
7
+ const nxJson = readNxJson(tree);
8
+ const hasPlugin = nxJson.plugins?.some((p) => typeof p === 'string' ? p === pluginPath : p.plugin === pluginPath);
9
+ if (hasPlugin) {
10
+ return;
11
+ }
12
+ nxJson.plugins ??= [];
13
+ nxJson.plugins.push({
14
+ plugin: pluginPath,
15
+ options: pluginOptions,
16
+ });
17
+ updateNxJson(tree, nxJson);
18
+ const [pluginGlob, createNodesFunction] = createNodes;
19
+ const configFiles = glob(tree, [pluginGlob]);
20
+ for (const configFile of configFiles) {
21
+ try {
22
+ const projectName = findProjectForPath(configFile, rootMappings);
23
+ const projectConfig = readProjectConfiguration(tree, projectName);
24
+ const nodes = await createNodesFunction(configFile, pluginOptions, {
25
+ workspaceRoot: tree.root,
26
+ nxJsonConfiguration: readNxJson(tree),
27
+ });
28
+ const node = nodes.projects[Object.keys(nodes.projects)[0]];
29
+ for (const [targetName, targetConfig] of Object.entries(node.targets)) {
30
+ const targetFromProjectConfig = projectConfig.targets[targetName];
31
+ if (targetFromProjectConfig?.executor !== targetConfig.executor) {
32
+ continue;
33
+ }
34
+ const targetFromCreateNodes = node.targets[targetName];
35
+ removeConfigurationDefinedByPlugin(targetName, targetFromProjectConfig, targetFromCreateNodes, projectConfig);
36
+ }
37
+ updateProjectConfiguration(tree, projectName, projectConfig);
38
+ }
39
+ catch (e) {
40
+ console.error(e);
41
+ }
42
+ }
43
+ }
44
+ exports.replaceProjectConfigurationsWithPlugin = replaceProjectConfigurationsWithPlugin;
45
+ function removeConfigurationDefinedByPlugin(targetName, targetFromProjectConfig, targetFromCreateNodes, projectConfig) {
46
+ // Executor
47
+ delete targetFromProjectConfig.executor;
48
+ // Default Configuration
49
+ if (targetFromProjectConfig.defaultConfiguration ===
50
+ targetFromCreateNodes.defaultConfiguration) {
51
+ delete targetFromProjectConfig.defaultConfiguration;
52
+ }
53
+ // Cache
54
+ if (targetFromProjectConfig.cache === targetFromCreateNodes.cache) {
55
+ delete targetFromProjectConfig.cache;
56
+ }
57
+ // Depends On
58
+ if (targetFromProjectConfig.dependsOn &&
59
+ shouldRemoveArrayProperty(targetFromProjectConfig.dependsOn, targetFromCreateNodes.dependsOn)) {
60
+ delete targetFromProjectConfig.dependsOn;
61
+ }
62
+ // Outputs
63
+ if (targetFromProjectConfig.outputs &&
64
+ shouldRemoveArrayProperty(targetFromProjectConfig.outputs, targetFromCreateNodes.outputs)) {
65
+ delete targetFromProjectConfig.outputs;
66
+ }
67
+ // Inputs
68
+ if (targetFromProjectConfig.inputs &&
69
+ shouldRemoveArrayProperty(targetFromProjectConfig.inputs, targetFromCreateNodes.inputs)) {
70
+ delete targetFromProjectConfig.inputs;
71
+ }
72
+ // Options
73
+ for (const [optionName, optionValue] of Object.entries(targetFromProjectConfig.options ?? {})) {
74
+ if (equals(targetFromCreateNodes.options[optionName], optionValue)) {
75
+ delete targetFromProjectConfig.options[optionName];
76
+ }
77
+ }
78
+ if (Object.keys(targetFromProjectConfig.options).length === 0) {
79
+ delete targetFromProjectConfig.options;
80
+ }
81
+ // Configurations
82
+ for (const [configName, configOptions] of Object.entries(targetFromProjectConfig.configurations ?? {})) {
83
+ for (const [optionName, optionValue] of Object.entries(configOptions)) {
84
+ if (targetFromCreateNodes.configurations?.[configName]?.[optionName] ===
85
+ optionValue) {
86
+ delete targetFromProjectConfig.configurations[configName][optionName];
87
+ }
88
+ }
89
+ if (Object.keys(configOptions).length === 0) {
90
+ delete targetFromProjectConfig.configurations[configName];
91
+ }
92
+ }
93
+ if (Object.keys(targetFromProjectConfig.configurations ?? {}).length === 0) {
94
+ delete targetFromProjectConfig.configurations;
95
+ }
96
+ if (Object.keys(targetFromProjectConfig).length === 0) {
97
+ delete projectConfig.targets[targetName];
98
+ }
99
+ }
100
+ function equals(a, b) {
101
+ if (Array.isArray(a) && Array.isArray(b)) {
102
+ return a.length === b.length && a.every((v, i) => v === b[i]);
103
+ }
104
+ if (typeof a === 'object' && typeof b === 'object') {
105
+ return hashObject(a) === hashObject(b);
106
+ }
107
+ return a === b;
108
+ }
109
+ function shouldRemoveArrayProperty(arrayValuesFromProjectConfiguration, arrayValuesFromCreateNodes) {
110
+ const setOfArrayValuesFromProjectConfiguration = new Set(arrayValuesFromProjectConfiguration);
111
+ loopThroughArrayValuesFromCreateNodes: for (const arrayValueFromCreateNodes of arrayValuesFromCreateNodes) {
112
+ if (typeof arrayValueFromCreateNodes === 'string') {
113
+ if (!setOfArrayValuesFromProjectConfiguration.has(arrayValueFromCreateNodes)) {
114
+ // If the inputs from the project configuration is missing an input from createNodes it was removed
115
+ return false;
116
+ }
117
+ else {
118
+ setOfArrayValuesFromProjectConfiguration.delete(arrayValueFromCreateNodes);
119
+ }
120
+ }
121
+ else {
122
+ for (const arrayValue of setOfArrayValuesFromProjectConfiguration.values()) {
123
+ if (typeof arrayValue !== 'string' &&
124
+ hashObject(arrayValue) === hashObject(arrayValueFromCreateNodes)) {
125
+ setOfArrayValuesFromProjectConfiguration.delete(arrayValue);
126
+ // Continue the outer loop, breaking out of this loop
127
+ continue loopThroughArrayValuesFromCreateNodes;
128
+ }
129
+ }
130
+ // If an input was not matched, that means the input was removed
131
+ return false;
132
+ }
133
+ }
134
+ // If there are still inputs in the project configuration, they have added additional inputs
135
+ return setOfArrayValuesFromProjectConfiguration.size === 0;
136
+ }