fix(bundling): set project type correct for buildable vite projects

nrwl · Jun 13, 2024 · f96d3ee · f96d3ee
1 parent 3750366
commit f96d3ee
Show file tree

Hide file tree

Showing 10 changed files with 300 additions and 69 deletions.
diff --git a/graph/ui-project-details/src/lib/project-details/project-details.stories.tsx b/graph/ui-project-details/src/lib/project-details/project-details.stories.tsx
@@ -835,3 +835,64 @@ export const Cart = {
     },
   },
 };
+
+// We're normalizing `type` from `projectType`, so if projectType is missing we'll fallback to `type`.
+// See: packages/nx/src/project-graph/utils/normalize-project-nodes.ts
+export const FallbackType = {
+  args: {
+    project: {
+      name: 'mypkg',
+      type: 'lib',
+      data: {
+        root: '.',
+        name: 'mypkg',
+        targets: {
+          echo: {
+            executor: 'nx:run-script',
+            metadata: {
+              scriptContent: 'echo 1',
+              runCommand: 'npm run echo',
+            },
+            options: {
+              script: 'echo',
+            },
+            configurations: {},
+          },
+        },
+        sourceRoot: '.',
+        implicitDependencies: [],
+        tags: [],
+      },
+    },
+    sourceMap: {
+      root: ['nx/core/project-json', 'project.json'],
+      name: ['nx/core/project-json', 'project.json'],
+      targets: ['nx/core/package-json', 'project.json'],
+      'targets.echo': ['nx/core/package-json-workspaces', 'package.json'],
+      'targets.echo.executor': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+      'targets.echo.options': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+      'targets.echo.metadata': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+      'targets.echo.options.script': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+      'targets.echo.metadata.scriptContent': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+      'targets.echo.metadata.runCommand': [
+        'nx/core/package-json-workspaces',
+        'package.json',
+      ],
+    },
+  },
+};
diff --git a/graph/ui-project-details/src/lib/project-details/project-details.tsx b/graph/ui-project-details/src/lib/project-details/project-details.tsx
@@ -6,7 +6,6 @@ import type { ProjectGraphProjectNode } from '@nx/devkit';
 // nx-ignore-next-line
 import { GraphError } from 'nx/src/command-line/graph/graph';
 /* eslint-enable @nx/enforce-module-boundaries */
-
 import { EyeIcon } from '@heroicons/react/24/outline';
 import { PropertyInfoTooltip, Tooltip } from '@nx/graph/ui-tooltips';
 import { TooltipTriggerText } from '../target-configuration-details/tooltip-trigger-text';
@@ -29,6 +28,24 @@ export interface ProjectDetailsProps {
   viewInProjectGraphPosition?: 'top' | 'bottom';
 }
 
+const typeToProjectType = {
+  app: 'Application',
+  lib: 'Library',
+  e2e: 'E2E',
+};
+
+function getDisplayType(project: ProjectGraphProjectNode) {
+  if (project.data.projectType) {
+    return (
+      project.data.projectType &&
+      project.data.projectType?.charAt(0)?.toUpperCase() +
+        project.data.projectType?.slice(1)
+    );
+  } else {
+    return typeToProjectType[project.type] ?? 'Library';
+  }
+}
+
 export const ProjectDetails = ({
   project,
   sourceMap,
@@ -41,10 +58,7 @@ export const ProjectDetails = ({
   const projectData = project.data;
   const isCompact = variant === 'compact';
 
-  const displayType =
-    projectData.projectType &&
-    projectData.projectType?.charAt(0)?.toUpperCase() +
-      projectData.projectType?.slice(1);
+  const displayType = getDisplayType(project);
 
   const technologies = [
     ...new Set(

diff --git a/packages/nx/src/config/to-project-name.spec.ts b/packages/nx/src/config/to-project-name.spec.ts
@@ -59,7 +59,6 @@ describe('Workspaces', () => {
             },
           },
           "name": "my-package",
-          "projectType": "library",
           "root": "packages/my-package",
           "sourceRoot": "packages/my-package",
           "targets": {

diff --git a/packages/nx/src/plugins/package-json-workspaces/create-nodes.spec.ts b/packages/nx/src/plugins/package-json-workspaces/create-nodes.spec.ts
@@ -59,7 +59,6 @@ describe('nx package.json workspaces plugin', () => {
               },
             },
             "name": "root",
-            "projectType": "library",
             "root": ".",
             "sourceRoot": ".",
             "targets": {
@@ -98,7 +97,6 @@ describe('nx package.json workspaces plugin', () => {
               },
             },
             "name": "lib-a",
-            "projectType": "library",
             "root": "packages/lib-a",
             "sourceRoot": "packages/lib-a",
             "targets": {
@@ -145,7 +143,6 @@ describe('nx package.json workspaces plugin', () => {
               },
             },
             "name": "lib-b",
-            "projectType": "library",
             "root": "packages/lib-b",
             "sourceRoot": "packages/lib-b",
             "targets": {
@@ -235,7 +232,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "vite",
-              "projectType": "library",
               "root": "packages/vite",
               "sourceRoot": "packages/vite",
               "targets": {
@@ -322,7 +318,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "vite",
-              "projectType": "library",
               "root": "packages/vite",
               "sourceRoot": "packages/vite",
               "targets": {
@@ -405,7 +400,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "vite",
-              "projectType": "library",
               "root": "packages/vite",
               "sourceRoot": "packages/vite",
               "targets": {
@@ -478,7 +472,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "root",
-              "projectType": "library",
               "root": "packages/a",
               "sourceRoot": "packages/a",
               "targets": {
@@ -543,7 +536,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "root",
-              "projectType": "library",
               "root": "packages/a",
               "sourceRoot": "packages/a",
               "targets": {
@@ -606,7 +598,6 @@ describe('nx package.json workspaces plugin', () => {
                 },
               },
               "name": "root",
-              "projectType": "library",
               "root": "packages/a",
               "sourceRoot": "packages/a",
               "targets": {
@@ -624,4 +615,91 @@ describe('nx package.json workspaces plugin', () => {
       `);
     });
   });
+
+  it('should infer library and application project types from appsDir and libsDir', () => {
+    vol.fromJSON(
+      {
+        'nx.json': JSON.stringify({
+          workspaceLayout: {
+            appsDir: 'apps',
+            libsDir: 'packages',
+          },
+        }),
+        'apps/myapp/package.json': JSON.stringify({
+          name: 'myapp',
+          scripts: { test: 'jest' },
+        }),
+        'packages/mylib/package.json': JSON.stringify({
+          name: 'mylib',
+          scripts: { test: 'jest' },
+        }),
+      },
+      '/root'
+    );
+
+    expect(
+      createNodeFromPackageJson('apps/myapp/package.json', '/root').projects[
+        'apps/myapp'
+      ].projectType
+    ).toEqual('application');
+
+    expect(
+      createNodeFromPackageJson('packages/mylib/package.json', '/root')
+        .projects['packages/mylib'].projectType
+    ).toEqual('library');
+  });
+
+  it('should infer library types for root library project if both appsDir and libsDir are set to empty string', () => {
+    vol.fromJSON(
+      {
+        'nx.json': JSON.stringify({
+          workspaceLayout: {
+            appsDir: '',
+            libsDir: '',
+          },
+        }),
+        'package.json': JSON.stringify({
+          name: 'mylib',
+          scripts: { test: 'jest' },
+        }),
+      },
+      '/root'
+    );
+
+    expect(
+      createNodeFromPackageJson('package.json', '/root').projects['.']
+        .projectType
+    ).toEqual('library');
+  });
+
+  it('should infer library project type if only libsDir is set', () => {
+    vol.fromJSON(
+      {
+        'nx.json': JSON.stringify({
+          workspaceLayout: {
+            libsDir: 'packages',
+          },
+        }),
+        'example/package.json': JSON.stringify({
+          name: 'example',
+          scripts: { test: 'jest' },
+        }),
+        'packages/mylib/package.json': JSON.stringify({
+          name: 'mylib',
+          scripts: { test: 'jest' },
+        }),
+      },
+      '/root'
+    );
+
+    expect(
+      createNodeFromPackageJson('packages/mylib/package.json', '/root')
+        .projects['packages/mylib'].projectType
+    ).toEqual('library');
+    expect(
+      createNodeFromPackageJson('example/package.json', '/root').projects[
+        'example'
+      ].projectType
+    ).toBeUndefined();
+  });
 });
diff --git a/packages/nx/src/plugins/package-json-workspaces/create-nodes.ts b/packages/nx/src/plugins/package-json-workspaces/create-nodes.ts
@@ -10,8 +10,8 @@ import { combineGlobPatterns } from '../../utils/globs';
 import { NX_PREFIX } from '../../utils/logger';
 import { output } from '../../utils/output';
 import {
-  PackageJson,
   getMetadataFromPackageJson,
+  PackageJson,
   readTargetsFromPackageJson,
 } from '../../utils/package-json';
 import { joinPathFragments } from '../../utils/path';
@@ -112,22 +112,30 @@ export function buildProjectConfigurationFromPackageJson(
   }
 
   let name = packageJson.name ?? toProjectName(normalizedPath);
-  const projectType =
-    nxJson?.workspaceLayout?.appsDir != nxJson?.workspaceLayout?.libsDir &&
-    nxJson?.workspaceLayout?.appsDir &&
-    projectRoot.startsWith(nxJson.workspaceLayout.appsDir)
-      ? 'application'
-      : 'library';
 
-  return {
+  const projectConfiguration: ProjectConfiguration & { name: string } = {
     root: projectRoot,
     sourceRoot: projectRoot,
     name,
-    projectType,
     ...packageJson.nx,
     targets: readTargetsFromPackageJson(packageJson),
     metadata: getMetadataFromPackageJson(packageJson),
   };
+
+  if (
+    nxJson?.workspaceLayout?.appsDir != nxJson?.workspaceLayout?.libsDir &&
+    nxJson?.workspaceLayout?.appsDir &&
+    projectRoot.startsWith(nxJson.workspaceLayout.appsDir)
+  ) {
+    projectConfiguration.projectType = 'application';
+  } else if (
+    typeof nxJson?.workspaceLayout?.libsDir !== 'undefined' &&
+    projectRoot.startsWith(nxJson.workspaceLayout.libsDir)
+  ) {
+    projectConfiguration.projectType = 'library';
+  }
+
+  return projectConfiguration;
 }
 
 /**

diff --git a/packages/vite/src/plugins/__snapshots__/plugin.spec.ts.snap b/packages/vite/src/plugins/__snapshots__/plugin.spec.ts.snap
@@ -1,5 +1,46 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`@nx/vite/plugin Library mode should exclude serve and preview targets when vite.config.ts is in library mode 1`] = `
+[
+  [
+    "my-lib/vite.config.ts",
+    {
+      "projects": {
+        "my-lib": {
+          "metadata": {},
+          "projectType": "library",
+          "root": "my-lib",
+          "targets": {
+            "build": {
+              "cache": true,
+              "command": "vite build",
+              "dependsOn": [
+                "^build",
+              ],
+              "inputs": [
+                "production",
+                "^production",
+                {
+                  "externalDependencies": [
+                    "vite",
+                  ],
+                },
+              ],
+              "options": {
+                "cwd": "my-lib",
+              },
+              "outputs": [
+                "{workspaceRoot}/dist/{projectRoot}",
+              ],
+            },
+          },
+        },
+      },
+    },
+  ],
+]
+`;
+
 exports[`@nx/vite/plugin not root project should create nodes 1`] = `
 [
   [
@@ -8,6 +49,7 @@ exports[`@nx/vite/plugin not root project should create nodes 1`] = `
       "projects": {
         "my-app": {
           "metadata": {},
+          "projectType": "application",
           "root": "my-app",
           "targets": {
             "build-something": {
@@ -67,6 +109,7 @@ exports[`@nx/vite/plugin root project should create nodes 1`] = `
       "projects": {
         ".": {
           "metadata": {},
+          "projectType": "application",
           "root": ".",
           "targets": {
             "build": {