new: Support an addFiles option. (#93)

* Add flag. * Update impl. * Update docs. * Drop down dep.
milesj · Dec 19, 2021 · 12e203b · 12e203b
1 parent 4b057e4
commit 12e203b
Show file tree

Hide file tree

Showing 13 changed files with 185 additions and 222 deletions.
diff --git a/packages/packemon/package.json b/packages/packemon/package.json
@@ -86,7 +86,7 @@
     "resolve": "^1.20.0",
     "rimraf": "^3.0.2",
     "rollup": "^2.61.1",
-    "rollup-plugin-node-externals": "^3.1.2",
+    "rollup-plugin-node-externals": "^2.2.0",
     "rollup-plugin-polyfill-node": "^0.8.0",
     "rollup-plugin-visualizer": "^5.5.2",
     "semver": "^7.3.5",

diff --git a/packages/packemon/src/Package.ts b/packages/packemon/src/Package.ts
@@ -101,6 +101,11 @@ export class Package {
 			this.addExports();
 		}
 
+		// Add package `files` whitelist
+		if (options.addFiles) {
+			this.addFiles();
+		}
+
 		// Sync `package.json` in case it was modified
 		await this.syncPackageJson();
 	}
@@ -373,7 +378,6 @@ export class Package {
 		let mainEntry = '';
 		let moduleEntry = '';
 		let browserEntry = '';
-		const files = new Set<string>(this.packageJson.files);
 
 		// eslint-disable-next-line complexity
 		this.artifacts.forEach((artifact) => {
@@ -406,19 +410,11 @@ export class Package {
 				) {
 					this.packageJson.bin = artifact.findEntryPoint(['lib', 'cjs', 'mjs'], 'bin');
 				}
-
-				// Generate `files` list
-				artifact.builds.forEach(({ format }) => {
-					files.add(`${format}/**/*.{${artifact.getBuildOutput(format).ext},map}`);
-				});
-
-				files.add(`src/**/*.{${this.getSourceFileExts(artifact.inputs)}}`);
 			}
 
 			// Type declarations
 			if (artifact instanceof TypesArtifact) {
 				this.packageJson.types = artifact.findEntryPoint('index');
-				files.add('dts/**/*.d.ts');
 			}
 		});
 
@@ -439,8 +435,6 @@ export class Package {
 		if (browserEntry && !isObject(this.packageJson.browser)) {
 			this.packageJson.browser = browserEntry;
 		}
-
-		this.packageJson.files = [...files].sort();
 	}
 
 	protected addExports() {
@@ -471,6 +465,30 @@ export class Package {
 		}
 	}
 
+	protected addFiles() {
+		this.debug('Adding files to `package.json`');
+
+		const files = new Set<string>(this.packageJson.files);
+
+		this.artifacts.forEach((artifact) => {
+			// Build files
+			if (artifact instanceof CodeArtifact) {
+				artifact.builds.forEach(({ format }) => {
+					files.add(`${format}/**/*.{${artifact.getBuildOutput(format).ext},map}`);
+				});
+
+				files.add(`src/**/*.{${this.getSourceFileExts(artifact.inputs)}}`);
+			}
+
+			// Type declarations
+			if (artifact instanceof TypesArtifact) {
+				files.add('dts/**/*.d.ts');
+			}
+		});
+
+		this.packageJson.files = [...files].sort();
+	}
+
 	protected getSourceFileExts(inputs: InputMap): string[] {
 		const sourceExts = Object.values(inputs).map((inputFile) => new Path(inputFile).ext(true));
 		const exts = new Set(sourceExts);

diff --git a/packages/packemon/src/commands/Build.tsx b/packages/packemon/src/commands/Build.tsx
@@ -12,6 +12,9 @@ export class BuildCommand extends BaseCommand<Required<BuildOptions>> {
 	@Arg.Flag('Add `exports` fields to each `package.json`')
 	addExports: boolean = false;
 
+	@Arg.Flag('Add `files` whitelist to each `package.json`')
+	addFiles: boolean = true;
+
 	@Arg.String('Visualize and analyze all generated builds', {
 		choices: ['none', 'sunburst', 'treemap', 'network'],
 	})
@@ -38,6 +41,7 @@ export class BuildCommand extends BaseCommand<Required<BuildOptions>> {
 			<Build
 				addEngines={this.addEngines}
 				addExports={this.addExports}
+				addFiles={this.addFiles}
 				analyze={this.analyze}
 				concurrency={this.concurrency}
 				declaration={this.declaration}

diff --git a/packages/packemon/src/commands/Pack.tsx b/packages/packemon/src/commands/Pack.tsx
@@ -11,6 +11,7 @@ export class PackCommand extends BuildCommand {
 			<Pack
 				addEngines={this.addEngines}
 				addExports={this.addExports}
+				addFiles={this.addFiles}
 				analyze={this.analyze}
 				concurrency={this.concurrency}
 				declaration={this.declaration}

diff --git a/packages/packemon/src/schemas.ts b/packages/packemon/src/schemas.ts
@@ -73,6 +73,7 @@ export const packemonBlueprint: Blueprint<PackemonPackageConfig> = {
 export const buildBlueprint: Blueprint<BuildOptions> = {
 	addEngines: bool(),
 	addExports: bool(),
+	addFiles: bool(),
 	analyze: string('none').oneOf<AnalyzeType>(['none', 'sunburst', 'treemap', 'network']),
 	concurrency: number(1).gte(1),
 	declaration: string('none').oneOf<DeclarationType>(['none', 'standard', 'api']),

diff --git a/packages/packemon/src/types.ts b/packages/packemon/src/types.ts
@@ -117,6 +117,7 @@ export interface FilterOptions {
 export interface BuildOptions extends FilterOptions {
 	addEngines?: boolean;
 	addExports?: boolean;
+	addFiles?: boolean;
 	analyze?: AnalyzeType;
 	concurrency?: number;
 	declaration?: DeclarationType;