@polylith/builder 0.0.26 → 0.0.28

package/App.js

@@ -61,6 +61,8 @@ export default class App {
 		this.loadables = [];
 		this.featureIndexes = [];
 		this.configs = {};
+		this.manualChunkType = 'function';
+		this.manualChunks = [];
 	}
 
 	static fileToPath(filename) {
@@ -116,6 +118,107 @@ export default class App {
 		this.featureIndexes.push(main);
 	}
 
+	/**
+	 * Call this method to add a new manual chunk specifier. The type of the
+	 * parameter passed will determine how the specifier will be processed. If
+	 * the type differs from previously added types, then the previous
+	 * specifiers will be removed.
+	 *
+	 * @param {Object|Function|Array} spec the chunk name specifier to be added.
+	 */
+	addManualChunk(spec) {
+		var type = typeof spec === 'function' ? 'function' : 'object';
+		type = Array.isArray(spec) ? 'array' : type;
+
+		if (this.manualChunkType != type) {
+			console.warn(`addManualChunk of type ${type} will override previously set of type ${this.manualChunkType}`);
+			if (type === 'object') this.manualChunks = {}
+			else this.manualChunks === [];
+			this.manualChunkType = type;
+		}
+
+		if (type === 'function') {
+			this.manualChunks.unshift(spec);
+		} else if (type === 'array') {
+			var keys = Object.keys(spec);
+			spec.forEach(function(one) {
+				this.manualChunks.unshift(one);
+			}.bind(this));
+		} else if (type === 'object') {
+			var keys = Object.keys(spec);
+			keys.forEach(function(key) {
+				this.manualChunks[key] = spec[key];
+			}.bind(this));
+		}
+	}
+
+	/**
+	 * If no manual chunk specifiers are added, then this will be used as the
+	 * default.
+	 *
+	 * @param {String} id this is the filename of the current file being
+	 * 	processed by rollup
+	 *
+	 * @returns {String} the chunk name if there is a match
+	 */
+	defaultManualChunks(id) {
+		if (id.includes('node_modules')) {
+			return 'vendor';
+		}
+	}
+
+	/**
+	 * This is called when manual chunk specifications have been added as an
+	 * array.
+	 *
+	 * @param {String} id this is the filename of the current file being
+	 * 	processed by rollup
+	 * @returns {String} the name fo the chunk if there is a matching chunk
+	 * 	name specifier
+	 */
+	handleManualChunksArray(id) {
+		var fixId = App.fixPath(id);
+		var result = this.manualChunks.find(function(spec) {
+			return fixId.includes(spec.includes);
+		})
+
+		if (result) return result.name;
+	}
+
+	/**
+	 * This is called when the manual chunk specifiers are functions. Each
+	 * registered function is called in the reverse order to how they were
+	 * added.
+	 *
+	 * @param {String} id this is the filename of the current file being
+	 * 	processed by rollup
+	 * @returns the chunk name if any of the callbacks return one
+	 */
+	handleManualChunksCallbacks(id) {
+		var fixId = App.fixPath(id);
+		if (this.manualChunks.length === 0) {
+			return this.defaultManualChunks(fixId);
+		} else {
+			for (let idx = 0; idx < this.manualChunks.length; idx++) {
+				var result = this.manualChunks[idx](fixId);
+				if (result) return result;
+			}
+		}
+	}
+
+	/**
+	 * This is called by the builder to get the method to handle manual chunks
+	 * based on how they have been setup. The value returned from this funtion
+	 * will be the value set in the rollup options object.
+	 *
+	 * @returns {Object|Function} the value to assign to the manualChunk field.
+	 */
+	getManualChunks() {
+		if (this.manualChunkType === 'object') return this.manualChunks;
+		if (this.manualChunkType === 'array') return this.handleManualChunksArray.bind(this);
+		if (this.manualChunkType === 'function') return this.handleManualChunksCallbacks.bind(this);
+	}
+
 	/**
 	 * Call this method to add the feature to the app. Features are isolated
 	 * pieces of code that are not a direct dependency of the main application.
@@ -168,21 +271,27 @@ export default class App {
 		}
 	}
 
-	/* features will call this method if they want to add loadables
-
-	  name - name of the loadable that we be passed to the load method
-	  main - the relative path from the source folder to the entry point of the
-	    loadable.
-	  prefix - if given, the prefix on services created in this loadable.
-	    The start and ready methods will be called on these services
-	*/
+	/**
+	 *
+	 * @param {String} name unique name of the loadable that will be passed to
+	 * 	the load method
+	 * @param {String} main the relative path from the source folder to the entry
+	 * 	point of the loadable.
+	 * @param {String} [prefix] if given, the prefix on services created in
+	 * 	this loadable. When the loadable has been loaded, the start and ready
+	 *  methods will be called on all services starting with this prefix.
+	 */
 	addLoadable(name, main, prefix) {
 		var dest = path.posix.join(this.sourcePath, main);
-
-		console.log('addLoadable', {name, path: dest, prefix})
 		this.loadables.push({name, path: dest, prefix});
 	}
 
+	/**
+	 * build calls this method to create the rollup configuration object
+	 *
+	 * @returns {Object} rollup configuration object
+	 */
+
 	buildConfiguration() {
 		var input = [this.fullIndexPath];
 		this.loadables.forEach(function(path) {
@@ -194,6 +303,8 @@ export default class App {
 			replacement: `<script type="module" src="${this.index}"></script>`
 		}
 
+		var manualChunks = this.getManualChunks();
+
 		var config = {
 			input : {
 				input: input,
@@ -240,20 +351,15 @@ export default class App {
 						}
 						return '[name].js';
 					}.bind(this),
-					manualChunks: function(id) {
-						var fixId = App.fixPath(id);
-						if (fixId.includes('init.js')) {
-							return 'init.js';
-						}
-						if (id.includes('node_modules')) {
-							return 'vendor';
-						}
-					}.bind(this),
-					treeshake: {
-						moduleSideEffects: true
-					}
+					manualChunks: manualChunks,
 				},
-}
+			},
+			watch : {
+				watch: {
+					buildDelay: 250,
+					exclude: 'node_modules/**',
+				}
+			}
 		};
 
 		return config;
@@ -261,11 +367,27 @@ export default class App {
 
 	async build() {
 		await this.buildFeatures();
-		var config = this.buildConfiguration();
+		this.config = this.buildConfiguration();
 
-		const bundle = await rollup.rollup(config.input);
-		await bundle.generate(config.output);
-		await bundle.write(config.output);
+		const bundle = await rollup.rollup(this.config.input);
+		await bundle.generate(this.config.output);
+		await bundle.write(this.config.output);
 		await bundle.close();
 	}
+
+	watch() {
+		var watchConfig  = {
+			input: this.config.input,
+			output: this.config.output,
+			watch: this.config.watch,
+		}
+
+		const watcher = rollup.watch(watchConfig);
+
+		watcher.on('event', function({result}) {
+		  if (result) {
+			  result.close();
+		  }
+		}.bind(this));
+	}
 }

package/ConfigApp.js

@@ -15,7 +15,9 @@ export default class ConfigApp extends App {
         var source = index.template.source;
         var sourceFilename = path.basename(source);
         var destination = index.template.destination || path.join(dest, sourceFilename)
-        this.setHtmlTemplate(source, destination)
+        this.setHtmlTemplate(source, destination);
+
+        if (config.manualChunks) this.addManualChunks(config.manualChunks);
     }
 
     async getFeatures() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polylith/builder",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "The polylith builder",
   "main": "index.js",
   "type": "module",