feat(nest): nx init nest (#14254)

Author: nartc

e2e/nx-init/src/nx-init-nest.test.ts

@@ -0,0 +1,65 @@
+import {
+  e2eCwd,
+  exists,
+  getPackageManagerCommand,
+  getPublishedVersion,
+  runCLI,
+} from '@nrwl/e2e/utils';
+import { execSync } from 'child_process';
+import { removeSync } from 'fs-extra';
+
+describe('nx init (for NestCLI)', () => {
+  const pmc = getPackageManagerCommand({
+    packageManager: 'npm',
+  });
+  const projectName = 'nest-app';
+  const projectRoot = `${e2eCwd}/${projectName}`;
+  const cliOptions = { cwd: projectRoot };
+
+  afterEach(() => {
+    removeSync(projectRoot);
+  });
+
+  it('should convert NestCLI application to Nx standalone', () => {
+    execSync(
+      `${pmc.runUninstalledPackage} @nestjs/cli new ${projectName} --package-manager=npm`,
+      {
+        cwd: e2eCwd,
+        encoding: 'utf-8',
+        env: process.env,
+        stdio: ['pipe', 'pipe', 'pipe'],
+      }
+    );
+
+    const output = execSync(
+      `${
+        pmc.runUninstalledPackage
+      } nx@${getPublishedVersion()} init -y --cacheable=format`,
+      {
+        cwd: projectRoot,
+        encoding: 'utf-8',
+        env: process.env,
+        stdio: ['pipe', 'pipe', 'pipe'],
+      }
+    );
+
+    expect(output).toContain('Enabled computation caching');
+
+    // nest-cli.json is removed
+    expect(exists(`${projectRoot}/nest-cli.json`)).toBeFalsy();
+
+    // root nx.json exists
+    expect(exists(`${projectRoot}/nx.json`)).toBeTruthy();
+    // root project.json exists
+    expect(exists(`${projectRoot}/project.json`)).toBeTruthy();
+
+    runCLI('build', cliOptions);
+    expect(
+      exists(`${projectRoot}/dist/${projectName}/src/main.js`)
+    ).toBeTruthy();
+
+    // run build again for cache
+    const buildOutput = runCLI('build', cliOptions);
+    expect(buildOutput).toContain('Nx read the output from the cache');
+  }, 10000);
+});

package.json

@@ -46,6 +46,7 @@
     "@floating-ui/react-dom": "^1.0.1",
     "@nestjs/common": "^9.0.0",
     "@nestjs/core": "^9.0.0",
+    "@nestjs/cli": "^9.0.0",
     "@nestjs/platform-express": "^9.0.0",
     "@nestjs/schematics": "^9.0.0",
     "@nestjs/swagger": "^6.0.0",

packages/js/src/utils/inline.ts

@@ -245,6 +245,7 @@ function buildInlineGraphExternals(
 }
 
 function movePackage(from: string, to: string) {
+  if (from === to) return;
   copySync(from, to, { overwrite: true });
   removeSync(from);
 }
@@ -269,7 +270,8 @@ function updateImports(
 function recursiveUpdateImport(
   dirPath: string,
   importRegex: RegExp,
-  inlinedDepsDestOutputRecord: Record<string, string>
+  inlinedDepsDestOutputRecord: Record<string, string>,
+  rootParentDir?: string
 ) {
   const files = readdirSync(dirPath, { withFileTypes: true });
   for (const file of files) {
@@ -282,6 +284,8 @@ function recursiveUpdateImport(
       const fileContent = readFileSync(filePath, 'utf-8');
       const updatedContent = fileContent.replace(importRegex, (matched) => {
         const result = matched.replace(/['"]/g, '');
+        // If a match is the same as the rootParentDir, we're checking its own files so we return the matched as in no changes.
+        if (result === rootParentDir) return matched;
         const importPath = `"${relative(
           dirPath,
           inlinedDepsDestOutputRecord[result]
@@ -293,7 +297,8 @@ function recursiveUpdateImport(
       recursiveUpdateImport(
         join(dirPath, file.name),
         importRegex,
-        inlinedDepsDestOutputRecord
+        inlinedDepsDestOutputRecord,
+        rootParentDir || file.name
       );
     }
   }

packages/nest/src/generators/library/lib/add-project.ts

@@ -15,9 +15,10 @@ export function addProject(tree: Tree, options: NormalizedOptions): void {
     executor: '@nrwl/js:tsc',
     outputs: ['{options.outputPath}'],
     options: {
-      outputPath: options.libsDir
-        ? `dist/${options.libsDir}/${options.projectDirectory}`
-        : `dist/${options.projectDirectory}`,
+      outputPath:
+        options.libsDir && options.libsDir !== '.'
+          ? `dist/${options.libsDir}/${options.projectDirectory}`
+          : `dist/${options.projectDirectory}`,
       tsConfig: `${options.projectRoot}/tsconfig.lib.json`,
       packageJson: `${options.projectRoot}/package.json`,
       main: `${options.projectRoot}/src/index.ts`,

packages/nx/src/command-line/init.ts

@@ -1,7 +1,9 @@
 import { execSync } from 'child_process';
 import { existsSync } from 'fs';
-import { readJsonFile, directoryExists } from '../utils/fileutils';
+import { addNxToNest } from '../nx-init/add-nx-to-nest';
 import { addNxToNpmRepo } from '../nx-init/add-nx-to-npm-repo';
+import { directoryExists, readJsonFile } from '../utils/fileutils';
+import { PackageJson } from '../utils/package-json';
 
 export async function initHandler() {
   const args = process.argv.slice(2).join(' ');
@@ -10,17 +12,20 @@ export async function initHandler() {
     console.log(`Using version ${process.env.NX_VERSION}`);
   }
   if (existsSync('package.json')) {
+    const packageJson: PackageJson = readJsonFile('package.json');
     if (existsSync('angular.json')) {
       // TODO(leo): remove make-angular-cli-faster
       execSync(`npx --yes make-angular-cli-faster@${version} ${args}`, {
         stdio: [0, 1, 2],
       });
-    } else if (isCRA()) {
+    } else if (isCRA(packageJson)) {
       // TODO(jack): remove cra-to-nx
       execSync(`npx --yes cra-to-nx@${version} ${args}`, {
         stdio: [0, 1, 2],
       });
-    } else if (isMonorepo()) {
+    } else if (isNestCLI(packageJson)) {
+      await addNxToNest(packageJson);
+    } else if (isMonorepo(packageJson)) {
       // TODO: vsavkin remove add-nx-to-monorepo
       execSync(`npx --yes add-nx-to-monorepo@${version} ${args}`, {
         stdio: [0, 1, 2],
@@ -35,8 +40,7 @@ export async function initHandler() {
   }
 }
 
-function isCRA() {
-  const packageJson = readJsonFile('package.json');
+function isCRA(packageJson: PackageJson) {
   const combinedDependencies = {
     ...packageJson.dependencies,
     ...packageJson.devDependencies,
@@ -54,8 +58,19 @@ function isCRA() {
   );
 }
 
-function isMonorepo() {
-  const packageJson = readJsonFile('package.json');
+function isNestCLI(packageJson: PackageJson) {
+  const combinedDependencies = {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies,
+  };
+  return (
+    existsSync('nest-cli.json') &&
+    combinedDependencies['@nestjs/core'] &&
+    combinedDependencies['@nestjs/cli']
+  );
+}
+
+function isMonorepo(packageJson: PackageJson) {
   if (!!packageJson.workspaces) return true;
 
   if (existsSync('pnpm-workspace.yaml') || existsSync('pnpm-workspace.yml'))

packages/nx/src/config/nx-json.ts

@@ -27,6 +27,11 @@ export type TargetDependencies = Record<
   (TargetDependencyConfig | string)[]
 >;
 
+export interface NrwlJsPluginConfig {
+  analyzeSourceFiles?: boolean;
+  analyzePackageJson?: boolean;
+}
+
 /**
  * Nx.json configuration
  *