Show files added since the last release and not part of the package

package.json

@@ -41,6 +41,7 @@
 		"github-url-from-git": "^1.5.0",
 		"has-yarn": "^2.1.0",
 		"hosted-git-info": "^3.0.0",
+		"ignore-walk": "^3.0.2",
 		"inquirer": "^7.0.0",
 		"is-installed-globally": "^0.3.1",
 		"is-scoped": "^2.1.0",
@@ -49,6 +50,7 @@
 		"listr-input": "^0.2.0",
 		"log-symbols": "^3.0.0",
 		"meow": "^6.0.0",
+		"minimatch": "^3.0.4",
 		"new-github-release-url": "^1.0.0",
 		"npm-name": "^5.4.0",
 		"onetime": "^5.1.0",
@@ -68,6 +70,7 @@
 	"devDependencies": {
 		"ava": "^2.3.0",
 		"proxyquire": "^2.1.0",
+		"mockery": "^2.1.0",
 		"sinon": "^8.0.1",
 		"xo": "^0.25.3"
 	}

source/git-util.js

@@ -8,6 +8,12 @@ exports.latestTag = async () => {
 	return stdout;
 };
 
+exports.newFilesSinceLastRelease = async () => {
+	const {stdout} = await execa('git', ['diff', '--stat', '--diff-filter=A', await this.latestTag(), 'HEAD']);
+	const result = stdout.trim().split('\n').slice(0, -1).map(row => row.slice(0, row.indexOf('|')).trim());
+	return result;
+};
+
 const firstCommit = async () => {
 	const {stdout} = await execa('git', ['rev-list', '--max-parents=0', 'HEAD']);
 	return stdout;

source/npm/util.js

@@ -7,6 +7,8 @@ const ow = require('ow');
 const npmName = require('npm-name');
 const chalk = require('chalk');
 const pkgDir = require('pkg-dir');
+const ignoreWalker = require('ignore-walk');
+const minimatch = require('minimatch');
 const {verifyRequirementSatisfied} = require('../version');
 
 exports.checkConnection = () => pTimeout(
@@ -117,16 +119,72 @@ exports.verifyRecentNpmVersion = async () => {
 };
 
 exports.checkIgnoreStrategy = ({files}) => {
-	const rootDir = pkgDir.sync();
-	const npmignoreExists = fs.existsSync(path.resolve(rootDir, '.npmignore'));
-
-	if (!files && !npmignoreExists) {
+	if (!files && !npmignoreExistsInPackageRootDir()) {
 		console.log(`
 		\n${chalk.bold.yellow('Warning:')} No ${chalk.bold.cyan('files')} field specified in ${chalk.bold.magenta('package.json')} nor is a ${chalk.bold.magenta('.npmignore')} file present. Having one of those will prevent you from accidentally publishing development-specific files along with your package's source code to npm.
 		`);
 	}
 };
 
+function npmignoreExistsInPackageRootDir() {
+	const rootDir = pkgDir.sync();
+	return fs.existsSync(path.resolve(rootDir, '.npmignore'));
+}
+
+async function getFilesIgnoredByDotnpmignore(fileList) {
+	const whiteList = await ignoreWalker({
+		path: pkgDir.sync(),
+		ignoreFiles: ['.npmignore']
+	});
+	return fileList.filter(minimatch.filter(getIgnoredFilesGlob(whiteList), {matchBase: true}));
+}
+
+function getFilesNotIncludedInFilesProperty(globArrayFromFilesProperty, fileList) {
+	const globArrayForFilesAndDirs = [...globArrayFromFilesProperty];
+	const rootDir = pkgDir.sync();
+	for (const glob of globArrayFromFilesProperty) {
+		try {
+			if (fs.statSync(path.resolve(rootDir, glob)).isDirectory()) {
+				globArrayForFilesAndDirs.push(`${glob}/**/*`);
+			}
+		} catch (_) {}
+	}
+
+	return fileList.filter(minimatch.filter(getIgnoredFilesGlob(globArrayForFilesAndDirs), {matchBase: true}));
+}
+
+function getIgnoredFilesGlob(globArrayFromFilesProperty) {
+	/* According to https://docs.npmjs.com/files/package.json#files
+	   npm's default behavior is to ignore these files. */
+	const filesIgnoredByDefault = ['.*.swp',
+		'.npmignore',
+		'._*',
+		'.DS_Store',
+		'.hg',
+		'.npmrc',
+		'.lock-wscript',
+		'.svn',
+		'.wafpickle-N',
+		'*.orig',
+		'config.gypi',
+		'CVS',
+		'node_modules/**/*',
+		'npm-debug.log',
+		'package-lock.json'];
+	return `!{${globArrayFromFilesProperty.join(',')},${filesIgnoredByDefault.join(',')}}`;
+}
+
+// Get all files which will be ignored by either `.npmignore` or the `files` property in `package.json` (if defined).
+exports.getNewAndUnpublishedFiles = async (globArrayFromFilesProperty, newFiles = []) => {
+	if (globArrayFromFilesProperty) {
+		return getFilesNotIncludedInFilesProperty(globArrayFromFilesProperty, newFiles);
+	}
+
+	if (npmignoreExistsInPackageRootDir()) {
+		return getFilesIgnoredByDotnpmignore(newFiles);
+	}
+};
+
 exports.getRegistryUrl = async (pkgManager, pkg) => {
 	const args = ['config', 'get', 'registry'];
 	if (exports.isExternalRegistry(pkg)) {

source/ui.js

@@ -49,6 +49,22 @@ const printCommitLog = async (repoUrl, registryUrl) => {
 	};
 };
 
+const checkIgnoredFiles = async pkg => {
+	const ignoredFiles = await util.getNewAndUnpublishedFiles(pkg);
+	if (ignoredFiles === undefined || ignoredFiles.length === 0) {
+		return true;
+	}
+
+	const answers = await inquirer.prompt([{
+		type: 'confirm',
+		name: 'confirm',
+		message: `The following new files are not part of your published package:\n${chalk.reset(ignoredFiles.map(path => `- ${path}`).join('\n'))}\nContinue?`,
+		default: false
+	}]);
+
+	return answers;
+};
+
 module.exports = async (options, pkg) => {
 	const oldVersion = pkg.version;
 	const extraBaseUrls = ['gitlab.com'];
@@ -59,6 +75,13 @@ module.exports = async (options, pkg) => {
 
 	if (runPublish) {
 		checkIgnoreStrategy(pkg);
+		const answerIgnoredFiles = await checkIgnoredFiles(pkg);
+		if (answerIgnoredFiles.confirm === false) {
+			return {
+				...options,
+				...answerIgnoredFiles
+			};
+		}
 	}
 
 	console.log(`\nPublish a new version of ${chalk.bold.magenta(pkg.name)} ${chalk.dim(`(current: ${oldVersion})`)}\n`);

source/util.js

@@ -6,6 +6,8 @@ const execa = require('execa');
 const pMemoize = require('p-memoize');
 const ow = require('ow');
 const pkgDir = require('pkg-dir');
+const gitUtil = require('./git-util');
+const npmUtil = require('./npm/util');
 
 exports.readPkg = (packagePath = pkgDir.sync()) => {
 	const {packageJson} = readPkgUp.sync({
@@ -66,3 +68,8 @@ exports.getTagVersionPrefix = pMemoize(async options => {
 		return 'v';
 	}
 });
+
+exports.getNewAndUnpublishedFiles = async pkg => {
+	const listNewFiles = await gitUtil.newFilesSinceLastRelease();
+	return npmUtil.getNewAndUnpublishedFiles(pkg.files, listNewFiles);
+};

test/fixtures/npmignore/.hg

@@ -0,0 +1 @@
+should be ignored by default

test/fixtures/npmignore/.npmignore

@@ -0,0 +1,2 @@
+ignore.txt
+test

test/fixtures/npmignore/source/ignore.txt

@@ -0,0 +1 @@
+Ignore this file

test/fixtures/npmignore/source/pay_attention.txt

@@ -0,0 +1 @@
+File is excluded from .npmignore

test/fixtures/npmignore/test/file.txt

@@ -0,0 +1 @@
+ignore this file

test/fixtures/package/.hg

@@ -0,0 +1 @@
+should be ignored by default

test/fixtures/package/package.json

@@ -0,0 +1,3 @@
+{
+	"files": ["pay_attention.txt"]
+}

test/fixtures/package/source/ignore.txt

@@ -0,0 +1 @@
+File is excluded from package.json

test/fixtures/package/source/pay_attention.txt

@@ -0,0 +1 @@
+File in included in package.json

test/fixtures/readme.md

@@ -0,0 +1,2 @@
+The directory is for the resources
+in the script npmignore.js

test/npmignore.js

@@ -0,0 +1,78 @@
+import path from 'path';
+import test from 'ava';
+import mockery from 'mockery';
+import sinon from 'sinon';
+
+let testedModule;
+
+const gitUtilApi = {
+	newFilesSinceLastRelease: async () => {}
+};
+
+const pkgDirApi = {
+	sync: () => {}
+};
+
+test.before(() => {
+	const stubGitUtil = sinon.stub(gitUtilApi, 'newFilesSinceLastRelease');
+
+	mockery.registerAllowable('../source/util');
+	mockery.registerAllowable('../source/npm/util');
+	mockery.registerMock('./git-util', gitUtilApi);
+	mockery.registerMock('pkg-dir', pkgDirApi);
+
+	stubGitUtil.returns(['source/ignore.txt', 'source/pay_attention.txt', '.hg', 'test/file.txt']);
+
+	mockery.enable({
+		useCleanCache: true,
+		warnOnReplace: false,
+		warnOnUnregistered: false
+	});
+
+	// Mockery has to setup before module is loaded
+	testedModule = require('../source/util');
+});
+
+test.after(() => {
+	mockery.deregisterAll();
+	mockery.disable();
+});
+
+test.serial('ignored files using file-attribute in package.json with one file', async t => {
+	const stubPkgDir = sinon.stub();
+	stubPkgDir.returns(path.resolve('test', 'fixtures', 'package'));
+	pkgDirApi.sync = stubPkgDir;
+	t.deepEqual(await testedModule.getNewAndUnpublishedFiles({files: ['pay_attention.txt']}),
+		['source/ignore.txt', 'test/file.txt']);
+});
+
+test.serial('ignored files using file-attribute in package.json with multiple file', async t => {
+	const stubPkgDir = sinon.stub();
+	stubPkgDir.returns(path.resolve('test', 'fixtures', 'package'));
+	pkgDirApi.sync = stubPkgDir;
+	t.deepEqual(await testedModule.getNewAndUnpublishedFiles(
+		{files: ['pay_attention.txt', 'ignore.txt']}), ['test/file.txt']);
+});
+
+test.serial('ignored file using file-attribute in package.json with directory', async t => {
+	const stubPkgDir = sinon.stub();
+	stubPkgDir.returns(path.resolve('test', 'fixtures', 'package'));
+	pkgDirApi.sync = stubPkgDir;
+	t.deepEqual(await testedModule.getNewAndUnpublishedFiles(
+		{files: ['source']}), ['test/file.txt']);
+});
+
+test.serial('ignored files using .npmignore', async t => {
+	const stubPkgDir = sinon.stub();
+	stubPkgDir.returns(path.resolve('test', 'fixtures', 'npmignore'));
+	pkgDirApi.sync = stubPkgDir;
+	t.deepEqual(await testedModule.getNewAndUnpublishedFiles({name: 'without file-attribute'}),
+		['source/ignore.txt', 'test/file.txt']);
+});
+
+test.serial('ignore strategy is not used', async t => {
+	const stubPkgDir = sinon.stub();
+	stubPkgDir.returns(path.resolve('test', 'fixtures'));
+	pkgDirApi.sync = stubPkgDir;
+	t.true(await testedModule.getNewAndUnpublishedFiles({name: 'without file-attribute'}) === undefined);
+});