Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(js): fix Rollup plugin to correctly handle .cjs.js and .mjs.js fi… #29366

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions e2e/rollup/src/rollup-legacy.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ describe('Rollup Plugin', () => {
);
rmDist();
runCLI(`build ${myPkg} --format=cjs,esm --generateExportsField`);
checkFilesExist(`dist/libs/${myPkg}/index.cjs.d.ts`);
checkFilesExist(`dist/libs/${myPkg}/index.d.ts`);
expect(readJson(`dist/libs/${myPkg}/package.json`).exports).toEqual({
'.': {
module: './index.esm.js',
import: './index.cjs.mjs',
default: './index.cjs.js',
types: './index.esm.d.ts',
types: './index.d.ts',
},
'./package.json': './package.json',
});
Expand Down Expand Up @@ -105,7 +105,7 @@ describe('Rollup Plugin', () => {

checkFilesExist(`dist/libs/${myPkg}/index.esm.js`);
checkFilesExist(`dist/libs/${myPkg}/index.cjs.js`);
checkFilesExist(`dist/libs/${myPkg}/index.cjs.d.ts`);
checkFilesExist(`dist/libs/${myPkg}/index.d.ts`);
checkFilesExist(`dist/libs/${myPkg}/foo.esm.js`);
checkFilesExist(`dist/libs/${myPkg}/foo.cjs.js`);
checkFilesExist(`dist/libs/${myPkg}/bar.esm.js`);
Expand All @@ -116,19 +116,19 @@ describe('Rollup Plugin', () => {
module: './index.esm.js',
import: './index.cjs.mjs',
default: './index.cjs.js',
types: './index.esm.d.ts',
types: './index.d.ts',
},
'./bar': {
module: './bar.esm.js',
import: './bar.cjs.mjs',
default: './bar.cjs.js',
types: './bar.esm.d.ts',
types: './bar.d.ts',
},
'./foo': {
module: './foo.esm.js',
import: './foo.cjs.mjs',
default: './foo.cjs.js',
types: './foo.esm.d.ts',
types: './foo.d.ts',
},
});
});
Expand Down
62 changes: 62 additions & 0 deletions packages/js/src/plugins/rollup/type-definitions.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { typeDefinitions } from './type-definitions';
describe('typeDefinitions', () => {
it('should emit correct .d.ts filenames for various file formats', () => {
const mockBundle = {
'index.js': {
type: 'chunk',
isEntry: true,
fileName: 'index.js',
facadeModuleId: '/project/src/index.ts',
exports: ['default', 'namedExport1', 'namedExport2'],
},
'index1.js': {
type: 'chunk',
isEntry: true,
fileName: 'index.cjs',
facadeModuleId: '/project/src/index.ts',
exports: ['default', 'namedExport1', 'namedExport2'],
},
'index2.js': {
type: 'chunk',
isEntry: true,
fileName: 'index.mjs',
facadeModuleId: '/project/src/index.ts',
exports: ['default', 'namedExport1', 'namedExport2'],
},
'index3.js': {
type: 'chunk',
isEntry: true,
fileName: 'index.cjs.js',
facadeModuleId: '/project/src/index.ts',
exports: ['default', 'namedExport1', 'namedExport2'],
},
'index4.js': {
type: 'chunk',
isEntry: true,
fileName: 'index.mjs.js',
facadeModuleId: '/project/src/index.ts',
exports: ['default', 'namedExport1', 'namedExport2'],
},
};

const mockOpts = {}; // Can be left empty for this scenario

const mockEmitFile = jest.fn();

const plugin = typeDefinitions({ projectRoot: '/project' });

// Simulate the `this` context of a Rollup plugin
const mockContext = {
emitFile: mockEmitFile,
};

// Run the plugin's `generateBundle` function
(async function testPlugin() {
await plugin.generateBundle.call(mockContext, mockOpts, mockBundle);

mockEmitFile.mock.calls.forEach(([{ fileName }]) => {
expect(fileName).toBe('index.d.ts');
});
})();
});
});
8 changes: 7 additions & 1 deletion packages/js/src/plugins/rollup/type-definitions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ export function typeDefinitions(options: { projectRoot: string }) {
/\.[cm]?[jt]sx?$/,
''
);
const dtsFileName = file.fileName.replace(/\.[cm]?js$/, '.d.ts');

// Replace various JavaScript file extensions (e.g., .js, .cjs, .mjs, .cjs.js, .mjs.js) with .d.ts for generating type definition file names.
const dtsFileName = file.fileName.replace(
/(\.cjs|\.mjs|\.js|\.cjs\.js|\.mjs\.js)$/,
'.d.ts'
);

const relativeSourceDtsName = JSON.stringify('./' + entrySourceDtsName);
const dtsFileSource = hasDefaultExport
? stripIndents`
Expand Down