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.

Sign up for GitHub

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

Jump to bottom

fix(js): handle different exports field shapes #12613

Merged
merged 1 commit into from Oct 15, 2022
Merged

fix(js): handle different exports field shapes #12613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
92 changes: 92 additions & 0 deletions packages/js/src/utils/package-json/update-package-json.spec.ts
View file
Open in desktop
Expand Up @@ -166,4 +166,96 @@ describe('getUpdatedPackageJsonContent', () => {
version: '0.0.1',
});
});

it('should support different exports field shape', () => {
// exports: string
expect(
getUpdatedPackageJsonContent(
{
name: 'test',
version: '0.0.1',
exports: './custom.js',
},
{
main: 'proj/src/index.ts',
outputPath: 'dist/proj',
projectRoot: 'proj',
format: ['esm', 'cjs'],
outputFileExtensionForCjs: '.cjs',
generateExportsField: true,
}
)
).toEqual({
name: 'test',
main: './src/index.cjs',
module: './src/index.js',
types: './src/index.d.ts',
version: '0.0.1',
exports: './custom.js',
});

// exports: { '.': string }
expect(
getUpdatedPackageJsonContent(
{
name: 'test',
version: '0.0.1',
exports: {
'.': './custom.js',
},
},
{
main: 'proj/src/index.ts',
outputPath: 'dist/proj',
projectRoot: 'proj',
format: ['esm', 'cjs'],
outputFileExtensionForCjs: '.cjs',
generateExportsField: true,
}
)
).toEqual({
name: 'test',
main: './src/index.cjs',
module: './src/index.js',
types: './src/index.d.ts',
version: '0.0.1',
exports: {
'.': './custom.js',
},
});

// exports: { './custom': string }
expect(
getUpdatedPackageJsonContent(
{
name: 'test',
version: '0.0.1',
exports: {
'./custom': './custom.js',
},
},
{
main: 'proj/src/index.ts',
outputPath: 'dist/proj',
projectRoot: 'proj',
format: ['esm', 'cjs'],
outputFileExtensionForCjs: '.cjs',
generateExportsField: true,
}
)
).toEqual({
name: 'test',
main: './src/index.cjs',
module: './src/index.js',
types: './src/index.d.ts',
version: '0.0.1',
exports: {
'.': {
import: './src/index.js',
require: './src/index.cjs',
},
'./custom': './custom.js',
},
});
});
});
28 changes: 22 additions & 6 deletions packages/js/src/utils/package-json/update-package-json.ts
View file
Open in desktop
Expand Up @@ -88,10 +88,14 @@ export function getUpdatedPackageJsonContent(
options.projectRoot
);
const typingsFile = `${relativeMainFileDir}${mainFile}.d.ts`;
const exports = {
'.': {},
...packageJson.exports,
};

const exports =
typeof packageJson.exports === 'string'
? packageJson.exports
: {
'.': {},
...packageJson.exports,
};

const mainJsFile =
options.outputFileName ?? `${relativeMainFileDir}${mainFile}.js`;
Expand All @@ -105,7 +109,13 @@ export function getUpdatedPackageJsonContent(
packageJson.main ??= mainJsFile;
}

exports['.']['import'] = mainJsFile;
if (typeof exports !== 'string') {
if (typeof exports['.'] !== 'string') {
exports['.']['import'] ??= mainJsFile;
} else if (!hasCjsFormat) {
exports['.'] ??= mainJsFile;
}
}
}

// CJS output may have .cjs or .js file extensions.
Expand All @@ -117,7 +127,13 @@ export function getUpdatedPackageJsonContent(
options.outputFileExtensionForCjs ?? '.js'
}`;
packageJson.main ??= cjsMain;
exports['.']['require'] = cjsMain;
if (typeof exports !== 'string') {
if (typeof exports['.'] !== 'string') {
exports['.']['require'] ??= cjsMain;
} else if (!hasEsmFormat) {
exports['.'] ??= cjsMain;
}
}
}

if (options.generateExportsField) {
Expand Down
10 changes: 6 additions & 4 deletions packages/nx/src/utils/package-json.ts
View file
Open in desktop
Expand Up @@ -37,10 +37,12 @@ export interface PackageJson {
main?: string;
types?: string;
module?: string;
exports?: Record<
string,
{ types?: string; require?: string; import?: string }
>;
exports?:
| string
| Record<
string,
string | { types?: string; require?: string; import?: string }
>;
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
peerDependencies?: Record<string, string>;
Expand Down
2 changes: 1 addition & 1 deletion packages/rollup/src/executors/rollup/lib/update-package-json.ts
View file
Open in desktop
Expand Up @@ -54,7 +54,7 @@ export function updatePackageJson(
packageJson.types = types;

// TODO(jack): remove this for Nx 16
if (options.generateExportsField) {
if (options.generateExportsField && typeof packageJson.exports !== 'string') {
packageJson.exports = {
...packageJson.exports,
...exports,
Expand Down