new: Support a bundle config option. (#38)

* Add option. * Update tests. * Update docs.
milesj · Mar 9, 2021 · bb4844e · bb4844e
1 parent 8e773d1
commit bb4844e
Show file tree

Hide file tree

Showing 11 changed files with 97 additions and 24 deletions.
diff --git a/src/Package.ts b/src/Package.ts
@@ -184,6 +184,7 @@ export class Package {
       });
 
       toArray(config.platform).forEach((platform) => {
+        let bundle = true;
         let formats = [...toArray(config.format)];
         const isEmpty = formats.length === 0;
 
@@ -197,6 +198,8 @@ export class Package {
             break;
 
           case 'node':
+            bundle = false;
+
             if (isEmpty) {
               formats.push('lib');
             } else {
@@ -220,6 +223,7 @@ export class Package {
         }
 
         this.configs.push({
+          bundle: cfg.bundle === undefined ? bundle : config.bundle,
           formats,
           inputs: config.inputs,
           namespace: config.namespace,

diff --git a/src/Packemon.ts b/src/Packemon.ts
@@ -206,6 +206,7 @@ export class Packemon {
             pkg,
             // Pass platform and support here for convenience
             config.formats.map((format) => ({
+              bundle: config.bundle,
               format,
               platform: config.platform,
               support: config.support,

diff --git a/src/rollup/config.ts b/src/rollup/config.ts
@@ -88,11 +88,11 @@ export function getRollupOutputConfig(
   features: FeatureFlags,
   build: BundleBuild,
 ): OutputOptions {
-  const { format, platform, support } = build;
+  const { bundle = true, format, platform, support } = build;
   const name = artifact.outputName;
   const { ext, folder } = artifact.getOutputMetadata(format);
-  const isNode = platform === 'node';
   const isTest = process.env.NODE_ENV === 'test';
+  const preserve = !bundle;
 
   const output: OutputOptions = {
     dir: artifact.package.path.append(folder).path(),
@@ -102,10 +102,9 @@ export function getRollupOutputConfig(
     paths: getRollupPaths(artifact, ext),
     // Use our extension for file names
     assetFileNames: '../assets/[name]-[hash][extname]',
-    chunkFileNames: isNode && !isTest ? `[name]-[hash].${ext}` : `${name}-[hash].${ext}`,
-    entryFileNames: isNode && !isTest ? `[name].${ext}` : `${name}.${ext}`,
-    // Dont bundle to a single file when targeting node
-    preserveModules: isNode,
+    chunkFileNames: preserve && !isTest ? `[name]-[hash].${ext}` : `${name}-[hash].${ext}`,
+    entryFileNames: preserve && !isTest ? `[name].${ext}` : `${name}.${ext}`,
+    preserveModules: preserve,
     // Use const when not supporting new targets
     preferConst: support === 'current' || support === 'experimental',
     // Output specific plugins

diff --git a/src/schemas.ts b/src/schemas.ts
@@ -58,6 +58,7 @@ const support = string<Support>(DEFAULT_SUPPORT).oneOf(SUPPORTS);
 // BLUEPRINTS
 
 export const packemonBlueprint: Blueprint<PackemonPackageConfig> = {
+  bundle: bool(true),
   format: union([array(format), format], []),
   inputs: object(string(), { index: DEFAULT_INPUT }).custom((obj) => {
     Object.keys(obj).forEach((key) => {

diff --git a/src/types.ts b/src/types.ts
@@ -58,6 +58,7 @@ export type DeclarationType = 'api' | 'none' | 'standard';
 // PACKAGES
 
 export interface PackemonPackageConfig {
+  bundle?: boolean;
   format?: Format | Format[];
   inputs?: Record<string, string>;
   namespace?: string;
@@ -70,6 +71,7 @@ export interface PackemonPackage extends PackageStructure {
 }
 
 export interface PackageConfig {
+  bundle: boolean;
   formats: Format[];
   inputs: Record<string, string>;
   namespace: string;
@@ -116,6 +118,7 @@ export interface BuildResult {
 }
 
 export interface BundleBuild {
+  bundle?: boolean;
   format: Format;
   platform: Platform;
   support: Support;

diff --git a/tests/Package.test.ts b/tests/Package.test.ts
@@ -896,6 +896,7 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib', 'esm'],
           inputs: {},
           platform: 'browser',
@@ -918,6 +919,7 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib', 'esm', 'umd'],
           inputs: {},
           platform: 'browser',
@@ -940,6 +942,7 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib'],
           inputs: {},
           platform: 'native',
@@ -962,6 +965,7 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: false,
           formats: ['lib'],
           inputs: {},
           platform: 'node',
@@ -984,6 +988,7 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: false,
           formats: ['cjs', 'mjs'],
           inputs: {},
           platform: 'node',
@@ -1003,13 +1008,15 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib', 'esm'],
           inputs: {},
           platform: 'browser',
           namespace: '',
           support: 'stable',
         },
         {
+          bundle: false,
           formats: ['lib'],
           inputs: {},
           platform: 'node',
@@ -1030,20 +1037,23 @@ describe('Package', () => {
 
       expect(pkg.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib', 'esm'],
           inputs: {},
           platform: 'browser',
           namespace: '',
           support: 'stable',
         },
         {
+          bundle: false,
           formats: ['lib', 'cjs'],
           inputs: {},
           platform: 'node',
           namespace: '',
           support: 'stable',
         },
         {
+          bundle: true,
           formats: ['lib'],
           inputs: {},
           platform: 'native',
@@ -1053,6 +1063,38 @@ describe('Package', () => {
       ]);
     });
 
+    it('can override `bundle` defaults', () => {
+      pkg.setConfigs([
+        {
+          bundle: true,
+          platform: 'node',
+        },
+        {
+          bundle: false,
+          platform: 'browser',
+        },
+      ]);
+
+      expect(pkg.configs).toEqual([
+        {
+          bundle: true,
+          formats: ['lib'],
+          inputs: { index: 'src/index.ts' },
+          platform: 'node',
+          namespace: '',
+          support: 'stable',
+        },
+        {
+          bundle: false,
+          formats: ['lib', 'esm'],
+          inputs: { index: 'src/index.ts' },
+          platform: 'browser',
+          namespace: '',
+          support: 'stable',
+        },
+      ]);
+    });
+
     it('errors if invalid format is provided for `browser` platform', () => {
       expect(() => {
         pkg.setConfigs([

diff --git a/tests/Packemon.test.ts b/tests/Packemon.test.ts
@@ -326,30 +326,30 @@ describe('Packemon', () => {
       expect((packages[0].artifacts[0] as BundleArtifact).outputName).toBe('index');
       expect((packages[0].artifacts[0] as BundleArtifact).inputFile).toBe('src/index.ts');
       expect(packages[0].artifacts[0].builds).toEqual([
-        { format: 'lib', platform: 'node', support: 'stable' },
+        { bundle: false, format: 'lib', platform: 'node', support: 'stable' },
       ]);
 
       expect((packages[0].artifacts[1] as BundleArtifact).outputName).toBe('index');
       expect((packages[0].artifacts[1] as BundleArtifact).inputFile).toBe('src/index.ts');
       expect(packages[0].artifacts[1].builds).toEqual([
-        { format: 'lib', platform: 'browser', support: 'current' },
-        { format: 'esm', platform: 'browser', support: 'current' },
+        { bundle: true, format: 'lib', platform: 'browser', support: 'current' },
+        { bundle: true, format: 'esm', platform: 'browser', support: 'current' },
       ]);
 
       expect(packages[1].artifacts).toHaveLength(1);
       expect((packages[1].artifacts[0] as BundleArtifact).outputName).toBe('core');
       expect((packages[1].artifacts[0] as BundleArtifact).inputFile).toBe('./src/core.ts');
       expect(packages[1].artifacts[0].builds).toEqual([
-        { format: 'lib', platform: 'node', support: 'stable' },
+        { bundle: false, format: 'lib', platform: 'node', support: 'stable' },
       ]);
 
       expect(packages[2].artifacts).toHaveLength(1);
       expect((packages[2].artifacts[0] as BundleArtifact).outputName).toBe('index');
       expect((packages[2].artifacts[0] as BundleArtifact).inputFile).toBe('src/index.ts');
       expect(packages[2].artifacts[0].builds).toEqual([
-        { format: 'lib', platform: 'browser', support: 'stable' },
-        { format: 'esm', platform: 'browser', support: 'stable' },
-        { format: 'umd', platform: 'browser', support: 'stable' },
+        { bundle: true, format: 'lib', platform: 'browser', support: 'stable' },
+        { bundle: true, format: 'esm', platform: 'browser', support: 'stable' },
+        { bundle: true, format: 'umd', platform: 'browser', support: 'stable' },
       ]);
     });
 
@@ -427,12 +427,12 @@ describe('Packemon', () => {
       packemon.generateArtifacts(packages);
 
       expect(packages[0].artifacts[0].builds).toEqual([
-        { format: 'lib', platform: 'browser', support: 'stable' },
-        { format: 'esm', platform: 'browser', support: 'stable' },
+        { bundle: true, format: 'lib', platform: 'browser', support: 'stable' },
+        { bundle: true, format: 'esm', platform: 'browser', support: 'stable' },
       ]);
 
       expect(packages[0].artifacts[1].builds).toEqual([
-        { format: 'lib', platform: 'node', support: 'stable' },
+        { bundle: false, format: 'lib', platform: 'node', support: 'stable' },
       ]);
     });
   });
@@ -463,13 +463,15 @@ describe('Packemon', () => {
       expect(one.getName()).toBe('pkg-valid-array');
       expect(one.configs).toEqual([
         {
+          bundle: false,
           formats: ['lib'],
           inputs: { index: 'src/index.ts' },
           namespace: '',
           platform: 'node',
           support: 'stable',
         },
         {
+          bundle: true,
           formats: ['lib', 'esm'],
           inputs: { index: 'src/index.ts' },
           namespace: '',
@@ -481,6 +483,7 @@ describe('Packemon', () => {
       expect(two.getName()).toBe('pkg-valid-object');
       expect(two.configs).toEqual([
         {
+          bundle: false,
           formats: ['lib'],
           inputs: { core: './src/core.ts' },
           namespace: '',
@@ -492,6 +495,7 @@ describe('Packemon', () => {
       expect(three.getName()).toBe('pkg-valid-object-private');
       expect(three.configs).toEqual([
         {
+          bundle: true,
           formats: ['lib', 'esm', 'umd'],
           inputs: { index: 'src/index.ts' },
           namespace: 'Test',

diff --git a/tests/helpers.ts b/tests/helpers.ts
@@ -94,6 +94,7 @@ FORMATS.forEach((format) => {
       }
 
       builds.set(key, {
+        bundle: platform !== 'node',
         format,
         platform,
         support,

diff --git a/tests/rollup/config.test.ts b/tests/rollup/config.test.ts
@@ -104,10 +104,10 @@ describe('getRollupConfig()', () => {
 
   it('generates an output config for each build', () => {
     artifact.builds.push(
-      { format: 'lib', platform: 'node', support: 'stable' },
-      { format: 'lib', platform: 'browser', support: 'legacy' },
-      { format: 'esm', platform: 'browser', support: 'current' },
-      { format: 'mjs', platform: 'node', support: 'experimental' },
+      { bundle: false, format: 'lib', platform: 'node', support: 'stable' },
+      { bundle: true, format: 'lib', platform: 'browser', support: 'legacy' },
+      { bundle: true, format: 'esm', platform: 'browser', support: 'current' },
+      { bundle: false, format: 'mjs', platform: 'node', support: 'experimental' },
     );
 
     expect(getRollupConfig(artifact, {})).toEqual({
@@ -188,7 +188,7 @@ describe('getRollupConfig()', () => {
     artifact.outputName = 'server';
     artifact.platform = 'node';
     artifact.support = 'stable';
-    artifact.builds.push({ format: 'lib', platform: 'node', support: 'stable' });
+    artifact.builds.push({ bundle: false, format: 'lib', platform: 'node', support: 'stable' });
 
     expect(getRollupConfig(artifact, {})).toEqual({
       cache: undefined,
@@ -299,7 +299,11 @@ describe('getRollupOutputConfig()', () => {
 
   it('generates default output config', () => {
     expect(
-      getRollupOutputConfig(artifact, {}, { format: 'lib', platform: 'node', support: 'stable' }),
+      getRollupOutputConfig(
+        artifact,
+        {},
+        { bundle: false, format: 'lib', platform: 'node', support: 'stable' },
+      ),
     ).toEqual({
       assetFileNames: '../assets/[name]-[hash][extname]',
       banner: expect.any(String),

diff --git a/website/docs/config.md b/website/docs/config.md
@@ -63,7 +63,7 @@ To support multiple platforms, pass an array.
 }
 ```
 
-> In the future, we hope to support other platforms like Electron and React Native.
+> In the future, we hope to support other platforms like Electron.
 
 ## Support
 
@@ -160,6 +160,20 @@ need to configure this.
 > These inputs can be automatically mapped to `package.json` `exports` using the `--addExports` CLI
 > option. Do note that this feature is still experimental.
 
+## Bundle
+
+Whether to bundle the source code into a single file by input. If not provided, is `false` for
+`node` platform, but `true` for all other platforms.
+
+```json
+{
+  "bundle": false
+}
+```
+
+> Prefer the defaults as much as possible. The only time this setting should change is if the
+> package should allow deep imports. For example, a component library.
+
 ## Namespace
 
 For browsers only, this would be the name of the UMD global variable.

diff --git a/website/docs/pack.md b/website/docs/pack.md
@@ -25,4 +25,4 @@ aborted.
 ## Options
 
 Pack supports all the same command line options as [`build`](./build.md). The validation step cannot
-be customized and will vaidate _everything_ by default.
+be customized and will validate _everything_ by default.