@haptiq/kit 0.5.0 → 0.7.0

package/README.md

@@ -52,71 +52,38 @@ kit js --skip <name>   # skip a named config (multi-config mode)
 
 **Defaults:** reads `src/**/*.js`, writes to `js/bundle.js`.
 
-## Configuration
+---
 
-Create a `haptiq.config.js` in your project root. All options are optional.
-
-```js
-module.exports = {
-  css: {
-    src: 'assets/**/*.{scss,sass,css}',  // default: 'src/**/*.{scss,sass,css}'
-    dest: 'public/css',                  // default: 'css'
-    sass: {
-      style: 'expanded',
-      includePaths: ['node_modules'],
-    },
-    lightning: {
-      targets: { chrome: 90, firefox: 88, safari: 14 },
-      minify: true,
-      sourceMap: true,
-    },
-  },
-
-  // Combine mode — all files into one output
-  js: {
-    src: 'assets/**/*.js',       // default: 'src/**/*.js'
-    dest: 'public/js/bundle.js', // default: 'js/bundle.js'
-    terser: {
-      compress: {
-        drop_console: true,
-        drop_debugger: true,
-      },
-      format: {
-        comments: false,
-      },
-    },
-  },
-};
-```
+### `kit ship [target]`
 
-### Multiple JS configs
-
-Use `js.configs` to define several named configurations:
-
-```js
-module.exports = {
-  js: {
-    configs: {
-      'app': {
-        src: 'src/app/**/*.js',
-        dest: 'public/js/app.bundle.js',
-      },
-      'components': {
-        src: 'src/components/**/*.js',
-        dest: 'public/js/components/',
-      },
-    },
-  },
-};
-```
-
-Then use `--only` / `--skip` to target specific configs:
+Builds CSS and JS assets, then syncs them to a destination via rsync or packages them as a zip archive.
 
 ```sh
-kit js --only app
-kit js --skip components
+kit ship              # prompts you to choose a target
+kit ship staging      # ship to a specific named target
+kit ship dist         # built-in local target (always available, no config needed)
+kit ship --dev        # build without minification before shipping
+kit ship --verbose    # show detailed rsync/zip output
 ```
 
+When called without a target name, the command lists all configured targets and asks you to choose one before proceeding. To skip the prompt, pass the target name directly.
+
+`kit ship dist` syncs the project to a sibling directory (`../project-name-dist/`) and is always available without any configuration.
+
+**Target types**
+
+| Type | Config | Behaviour |
+|---|---|---|
+| Remote | `host` + `dest` | rsyncs `src` to `host:dest` |
+| Local | neither | rsyncs `src` to `../project-name-dist/` (same as `kit ship dist`) |
+| Zip | `zip` path | packages `src` into a zip archive |
+
+`zip` is mutually exclusive with `host` and `dest`. The zip destination directory must exist; the command aborts if the archive already exists (remove it manually to re-ship).
+
+## Configuration
+
+Create a `haptiq.config.js` in your project root. All options are optional. See [`examples/haptiq.config.js`](examples/haptiq.config.js) for a full annotated reference.
+
 ## License
 
 GPL-2.0-or-later

package/bin/haptiq.kit.js

@@ -87,6 +87,14 @@ async function loadConfig(verbose = false) {
 				throw new Error('ship configuration must be an object');
 			}
 
+			if (config.ship.src !== undefined && (typeof config.ship.src !== 'string' || config.ship.src.trim() === '')) {
+				throw new Error('ship.src must be a non-empty string');
+			}
+
+			if (config.ship.exclude !== undefined && !Array.isArray(config.ship.exclude)) {
+				throw new Error('ship.exclude must be an array');
+			}
+
 			if (config.ship.targets) {
 				if (typeof config.ship.targets !== 'object' || Array.isArray(config.ship.targets)) {
 					throw new Error('ship.targets must be an object');
@@ -102,6 +110,15 @@ async function loadConfig(verbose = false) {
 					if (targetConfig.dev !== undefined && typeof targetConfig.dev !== 'boolean') {
 						throw new Error(`ship.targets.${targetName}.dev must be a boolean (true or false, not a string)`);
 					}
+					if (targetConfig.zip !== undefined && typeof targetConfig.zip !== 'string') {
+						throw new Error(`ship.targets.${targetName}.zip must be a string`);
+					}
+					if (targetConfig.zip && targetConfig.host) {
+						throw new Error(`ship.targets.${targetName}: "zip" and "host" are mutually exclusive`);
+					}
+					if (targetConfig.zip && targetConfig.dest) {
+						throw new Error(`ship.targets.${targetName}: "zip" and "dest" are mutually exclusive`);
+					}
 				}
 			}
 		}
@@ -134,8 +151,8 @@ async function loadConfig(verbose = false) {
  */
 function createCommandHandler(taskName, taskFunction) {
 	return async (...args) => {
-		const options = args[args.length - 1];
-		const positionalArgs = args.slice(0, -1);
+		const options = args[args.length - 2];
+		const positionalArgs = args.slice(0, -2);
 		try {
 			const config = await loadConfig(options.verbose);
 			await taskFunction(config, options, ...positionalArgs);

package/lib/ship.js

@@ -6,9 +6,11 @@
  * under the `ship` key.
  */
 import { spawn } from 'child_process';
-import { existsSync } from 'fs';
+import { existsSync, readFileSync, writeFileSync } from 'fs';
 import readline from 'readline';
 import path from 'path';
+import { glob } from 'glob';
+import { zipSync } from 'fflate';
 import { buildCSS } from './css.js';
 import { buildJS } from './js.js';
 
@@ -45,22 +47,96 @@ async function ship(config, verbose, options = {}) {
 		if (configuredTargetNames.length === 0) {
 			throw new Error('No ship targets configured. Add a ship.targets object to haptiq.config.js, or run `kit ship dist` for a local build.');
 		}
-		targetsToProcess = configuredTargetNames;
+		const selected = await promptTarget(configuredTargetNames);
+		targetsToProcess = [selected];
 	}
 
 	for (const name of targetsToProcess) {
 		const targetConfig = targets[name] ?? {};
-		const dev = cliDev || targetConfig.dev || false;
+		const dev = (cliDev ?? targetConfig.dev) ?? false;
 
 		await buildCSS(config, verbose, dev);
 		await buildJS(config, verbose, { dev });
-		await shipSingleTarget(name, targetConfig, { src, exclude, deleteRemoved }, verbose);
+
+		if (targetConfig.zip) {
+			await zipSingleTarget(name, targetConfig, { src, exclude }, verbose);
+		} else {
+			await shipSingleTarget(name, targetConfig, { src, exclude, deleteRemoved }, verbose);
+		}
 
 		console.log(`✅ Shipped to [${name}].`);
 	}
 }
 
 
+/**
+ * Zip a single target — builds a zip archive at the configured path.
+ * Aborts if the destination directory does not exist or the zip file already exists.
+ *
+ * @param {string} name - Target name (for log messages)
+ * @param {{ zip: string }} targetConfig - Target settings
+ * @param {{ src: string, exclude: string[] }} shipConfig - Shared settings
+ * @param {boolean} verbose - List each file added to the archive
+ * @returns {Promise<void>}
+ */
+async function zipSingleTarget(name, targetConfig, shipConfig, verbose) {
+	const { zip: zipPathTemplate } = targetConfig;
+	const { src = './', exclude = [] } = shipConfig;
+
+	const projectRoot = process.cwd();
+	const projectName = path.basename(projectRoot);
+
+	let version = '0.0.0';
+	const pkgPath = path.join(projectRoot, 'package.json');
+	if (existsSync(pkgPath)) {
+		try {
+			const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
+			version = pkg.version ?? version;
+		} catch { /* use default */ }
+	}
+
+	const resolvedZipPath = zipPathTemplate
+		.replace(/\{name\}/g, projectName)
+		.replace(/\{version\}/g, version);
+
+	const zipDir = path.dirname(resolvedZipPath);
+	if (!existsSync(zipDir)) {
+		throw new Error(`Destination directory does not exist: ${zipDir}\nCreate it manually before shipping.`);
+	}
+
+	if (existsSync(resolvedZipPath)) {
+		throw new Error(`Zip archive already exists: ${resolvedZipPath}\nRemove it manually before shipping to avoid accidental overwrites.`);
+	}
+
+	const resolvedSrc = path.resolve(projectRoot, src);
+
+	const globIgnore = exclude.flatMap(e => {
+		const stripped = e.replace(/\/$/, '');
+		return [stripped, `${stripped}/**`];
+	});
+
+	console.log(`📦 Packing [${name}] → ${resolvedZipPath}`);
+
+	const files = await glob('**', {
+		cwd: resolvedSrc,
+		dot: true,
+		nodir: true,
+		ignore: globIgnore,
+	});
+
+	const zipData = {};
+	for (const file of files) {
+		if (verbose) {
+			process.stdout.write(`  ${file}\n`);
+		}
+		zipData[`${projectName}/${file}`] = readFileSync(path.join(resolvedSrc, file));
+	}
+
+	const zipped = zipSync(zipData);
+	writeFileSync(resolvedZipPath, zipped);
+}
+
+
 /**
  * Rsync a single target
  *
@@ -143,11 +219,13 @@ function rsyncDryRun(args) {
 
 		let stdout = '';
 		let stderr = '';
+		let rejected = false;
 
 		childProcess.stdout.on('data', (data) => { stdout += data.toString(); });
 		childProcess.stderr.on('data', (data) => { stderr += data.toString(); });
 
 		childProcess.on('close', (code) => {
+			if (rejected) return;
 			if (code === 0) {
 				const deletions = stdout
 					.split('\n')
@@ -160,6 +238,7 @@ function rsyncDryRun(args) {
 		});
 
 		childProcess.on('error', (err) => {
+			rejected = true;
 			if (err.code === 'ENOENT') {
 				reject(new Error('rsync not found. Please ensure rsync is installed on your system.'));
 			} else {
@@ -203,15 +282,46 @@ async function confirmDeletion(deletions, destination) {
 }
 
 
+/**
+ * Prompt the user to choose a ship target from the available options.
+ * Accepts either the target name or its list number.
+ *
+ * @param {string[]} configuredTargetNames - Target names from haptiq.config.js
+ * @returns {Promise<string>} The chosen target name
+ */
+async function promptTarget(configuredTargetNames) {
+	const options = [...configuredTargetNames, 'dist'];
+
+	console.log('\nNo target specified. Choose one of the available targets to ship to:\n');
+	options.forEach((name, i) => {
+		console.log(`  ${i + 1}) ${name}`);
+	});
+
+	const answer = (await readLine('\nTarget: ')).trim();
+
+	const num = parseInt(answer, 10);
+	if (!isNaN(num) && num >= 1 && num <= options.length) {
+		return options[num - 1];
+	}
+
+	if (options.includes(answer)) {
+		return answer;
+	}
+
+	throw new Error(`"${answer}" is not a valid target. Run \`kit ship <target>\` to skip this prompt.`);
+}
+
+
 /**
  * Read a single line from stdin.
  *
+ * @param {string} prompt - Text to display before waiting for input
  * @returns {Promise<string>}
  */
-function readLine() {
+function readLine(prompt = '') {
 	return new Promise((resolve) => {
 		const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-		rl.question('', (answer) => {
+		rl.question(prompt, (answer) => {
 			rl.close();
 			resolve(answer);
 		});
@@ -231,6 +341,7 @@ function spawnRsync(args, verbose) {
 		const childProcess = spawn('rsync', args, { shell: false });
 
 		let stderr = '';
+		let rejected = false;
 
 		if (verbose) {
 			childProcess.stdout.on('data', (data) => process.stdout.write(data));
@@ -241,6 +352,7 @@ function spawnRsync(args, verbose) {
 		});
 
 		childProcess.on('close', (code) => {
+			if (rejected) return;
 			if (code === 0) {
 				resolve();
 			} else {
@@ -249,6 +361,7 @@ function spawnRsync(args, verbose) {
 		});
 
 		childProcess.on('error', (err) => {
+			rejected = true;
 			if (err.code === 'ENOENT') {
 				reject(new Error('rsync not found. Please ensure rsync is installed on your system.'));
 			} else {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@haptiq/kit",
-	"version": "0.5.0",
+	"version": "0.7.0",
 	"description": "Build tools for Haptiq projects.",
 	"keywords": [
 		"build",
@@ -24,6 +24,7 @@
 		"@haptiq/browserslist-config": "^0.1.0",
 		"browserslist": "^4.28.2",
 		"commander": "^15.0.0",
+		"fflate": "^0.8.0",
 		"glob": "^13.0.6",
 		"lightningcss": "^1.32.0",
 		"sass": "^1.101.0",