@hubol/smooch 1.0.0-beta.2 → 1.0.0-beta.4

package/README.md

@@ -0,0 +1,54 @@
+Opinionated asset transformer and aggregator.
+
+----------------
+
+When creating computer games, certain assets need to be destructively transformed in order for the game engine to consume them. For example; textures must be packed into texture atlases, and sound files need to be converted to formats digestible by modern browsers. **smooch** supports transforming directories of assets based on configuration.
+
+In addition, it is much more pleasurable to work in environments with a type system. To this end, **smooch** supports generating code files from asset files using configurable template programs.
+
+## Usage
+
+<!-- smooch commands -->
+`smooch`
+
+Start in watch mode. Aggregates and transforms assets as file changes are detected.
+Probably should be used while developing!
+
+`smooch init`
+
+Initialize a **smooch.json** configuration file.
+
+`smooch copy-program <program> <dst>`
+
+Copy a default template JavaScript program **program** to **dst**. Available programs are
+- texture-pack
+- json-aggregate
+- audio-convert
+
+`smooch build`
+
+Aggregate and transform assets according to your **smooch.json**. Probably should be used on a CI server!
+
+`smooch init-native-deps`
+
+Produce a **smooch-native-deps.json** configuration file.
+This is for a bizarre subsystem that sidesteps your **package-lock.json**.
+You probably won't need to touch this!
+
+`smooch help`
+
+List these commands!
+<!-- smooch commands end -->
+
+## Design goals
+
+- Not slow
+- Simple installation
+- Zero dependencies
+- Informative console output
+- Watches directories
+- Recovers gracefully from IO errors
+- Supports configurable templates
+- Keeps a cache for faster start-up
+- Build tool agnostic
+- Config file with schema

package/index.js

@@ -61408,7 +61408,7 @@ class AudioFileConverter {
     constructor() { }
     static convert(srcFile, dstFile) {
         const start = now_1.Now.ms;
-        logger.log(`Converting ${chalk_1.default.blue(srcFile)}
+        logger.log(`Converting ${chalk_1.default.blue(srcFile)}
 => ${chalk_1.default.green(dstFile)}...`);
         return new Promise((resolve, reject) => {
             (0, fluent_ffmpeg_1.default)(this._ffmpegOptions)
@@ -61522,7 +61522,7 @@ function validateOptions(options) {
         if (convert.directory)
             continue;
         convert.directory = path_1.Path.Directory.create(fs_1.Fs.resolve(global_1.Global.cacheDir, makeDirectoryName(options.glob, (_a = convert.zip) !== null && _a !== void 0 ? _a : 'nozip', (0, hubhash_1.hubhash)(`${options.glob}%${convert.zip}`))));
-        logger.log(`Generated directory name in cache folder for audio conversion:
+        logger.log(`Generated directory name in cache folder for audio conversion:
 ${chalk_1.default.blue(options.glob)} -> ${chalk_1.default.white(convert.format)} -> ${chalk_1.default[convert.zip ? 'gray' : 'green'](convert.directory)}${convert.zip ? ` -> ${chalk_1.default.green(convert.zip)}` : ''}`);
     }
     return options;
@@ -61545,9 +61545,9 @@ function createZipFileGlobCommands(commands) {
         const previous = zipFilesToGlob[zipFile];
         const current = path_1.Path.Glob.create(command.directory, '**/*');
         if (previous && previous !== current) {
-            logger.warn(`Zip file ${zipFile} needs more than one glob to be created:
-- ${previous}
-- ${current}
+            logger.warn(`Zip file ${zipFile} needs more than one glob to be created:
+- ${previous}
+- ${current}
 This should not be possible!`);
         }
         zipFilesToGlob[zipFile] = current;
@@ -61785,10 +61785,10 @@ class ErrorPrinter {
             .join(', ');
         const properties = propertiesList ? `[ ${propertiesList} ]` : `<No Additional Properties>`;
         const stack = (_e = error === null || error === void 0 ? void 0 : error.stack) !== null && _e !== void 0 ? _e : '<No Stack>';
-        return `${chalk_1.default.gray `Constructor: `}${constructor}
-${chalk_1.default.gray `Name: `}${name}
-${chalk_1.default.gray `Message: `}${(0, indent_1.indent)(message, 'Message: '.length)}
-${chalk_1.default.gray `Properties: `}${properties}
+        return `${chalk_1.default.gray `Constructor: `}${constructor}
+${chalk_1.default.gray `Name: `}${name}
+${chalk_1.default.gray `Message: `}${(0, indent_1.indent)(message, 'Message: '.length)}
+${chalk_1.default.gray `Properties: `}${properties}
 ${chalk_1.default.gray `Stack: `}${(0, indent_1.indent)(stack, 'Stack: '.length)}`;
     }
 }
@@ -62067,14 +62067,14 @@ class Logger {
     }
     error(message, error) {
         if (error)
-            this._print('error', `${message}
+            this._print('error', `${message}
 ${error_printer_1.ErrorPrinter.toPrintable(error)}`, []);
         else
             this._print('error', message, []);
     }
     warn(message, error) {
         if (error)
-            this._print('warn', `${message}
+            this._print('warn', `${message}
 ${error_printer_1.ErrorPrinter.toPrintable(error)}`, []);
         else
             this._print('warn', message, []);
@@ -62253,7 +62253,7 @@ class NativeDependencies {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const configuredVersions = yield json_file_1.JsonFile.read(global_1.Global.nativeDepsJsonFile).catch(() => {
-                logger.log(`Could not read ${chalk_1.default.white(global_1.Global.nativeDepsJsonFile)}
+                logger.log(`Could not read ${chalk_1.default.white(global_1.Global.nativeDepsJsonFile)}
 This is fine unless you want to set explicit versions of native dependencies.`);
                 return NativeDependencies.defaultVersions;
             });
@@ -62640,7 +62640,7 @@ class JsTemplate {
                 }
             }
             try {
-                logger.log(`Rendering ${chalk_1.default.blue(this._srcFile)} with context ${chalk_1.default.magenta((0, describe_brief_1.describeBrief)(context))}
+                logger.log(`Rendering ${chalk_1.default.blue(this._srcFile)} with context ${chalk_1.default.magenta((0, describe_brief_1.describeBrief)(context))}
 => ${chalk_1.default.green(outputFile)}...`);
                 const text = yield this._render(context);
                 yield fs_1.Fs.writeFile(outputFile, text);
@@ -62867,7 +62867,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.runCliUtilCommand = void 0;
+exports.runCliUtilCommand = exports.getCommandMetadatas = void 0;
 const chalk_1 = __importDefault(__webpack_require__(4061));
 const logger_1 = __webpack_require__(6266);
 const path_1 = __webpack_require__(2947);
@@ -62875,18 +62875,49 @@ const build_1 = __webpack_require__(6898);
 const copy_template_program_1 = __webpack_require__(1047);
 const initialize_1 = __webpack_require__(9446);
 const initialize_native_deps_1 = __webpack_require__(6909);
+const fs_1 = __webpack_require__(1942);
 const logger = new logger_1.Logger('Commands', 'yellow');
-const help = () => {
-    logger.log(`The following commands are available:
-${Object.keys(cliUtilsCommands).map(x => `- ${chalk_1.default.yellow(x)}`).join('\n')}`);
-    return Promise.resolve();
-};
+const help = () => __awaiter(void 0, void 0, void 0, function* () {
+    const commandMetadatas = yield getCommandMetadatas();
+    logger.log(`The following commands are available:
+${commandMetadatas.map(({ name, args, description }) => `${chalk_1.default.yellow(name)}${args ? ` ${args}` : ''}
+${description}`).join('\n\n')}`);
+});
+function getCommandMetadatas() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield Promise.all(Object.entries(cliUtilsCommands)
+            .map(([name, { args, description }]) => __awaiter(this, void 0, void 0, function* () {
+            return ({
+                name,
+                args: yield args,
+                description: yield description,
+            });
+        })));
+    });
+}
+exports.getCommandMetadatas = getCommandMetadatas;
+function cmd(fn, argsOrDescription, description) {
+    return {
+        fn,
+        args: Promise.resolve(description && argsOrDescription),
+        description: Promise.resolve(description !== null && description !== void 0 ? description : argsOrDescription),
+    };
+}
 const cliUtilsCommands = {
-    'copy-program': (src, dst) => (0, copy_template_program_1.copyTemplateProgram)(src, path_1.Path.File.create(dst)),
-    'init': initialize_1.initializeSmoochConfig,
-    'build': build_1.build,
-    'init-native-deps': initialize_native_deps_1.initializeNativeDepsConfig,
-    'help': help,
+    'init': cmd(initialize_1.initializeSmoochConfig, `Initialize a **smooch.json** configuration file.`),
+    'copy-program': cmd((src, dst) => (0, copy_template_program_1.copyTemplateProgram)(src, path_1.Path.File.create(dst)), '<program> <dst>', (() => __awaiter(void 0, void 0, void 0, function* () {
+        const defaultsList = (yield (0, copy_template_program_1.getAvailableTemplatePrograms)())
+            .map(path => fs_1.Fs.parse(path).name)
+            .map(name => `- ${name}`)
+            .join('\n');
+        return `Copy a default template JavaScript program **program** to **dst**. Available programs are
+${defaultsList}`;
+    }))()),
+    'build': cmd(build_1.build, `Aggregate and transform assets according to your **smooch.json**. Probably should be used on a CI server!`),
+    'init-native-deps': cmd(initialize_native_deps_1.initializeNativeDepsConfig, `Produce a **smooch-native-deps.json** configuration file.
+This is for a bizarre subsystem that sidesteps your **package-lock.json**.
+You probably won't need to touch this!`),
+    'help': cmd(help, `List these commands!`),
 };
 function runCliUtilCommand() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -62897,7 +62928,7 @@ function runCliUtilCommand() {
             if (index === -1)
                 continue;
             const commandArgs = args.slice(index + 1);
-            yield cliUtilsCommands[command](...commandArgs);
+            yield cliUtilsCommands[command].fn(...commandArgs);
             return true;
         }
         return false;
@@ -62926,7 +62957,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.copyTemplateProgram = void 0;
+exports.getAvailableTemplatePrograms = exports.copyTemplateProgram = void 0;
 const chalk_1 = __importDefault(__webpack_require__(4061));
 const describe_list_1 = __webpack_require__(7353);
 const environment_1 = __webpack_require__(3685);
@@ -62947,17 +62978,23 @@ function copyTemplateProgram(src, dstFile) {
     });
 }
 exports.copyTemplateProgram = copyTemplateProgram;
-function findTemplateProgramFile(src) {
+function getAvailableTemplatePrograms() {
     return __awaiter(this, void 0, void 0, function* () {
         const glob = path_1.Path.Glob.create(templateProgramDirectory, '*.js');
-        const files = yield gwob_1.Gwob.files(glob);
+        return yield gwob_1.Gwob.files(glob);
+    });
+}
+exports.getAvailableTemplatePrograms = getAvailableTemplatePrograms;
+function findTemplateProgramFile(src) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const files = yield getAvailableTemplatePrograms();
         for (const file of files) {
             const { base } = fs_1.Fs.parse(file);
             if (base.includes(src))
                 return file;
         }
         const list = (0, describe_list_1.describeList)(files.map(file => fs_1.Fs.parse(file).name));
-        logger.log(`Could not find template program to copy.
+        logger.log(`Could not find template program to copy.
 Available template programs: ${chalk_1.default.white(list)}`);
         return null;
     });
@@ -63575,7 +63612,7 @@ class SmoochEffectiveConfig {
                     logger.log(`${chalk_1.default.yellow('Hey cutie!')} Configuration appears to have changed.`);
             }
             catch (e) {
-                logger.log(`Got an error while reading ${this._file}, assuming configuration changed.
+                logger.log(`Got an error while reading ${this._file}, assuming configuration changed.
 This may be normal if your cache directory was deleted or this is your first time running!`);
                 changed = true;
             }
@@ -64208,7 +64245,7 @@ function zipGlob(srcGlob, dstFile, options) {
         // but every ms counts!
         const files = yield gwob_1.Gwob.files(srcGlob);
         const start = now_1.Now.ms;
-        logger.log(`Zipping ${chalk_1.default.blue(srcGlob)}
+        logger.log(`Zipping ${chalk_1.default.blue(srcGlob)}
 => ${chalk_1.default.green(dstFile)}...`);
         for (const file of files)
             archive.file(file, { name: file.substring(root.length) });
@@ -94962,7 +94999,7 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"]
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"@hubol/smooch","version":"1.0.0-beta.2","description":"Generate texture atlases, browser-compatible audio, and source code from directories","scripts":{"build":"npm run build:json-schema && npm run build:template-api-dts && npm run build:bundle && npm run build:distributable-package-json && npm run build:npm-pack","build:json-schema":"ts-node ./tools/generate-config-schema.ts","build:template-api-dts":"npx tsup lib/template-api.ts --dts-only --dts-resolve","build:bundle":"webpack","build:distributable-package-json":"ts-node ./tools/generate-distributable-package-json.ts","build:npm-pack":"ts-node ./tools/pack.ts ../smooch.tgz","dev:build-and-test":"npm run build && npm run test","dev:start":"node --nolazy -r ts-node/register ./lib/main/dev.ts","test":"ts-node --transpileOnly test/test.ts"},"bin":{"smooch":"index.js"},"author":"Hubol","license":"ISC","devDependencies":{"@jimp/custom":"^0.22.10","@jimp/types":"^0.22.10","@types/archiver":"^5.3.2","@types/fluent-ffmpeg":"^2.1.21","@types/js-beautify":"^1.13.3","@types/sharp":"^0.31.1","archiver":"^6.0.0","chalk":"^4.1.2","change-case":"^4.1.2","fluent-ffmpeg":"^2.1.2","glob":"^10.3.3","image-size":"^1.0.2","js-beautify":"^1.14.9","maxrects-packer":"^2.7.3","minimatch":"^9.0.3","superstruct":"^0.15.5","tree-kill":"^1.2.2","ts-loader":"^9.4.4","ts-node":"^10.9.1","tsup":"^7.2.0","typescript":"^5.0.4","typescript-json-schema":"^0.56.0","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-shebang-plugin":"^1.1.8"}}');
+module.exports = JSON.parse('{"name":"@hubol/smooch","version":"1.0.0-beta.4","description":"Generate texture atlases, browser-compatible audio, and source code from directories","scripts":{"build":"npm run build:json-schema && npm run build:template-api-dts && npm run build:bundle && npm run build:distributable-package-json && npm run build:npm-readme && npm run build:npm-pack","build:json-schema":"ts-node ./tools/generate-config-schema.ts","build:template-api-dts":"npx tsup lib/template-api.ts --dts-only --dts-resolve","build:bundle":"webpack","build:distributable-package-json":"ts-node ./tools/generate-distributable-package-json.ts","build:npm-readme":"ts-node ./tools/generate-npm-readme.ts","build:npm-pack":"ts-node ./tools/pack.ts ../smooch.tgz","dev:build-and-test":"npm run build && npm run test","dev:start":"node --nolazy -r ts-node/register ./lib/main/dev.ts","dev:update-readme":"ts-node ./lib/main/dev.ts ../../tools/update-readme-md.ts","test":"ts-node --transpileOnly test/test.ts"},"bin":{"smooch":"index.js"},"author":"Hubol","license":"ISC","repository":{"type":"git","url":"https://github.com/hubol/smooch.git"},"devDependencies":{"@jimp/custom":"^0.22.10","@jimp/types":"^0.22.10","@types/archiver":"^5.3.2","@types/fluent-ffmpeg":"^2.1.21","@types/js-beautify":"^1.13.3","@types/sharp":"^0.31.1","archiver":"^6.0.0","chalk":"^4.1.2","change-case":"^4.1.2","fluent-ffmpeg":"^2.1.2","glob":"^10.3.3","image-size":"^1.0.2","js-beautify":"^1.14.9","maxrects-packer":"^2.7.3","minimatch":"^9.0.3","superstruct":"^0.15.5","tree-kill":"^1.2.2","ts-loader":"^9.4.4","ts-node":"^10.9.1","tsup":"^7.2.0","typescript":"^5.0.4","typescript-json-schema":"^0.56.0","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-shebang-plugin":"^1.1.8"}}');
 
 /***/ })
 

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@hubol/smooch",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.4",
   "description": "Generate texture atlases, browser-compatible audio, and source code from directories",
   "bin": {
     "smooch": "index.js"
   },
   "author": "Hubol",
-  "license": "ISC"
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hubol/smooch.git"
+  }
 }

package/templates/audio-convert.js

@@ -1,14 +1,14 @@
-/**
-@param {import("smooch/template-api").TemplateContext.AudioConvert} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ files }, { pascal, noext }) {
-    return `
-// This file is generated
-
-export const Sfx = {
-${files.map(file =>
-`   "${pascal(noext(file.path))}": { ogg: "${file.convertedPaths.ogg}", mp3: "${file.convertedPaths.mp3}", }`).join(`,
-`)}
-}`;
+/**
+@param {import("smooch/template-api").TemplateContext.AudioConvert} context;
+@param {import("smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ files }, { pascal, noext }) {
+    return `
+// This file is generated
+
+export const Sfx = {
+${files.map(file =>
+`   "${pascal(noext(file.path))}": { ogg: "${file.convertedPaths.ogg}", mp3: "${file.convertedPaths.mp3}", }`).join(`,
+`)}
+}`;
 }

package/templates/json-aggregate.js

@@ -1,12 +1,12 @@
-/**
-@param {import("smooch/template-api").TemplateContext.JsonAggregate} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ files }, { pascal, noext, oneline, json }) {
-    return `// This file is generated.
-
-export const JsonFiles = {
-${ files.map(file => `  "${ pascal(noext(file.fileName)) }": ${ oneline(json(file.json)) }`).join(`,
-`) }
-}`;
+/**
+@param {import("smooch/template-api").TemplateContext.JsonAggregate} context;
+@param {import("smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ files }, { pascal, noext, oneline, json }) {
+    return `// This file is generated.
+
+export const JsonFiles = {
+${ files.map(file => `  "${ pascal(noext(file.fileName)) }": ${ oneline(json(file.json)) }`).join(`,
+`) }
+}`;
 }

package/templates/texture-pack.js

@@ -1,16 +1,16 @@
-/**
-@param {import("smooch/template-api").TemplateContext.TexturePack} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ atlases, textures }, { pascal, noext }) {
-    return `
-// This file is generated
-
-export const Atlases = [ ${atlases.map(x => `"${x.fileName}"`).join(', ')} ];
-
-export const Txs = {
-${textures.map(tx =>
-`   "${pascal(noext(tx.fileName))}": { atlas: "${tx.atlasFileName}", x: ${tx.x}, y: ${tx.y}, width: ${tx.width}, height: ${tx.height} }`).join(`,
-`)}
-}`;
+/**
+@param {import("smooch/template-api").TemplateContext.TexturePack} context;
+@param {import("smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ atlases, textures }, { pascal, noext }) {
+    return `
+// This file is generated
+
+export const Atlases = [ ${atlases.map(x => `"${x.fileName}"`).join(', ')} ];
+
+export const Txs = {
+${textures.map(tx =>
+`   "${pascal(noext(tx.fileName))}": { atlas: "${tx.atlasFileName}", x: ${tx.x}, y: ${tx.y}, width: ${tx.width}, height: ${tx.height} }`).join(`,
+`)}
+}`;
 }