feat(bundling): generate type definitions in rollup executor

nrwl · Jul 26, 2023 · d629bd4 · d629bd4
1 parent 1dadb3d
commit d629bd4
Show file tree

Hide file tree

Showing 10 changed files with 198 additions and 146 deletions.
diff --git a/e2e/rollup/src/rollup.test.ts b/e2e/rollup/src/rollup.test.ts
@@ -1,6 +1,8 @@
 import {
+  checkFilesExist,
   cleanupProject,
   newProject,
+  readJson,
   rmDist,
   runCLI,
   runCommand,
@@ -26,6 +28,10 @@ describe('Rollup Plugin', () => {
     runCLI(`build ${myPkg}`);
     let output = runCommand(`node dist/libs/${myPkg}/index.cjs`);
     expect(output).toMatch(/Hello/);
+    expect(readJson(`dist/libs/${myPkg}/package.json`).types).toBe(
+      './index.d.ts'
+    );
+    checkFilesExist(`dist/libs/${myPkg}/index.d.ts`);
 
     updateProjectConfig(myPkg, (config) => {
       delete config.targets.build;
@@ -40,6 +46,10 @@ describe('Rollup Plugin', () => {
     runCLI(`build ${myPkg}`);
     output = runCommand(`node dist/libs/${myPkg}/index.cjs`);
     expect(output).toMatch(/Hello/);
+    expect(readJson(`dist/libs/${myPkg}/package.json`).types).toBe(
+      './index.d.ts'
+    );
+    checkFilesExist(`dist/libs/${myPkg}/index.d.ts`);
 
     updateProjectConfig(myPkg, (config) => {
       delete config.targets.build;
@@ -54,6 +64,10 @@ describe('Rollup Plugin', () => {
     runCLI(`build ${myPkg}`);
     output = runCommand(`node dist/libs/${myPkg}/index.cjs`);
     expect(output).toMatch(/Hello/);
+    expect(readJson(`dist/libs/${myPkg}/package.json`).types).toBe(
+      './index.d.ts'
+    );
+    checkFilesExist(`dist/libs/${myPkg}/index.d.ts`);
   }, 500000);
 
   it('should be able to build libs generated with @nx/js:lib --bundler rollup', () => {

diff --git a/package.json b/package.json
@@ -237,6 +237,7 @@
     "resolve.exports": "1.1.0",
     "rollup": "^2.56.2",
     "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-dts": "^5.3.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.1",
     "rollup-plugin-typescript2": "0.34.1",
@@ -359,4 +360,3 @@
     }
   }
 }
-
diff --git a/packages/rollup/package.json b/packages/rollup/package.json
@@ -47,7 +47,8 @@
     "rxjs": "^7.8.0",
     "tslib": "^2.3.0",
     "@nx/devkit": "file:../devkit",
-    "@nx/js": "file:../js"
+    "@nx/js": "file:../js",
+    "rollup-plugin-dts": "^5.3.0"
   },
   "publishConfig": {
     "access": "public"

diff --git a/packages/rollup/src/executors/rollup/lib/normalize.ts b/packages/rollup/src/executors/rollup/lib/normalize.ts
@@ -9,6 +9,7 @@ export interface NormalizedRollupExecutorOptions extends RollupExecutorOptions {
   projectRoot: string;
   assets: AssetGlobPattern[];
   rollupConfig: string[];
+  typesTmpDir: string;
 }
 
 export function normalizeRollupExecutorOptions(
@@ -45,6 +46,7 @@ export function normalizeRollupExecutorOptions(
     projectRoot,
     outputPath,
     skipTypeCheck: options.skipTypeCheck || false,
+    typesTmpDir: join(root, 'tmp', '__nx__types__'),
   };
 }
 

diff --git a/packages/rollup/src/executors/rollup/lib/update-package-json.spec.ts b/packages/rollup/src/executors/rollup/lib/update-package-json.spec.ts
@@ -12,6 +12,7 @@ describe('updatePackageJson', () => {
     projectRoot: '.',
     assets: [],
     rollupConfig: [],
+    typesTmpDir: '',
   };
 
   const sharedContext = {

diff --git a/packages/rollup/src/executors/rollup/lib/update-package-json.ts b/packages/rollup/src/executors/rollup/lib/update-package-json.ts
@@ -1,4 +1,4 @@
-import { relative } from 'path';
+import { parse } from 'path';
 import { ExecutorContext } from 'nx/src/config/misc-interfaces';
 import { ProjectGraphProjectNode } from 'nx/src/config/project-graph';
 import {
@@ -19,10 +19,10 @@ export function updatePackageJson(
   const hasEsmFormat = options.format.includes('esm');
   const hasCjsFormat = options.format.includes('cjs');
 
-  const types = `./${relative(options.projectRoot, options.main).replace(
-    /\.[jt]sx?$/,
-    '.d.ts'
-  )}`;
+  const entryPointName = parse(options.main).name;
+  const cjsEntryPoint = `./${entryPointName}.cjs`;
+  const esmEntryPoint = `./${entryPointName}.js`;
+  const types = `./${entryPointName}.d.ts`;
   const exports = {
     // TS 4.5+
     '.': {
@@ -33,17 +33,17 @@ export function updatePackageJson(
   if (hasEsmFormat) {
     // `module` field is used by bundlers like rollup and webpack to detect ESM.
     // May not be required in the future if type is already "module".
-    packageJson.module = './index.js';
-    exports['.']['import'] = './index.js';
+    packageJson.module = esmEntryPoint;
+    exports['.']['import'] = esmEntryPoint;
 
     if (!hasCjsFormat) {
-      packageJson.main = './index.js';
+      packageJson.main = esmEntryPoint;
     }
   }
 
   if (hasCjsFormat) {
-    packageJson.main = './index.cjs';
-    exports['.']['require'] = './index.cjs';
+    packageJson.main = cjsEntryPoint;
+    exports['.']['require'] = cjsEntryPoint;
   }
   if (!options.skipTypeField) {
     packageJson.type = options.format.includes('esm') ? 'module' : 'commonjs';

diff --git a/packages/rollup/src/executors/rollup/lib/validate-types.ts b/packages/rollup/src/executors/rollup/lib/validate-types.ts
diff --git a/packages/rollup/src/executors/rollup/rollup.impl.spec.ts b/packages/rollup/src/executors/rollup/rollup.impl.spec.ts
@@ -62,6 +62,10 @@ describe('rollupExecutor', () => {
           chunkFileNames: '[name].cjs',
           entryFileNames: '[name].cjs',
         },
+        {
+          file: '/root/dist/ui/index.d.ts',
+          format: 'es',
+        },
       ]);
     });