Get files to be packed via npm pack --dry-run --json

[tommy-mitchell]

Per #669 (comment).

This PR removes the custom logic for determining a package's files and uses the built-in npm pack --dry-run --json command instead.

While it should just "work", I've added fixtures for a few different cases just to be sure.

Fixes #669.
Fixes #629.
Fixes #615.
Possibly fixes #610.
Possibly fixes #588.

[tommy-mitchell]

This integration test needs to be updated with a fixture:

test.serial('file `new` to package without tags added', async t => {
	await execa('touch', ['new']);
	await execa('touch', ['index.js']);

	t.context.teardown = () => {
		fs.unlinkSync('new');
		fs.unlinkSync('index.js');
	};

	t.deepEqual(await util.getNewFiles({files: ['index.js']}), {unpublished: ['new'], firstTime: ['index.js']});
});

[tommy-mitchell]

I've updated the integration test, but I'm not sure how to update it for the CI.

// using `del` v6.0.0

test.serial('file `new` to package without tags added', async t => {
	const pkg = {
		name: 'foo',
		version: '0.0.0',
		files: ['*.js']
	};

	await execa('mkdir', ['fixture']);
	process.chdir('fixture');

	await execa('touch', ['new']);
	await execa('touch', ['index.js']);
	await execa('echo', [`'${JSON.stringify(pkg, undefined, 4)}'`, '>', 'package.json'], {shell: true});

	t.context.teardown = async () => {
		process.chdir('..');
		await del('fixture');
	};

	t.deepEqual(await util.getNewFiles(), {unpublished: ['new'], firstTime: ['index.js', 'package.json']});
});

[sindresorhus]

I've updated the integration test, but I'm not sure how to update it for the CI.

I'm not sure either. I didn't add it. I suggest just marking it as .failing for now.

[sindresorhus]

CI is still failing

[tommy-mitchell]

I've rebased to main for ESM, still working on updating the integration tests.

[tommy-mitchell]

Still having trouble mocking process.cwd() for the integration tests to be the temp dir, but the esmock issue was fixed so that's not the problem anymore.

[tommy-mitchell]

If I manually set the execa commands in git-util.s and npm/util.js with {cwd: process.cwd()}, then the tests pass. This is a fun one.

[tommy-mitchell]

Ended up modifying execa and pkg-dir for the tests to set the working directory to the temp dir.

[sindresorhus]

🎉

@tommy-mitchell Are you planning any more changes or should I do the major release?

[tommy-mitchell]

@sindresorhus going to try tackling a couple of small issues, just opened another PR

Edit:

It seems like the new files check causes the initial startup of np to be slower than the latest release. It might have something be this double filter, but I've not profiled or anything:

// source/util.js
export const getNewFiles = async () => {
	const listNewFiles = await gitUtil.newFilesSinceLastRelease();
	const listPkgFiles = await npmUtil.getFilesToBePacked();

	return {
		unpublished: listNewFiles.filter(file => !listPkgFiles.includes(file) && !file.startsWith('.git')),
		firstTime: listNewFiles.filter(file => listPkgFiles.includes(file)),
	};
};

npmUtil.getFilesToBePacked should probably also used the already parsed package.json path:

// source/npm/util.js
export const getFilesToBePacked = async () => {
	// TODO: use pkgPath
	const {stdout} = await execa('npm', ['pack', '--dry-run', '--json'], {cwd: await packageDirectory()});

	const {files} = JSON.parse(stdout).at(0);
	return files.map(file => file.path);
};

Either way, if any pre-UI checks are added, the "time-to-interactive" will just get slower. Maybe we can add an ora spinner to at least show np is working?