Merge pull request #1025 from microsoft:benibenj/well-lion

Don't package default readme if a path is provided and default is ignored
microsoft · Jul 18, 2024 · 3b1b774 · 3b1b774
2 parents 2e3e3bc + d83f7ba
commit 3b1b774
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/src/main.ts b/src/main.ts
@@ -74,8 +74,9 @@ module.exports = function (argv: string[]): void {
 		// default must remain undefined for dependencies or we will fail to load defaults from package.json
 		.option('--dependencies', 'Enable dependency detection via npm or yarn', undefined)
 		.option('--no-dependencies', 'Disable dependency detection via npm or yarn', undefined)
-		.action(({ tree, yarn, packagedDependencies, ignoreFile, dependencies }) =>
-			main(ls({ tree, useYarn: yarn, packagedDependencies, ignoreFile, dependencies }))
+		.option('--readme-path <path>', 'Path to README file (defaults to README.md)')
+		.action(({ tree, yarn, packagedDependencies, ignoreFile, dependencies, readmePath }) =>
+			main(ls({ tree, useYarn: yarn, packagedDependencies, ignoreFile, dependencies, readmePath }))
 		);
 
 	program

diff --git a/src/package.ts b/src/package.ts
@@ -1613,8 +1613,6 @@ const defaultIgnore = [
 	'**/.vscode-test-web/**',
 ];
 
-const notIgnored = ['!package.json', '!README.md'];
-
 async function collectAllFiles(
 	cwd: string,
 	dependencies: 'npm' | 'yarn' | 'none' | undefined,
@@ -1650,8 +1648,12 @@ function collectFiles(
 	dependencies: 'npm' | 'yarn' | 'none' | undefined,
 	dependencyEntryPoints?: string[],
 	ignoreFile?: string,
-	manifestFileIncludes?: string[]
+	manifestFileIncludes?: string[],
+	readmePath?: string,
 ): Promise<string[]> {
+	readmePath = readmePath ?? 'README.md';
+	const notIgnored = ['!package.json', `!${readmePath}`];
+
 	return collectAllFiles(cwd, dependencies, dependencyEntryPoints).then(files => {
 		files = files.filter(f => !/\r$/m.test(f));
 
@@ -1759,7 +1761,7 @@ export function collect(manifest: Manifest, options: IPackageOptions = {}): Prom
 	const ignoreFile = options.ignoreFile || undefined;
 	const processors = createDefaultProcessors(manifest, options);
 
-	return collectFiles(cwd, getDependenciesOption(options), packagedDependencies, ignoreFile, manifest.files).then(fileNames => {
+	return collectFiles(cwd, getDependenciesOption(options), packagedDependencies, ignoreFile, manifest.files, options.readmePath).then(fileNames => {
 		const files = fileNames.map(f => ({ path: util.filePathToVsixPath(f), localPath: path.join(cwd, f) }));
 
 		return processFiles(processors, files);
@@ -1918,6 +1920,7 @@ export interface IListFilesOptions {
 	readonly ignoreFile?: string;
 	readonly dependencies?: boolean;
 	readonly prepublish?: boolean;
+	readonly readmePath?: string;
 }
 
 /**
@@ -1931,7 +1934,7 @@ export async function listFiles(options: IListFilesOptions = {}): Promise<string
 		await prepublish(cwd, manifest, options.useYarn);
 	}
 
-	return await collectFiles(cwd, getDependenciesOption(options), options.packagedDependencies, options.ignoreFile, manifest.files);
+	return await collectFiles(cwd, getDependenciesOption(options), options.packagedDependencies, options.ignoreFile, manifest.files, options.readmePath);
 }
 
 interface ILSOptions {
@@ -1940,6 +1943,7 @@ interface ILSOptions {
 	readonly packagedDependencies?: string[];
 	readonly ignoreFile?: string;
 	readonly dependencies?: boolean;
+	readonly readmePath?: string;
 }
 
 /**