Skip to content
Merged
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
20 changes: 20 additions & 0 deletions source/npm/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ export const getFilesToBePacked = async rootDirectory => {
'--dry-run',
'--json',
'--silent',
'--ignore-scripts',
// TODO: Remove this once [npm/cli#7354](https://github.com/npm/cli/issues/7354) is resolved.
'--foreground-scripts=false',
], {cwd: rootDirectory});
Expand All @@ -226,6 +227,21 @@ export const getFilesToBePacked = async rootDirectory => {
}
};

const hasPackLifecycleScript = package_ => {
const {scripts} = package_;

if (typeof scripts !== 'object' || scripts === null) {
return false;
}

return [
'prepare',
'prepack',
'prepublish',
'prepublishOnly',
].some(scriptName => typeof scripts[scriptName] === 'string');
};

const isValidEntryPoint = value => typeof value === 'string' && !value.includes('*');

const getExportsFiles = exports => {
Expand Down Expand Up @@ -295,6 +311,10 @@ export const verifyPackageEntryPoints = async (package_, rootDirectory) => {
}

if (missingEntryPoints.length > 0) {
if (hasPackLifecycleScript(package_)) {
return;
}

const missing = missingEntryPoints.map(({field, path: entryPath}) => ` "${field}": ${entryPath}`).join('\n');
throw new Error(`Missing entry points in published files:\n${missing}\n\nEnsure these files exist and are included in the "files" field.`);
}
Expand Down
1 change: 1 addition & 0 deletions test/fixtures/files/failing-prepack-script/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log('foo');
8 changes: 8 additions & 0 deletions test/fixtures/files/failing-prepack-script/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "foo",
"version": "0.0.0",
"files": ["index.js"],
"scripts": {
"prepack": "exit 1"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "prepack-generated-entry-point",
"version": "0.0.0",
"main": "dist/index.js",
"files": ["dist"],
"scripts": {
"prepack": "node --input-type=module -e \"import fs from 'node:fs'; fs.mkdirSync('dist', {recursive: true}); fs.writeFileSync('dist/index.js', 'export default 1;\\n');\""
}
}
2 changes: 1 addition & 1 deletion test/fixtures/files/prepare-script/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"version": "0.0.0",
"files": ["index.js"],
"scripts": {
"prepare": "echo '> foo@0.0.0 prepare' && echo '> test prepare script'"
"prepare": "echo '[build] compiling'"
}
}
11 changes: 11 additions & 0 deletions test/npm/util/entry-points.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,14 @@ test('verifyPackageEntryPoints - valid entry points', async t => {

await t.notThrowsAsync(npm.verifyPackageEntryPoints({main: 'index.js'}, fixtureDirectory));
});

test('verifyPackageEntryPoints - skipped when prepack script may generate files', async t => {
const fixtureDirectory = getFixture('prepack-generated-entry-point');

await t.notThrowsAsync(npm.verifyPackageEntryPoints({
main: 'dist/index.js',
scripts: {
prepack: 'build',
},
}, fixtureDirectory));
});
4 changes: 4 additions & 0 deletions test/npm/util/packed-files.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,7 @@ test('doesn\'t show files in .github', verifyPackedFiles, 'dot-github', [
test('handles prepare script output (e.g., Husky)', verifyPackedFiles, 'prepare-script', [
'index.js',
]);

test('ignores failing prepack script', verifyPackedFiles, 'failing-prepack-script', [
'index.js',
]);