@needle-tools/gltf-build-pipeline 2.2.1-alpha.2 → 2.2.1-alpha.3

package/dist/cli/index.js

@@ -1,154 +1,154 @@
-#! /usr/bin/env node
-import { program } from '@donmccurdy/caporal';
-import { calculateStats, packGLTF } from "../scripts/index.js";
-import { printStats, writeFileStatsToFile } from '../utils/stats.js';
-import { getVersion } from '../utils/version.js';
-import { UsecaseOptions, createConfig, getConfig } from '../config/index.js';
-import { make_progressive } from '../transforms/needle_progressive.js';
-import { cacheSizeLimit, clearCache } from '../cache/cache.js';
-import { statSync } from 'fs';
-import { foreachGLTF, getDirName, isDirectory } from '../utils/fileutils.js';
-import path, { dirname } from 'path';
-import { ERROR_CODES } from '../constants.js';
-// For testing / dev you can run `npm link` in the package directory
-// For removing the link run `npm rm --global @needle-tools/gltf-build-pipeline`
-program
-    .command("version", "Print current verison")
-    .action(async ({ logger }) => {
-    logger.info(getVersion());
-})
-    .command("clear-caches", "Clear all caches")
-    .help(`Clears all cached files
-Caches are limited to ${cacheSizeLimit} MB disc space by default.
-`)
-    .action(async ({ logger }) => {
-    logger.info("Clearing caches");
-    clearCache(logger);
-})
-    .command("stats", "Calculate glTF stats")
-    .help(`
-`)
-    .argument('<input>', "Path to a glTF, GLB or VRM file OR a directory")
-    .argument('<output>', "Output path for the stats", { default: null, validator: program.STRING })
-    .action(async ({ logger, args, options }) => {
-    logger.level = "info";
-    logger.info("Calculating stats for \"" + args.input + "\"");
-    const input = args.input.toString();
-    const filestats = new Array();
-    await foreachGLTF(input, async (file) => {
-        const stats = await calculateStats(file);
-        filestats.push(stats);
-    });
-    let output = args.ourput?.toString();
-    if (!output) {
-        if (isDirectory(input)) {
-            output = path.join(input, "stats.needle.json");
-        }
-        else {
-            output = input + ".needle.stats.json";
-        }
-    }
-    logger.info("Writing stats to: " + output);
-    writeFileStatsToFile(filestats, output);
-})
-    .command("transform", "Transform (progressive loading) and compress glTF, GLB or VRM files")
-    .help(`
-This will produce multiple versions of the input file, each with a different level of optimization.   
-Each version will be compressed and written to the output directory.
-`)
-    .argument('<input>', "The input glTF, GLB or VRM file that should be compressed OR a directory that contains files to be compressed")
-    // .argument('<output>', "The output file. If not provided, the input file will be overwritten.", { default: "" })
-    .option("--compress", `When enabled files will be compressed`, { validator: program.BOOLEAN, default: true })
-    .option("--progressive", `When enabled files will processed to be progressively loaded`, { validator: program.BOOLEAN, default: true })
-    .option("--usecase <usecase>", `The usecase for the compression. This will set the compression settings. Possible options: [${UsecaseOptions.join(", ")}]`, { validator: program.STRING })
-    .option("--config <config>", "The path to a JSON file containing the compression settings. This can also be a needle.config.json file with a \"compression\" object or usecase string.", { validator: program.STRING })
-    .option("--stats", "Output a stats file next to input file (or inside the input directory). It will be named as the input file/directory \"<input>.needle.stats.json\"", { validator: program.BOOLEAN, default: false })
-    .option("--cache", "Use \"--cache False\" to disable caching.\nWhen caching is enabled then previously processed files will be detected and loaded from disc cache instead of being processed again if settings or the file contents have not changed.", { validator: program.BOOLEAN, default: true })
-    .option("--debug", "Enable for more verbose outout with \"--debug True\"", { validator: program.BOOLEAN, default: false })
-    .option("--verbose", "Enable for more verbose outout with \"--verbose True\"", { validator: program.BOOLEAN, default: false })
-    .action(async ({ logger, args, options }) => {
-    if (options.compress === false && options.progressive === false) {
-        logger.error("You need to enable at least one of the options: --compress or --progressive");
-        return;
-    }
-    logger.info("Transforming glTF file: " + args.input);
-    const stats = {
-        startTime: Date.now(),
-        totalGPUMemoryInMB: 0,
-        totalFilesProcessed: 0,
-        totalFileSizeInMB: 0,
-        totalFileSizeInMBBefore: 0,
-    };
-    const file = args.input.toString();
-    let config = getConfig(options.config?.toString(), file, {
-        logger
-    });
-    if (options.usecase) {
-        logger.info("Using usecase: " + options.usecase);
-        config = { ...createConfig(options.usecase.toString()), ...config, };
-        if (config.usecase != "default" && config.usecase != options.usecase.toString()) {
-            logger.warn(`Conflicting usecase. Your specific config at \"${options.config}\" has a different usecase than the one provided by the CLI: \"${options.usecase}\". Using the usecase from the config file.`);
-        }
-        else {
-            config.usecase = options.usecase.toString();
-        }
-    }
-    const output = options.output?.toString() || file;
-    const outputIsDirectory = statSync(output).isDirectory();
-    const outDir = outputIsDirectory ? output : dirname(output);
-    const file_stats = options.stats === true ? new Array : null;
-    const set = new Set();
-    const useCache = options.cache !== false;
-    const debug = options.debug === true;
-    await foreachGLTF(file, async (file) => {
-        logger.info("→ Transform " + file);
-        const progressive_results = new Array();
-        if (options.progressive === true) {
-            if (await make_progressive({
-                path: file,
-                results: progressive_results,
-                config,
-                debug,
-                useCache,
-            }).catch(err => {
-                logger.error(err);
-                process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
-            }) === false) {
-                process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
-            }
-        }
-        if (options.compress === true) {
-            const opts = {
-                config,
-                stats,
-                packedFiles: set,
-                debug,
-                useCache,
-                logger: logger,
-                file_stats,
-            };
-            for (const res of progressive_results) {
-                if (await packGLTF(res, res, opts) === false) {
-                    process.exit(ERROR_CODES.PACKING_FAILED);
-                }
-            }
-            if (await packGLTF(file, file, opts) === false) {
-                process.exit(ERROR_CODES.PACKING_FAILED);
-            }
-        }
-    });
-    printStats(stats, logger, config);
-    if (options.stats) {
-        const statsFile = (outputIsDirectory ? (path.join(file, getDirName(file))) : file) + ".needle.stats.json";
-        writeFileStatsToFile(file_stats, statsFile);
-    }
-});
-program.run().catch(err => {
-    // Since we still invoke this package with paths when running npm scripts we need to ignore this error
-    // We might want to move this code here into an extra package.
-    if (err.message.includes("Unknown command") && !err.message.includes("Did you mean")) {
-        // ignore
-        return;
-    }
-    throw err;
-});
+#! /usr/bin/env node
+import { program } from '@donmccurdy/caporal';
+import { calculateStats, packGLTF } from "../scripts/index.js";
+import { printStats, writeFileStatsToFile } from '../utils/stats.js';
+import { getVersion } from '../utils/version.js';
+import { UsecaseOptions, createConfig, getConfig } from '../config/index.js';
+import { make_progressive } from '../transforms/needle_progressive.js';
+import { cacheSizeLimit, clearCache } from '../cache/cache.js';
+import { statSync } from 'fs';
+import { foreachGLTF, getDirName, isDirectory } from '../utils/fileutils.js';
+import path, { dirname } from 'path';
+import { ERROR_CODES } from '../constants.js';
+// For testing / dev you can run `npm link` in the package directory
+// For removing the link run `npm rm --global @needle-tools/gltf-build-pipeline`
+program
+    .command("version", "Print current verison")
+    .action(async ({ logger }) => {
+    logger.info(getVersion());
+})
+    .command("clear-caches", "Clear all caches")
+    .help(`Clears all cached files
+Caches are limited to ${cacheSizeLimit} MB disc space by default.
+`)
+    .action(async ({ logger }) => {
+    logger.info("Clearing caches");
+    clearCache(logger);
+})
+    .command("stats", "Calculate glTF stats")
+    .help(`
+`)
+    .argument('<input>', "Path to a glTF, GLB or VRM file OR a directory")
+    .argument('<output>', "Output path for the stats", { default: null, validator: program.STRING })
+    .action(async ({ logger, args, options }) => {
+    logger.level = "info";
+    logger.info("Calculating stats for \"" + args.input + "\"");
+    const input = args.input.toString();
+    const filestats = new Array();
+    await foreachGLTF(input, async (file) => {
+        const stats = await calculateStats(file);
+        filestats.push(stats);
+    });
+    let output = args.ourput?.toString();
+    if (!output) {
+        if (isDirectory(input)) {
+            output = path.join(input, "stats.needle.json");
+        }
+        else {
+            output = input + ".needle.stats.json";
+        }
+    }
+    logger.info("Writing stats to: " + output);
+    writeFileStatsToFile(filestats, output);
+})
+    .command("transform", "Transform (progressive loading) and compress glTF, GLB or VRM files")
+    .help(`
+This will produce multiple versions of the input file, each with a different level of optimization.   
+Each version will be compressed and written to the output directory.
+`)
+    .argument('<input>', "The input glTF, GLB or VRM file that should be compressed OR a directory that contains files to be compressed")
+    // .argument('<output>', "The output file. If not provided, the input file will be overwritten.", { default: "" })
+    .option("--compress", `When enabled files will be compressed`, { validator: program.BOOLEAN, default: true })
+    .option("--progressive", `When enabled files will processed to be progressively loaded`, { validator: program.BOOLEAN, default: true })
+    .option("--usecase <usecase>", `The usecase for the compression. This will set the compression settings. Possible options: [${UsecaseOptions.join(", ")}]`, { validator: program.STRING })
+    .option("--config <config>", "The path to a JSON file containing the compression settings. This can also be a needle.config.json file with a \"compression\" object or usecase string.", { validator: program.STRING })
+    .option("--stats", "Output a stats file next to input file (or inside the input directory). It will be named as the input file/directory \"<input>.needle.stats.json\"", { validator: program.BOOLEAN, default: false })
+    .option("--cache", "Use \"--cache False\" to disable caching.\nWhen caching is enabled then previously processed files will be detected and loaded from disc cache instead of being processed again if settings or the file contents have not changed.", { validator: program.BOOLEAN, default: true })
+    .option("--debug", "Enable for more verbose outout with \"--debug True\"", { validator: program.BOOLEAN, default: false })
+    .option("--verbose", "Enable for more verbose outout with \"--verbose True\"", { validator: program.BOOLEAN, default: false })
+    .action(async ({ logger, args, options }) => {
+    if (options.compress === false && options.progressive === false) {
+        logger.error("You need to enable at least one of the options: --compress or --progressive");
+        return;
+    }
+    logger.info("Transforming glTF file: " + args.input);
+    const stats = {
+        startTime: Date.now(),
+        totalGPUMemoryInMB: 0,
+        totalFilesProcessed: 0,
+        totalFileSizeInMB: 0,
+        totalFileSizeInMBBefore: 0,
+    };
+    const file = args.input.toString();
+    let config = getConfig(options.config?.toString(), file, {
+        logger
+    });
+    if (options.usecase) {
+        logger.info("Using usecase: " + options.usecase);
+        config = { ...createConfig(options.usecase.toString()), ...config, };
+        if (config.usecase != "default" && config.usecase != options.usecase.toString()) {
+            logger.warn(`Conflicting usecase. Your specific config at \"${options.config}\" has a different usecase than the one provided by the CLI: \"${options.usecase}\". Using the usecase from the config file.`);
+        }
+        else {
+            config.usecase = options.usecase.toString();
+        }
+    }
+    const output = options.output?.toString() || file;
+    const outputIsDirectory = statSync(output).isDirectory();
+    const outDir = outputIsDirectory ? output : dirname(output);
+    const file_stats = options.stats === true ? new Array : null;
+    const set = new Set();
+    const useCache = options.cache !== false;
+    const debug = options.debug === true;
+    await foreachGLTF(file, async (file) => {
+        logger.info("→ Transform " + file);
+        const progressive_results = new Array();
+        if (options.progressive === true) {
+            if (await make_progressive({
+                path: file,
+                results: progressive_results,
+                config,
+                debug,
+                useCache,
+            }).catch(err => {
+                logger.error(err);
+                process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
+            }) === false) {
+                process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
+            }
+        }
+        if (options.compress === true) {
+            const opts = {
+                config,
+                stats,
+                packedFiles: set,
+                debug,
+                useCache,
+                logger: logger,
+                file_stats,
+            };
+            for (const res of progressive_results) {
+                if (await packGLTF(res, res, opts) === false) {
+                    process.exit(ERROR_CODES.PACKING_FAILED);
+                }
+            }
+            if (await packGLTF(file, file, opts) === false) {
+                process.exit(ERROR_CODES.PACKING_FAILED);
+            }
+        }
+    });
+    printStats(stats, logger, config);
+    if (options.stats) {
+        const statsFile = (outputIsDirectory ? (path.join(file, getDirName(file))) : file) + ".needle.stats.json";
+        writeFileStatsToFile(file_stats, statsFile);
+    }
+});
+program.run().catch(err => {
+    // Since we still invoke this package with paths when running npm scripts we need to ignore this error
+    // We might want to move this code here into an extra package.
+    if (err.message.includes("Unknown command") && !err.message.includes("Did you mean")) {
+        // ignore
+        return;
+    }
+    throw err;
+});

package/dist/config/index.d.ts

@@ -1,53 +1,53 @@
-import { ILogger } from "@gltf-transform/core";
-declare type Usecase = "default" | "product" | "world";
-export declare const UsecaseOptions: string[];
-/**
- * The config object contains information about how a file should be processed.
- */
-export type Config = {
-    /** High-level configuration */
-    usecase: Usecase;
-    textures?: {
-        lods: boolean;
-    };
-    meshes?: {
-        lods: boolean;
-    };
-};
-/**
- * Create a config object with the given usecase.
- */
-export declare function createConfig(usecase: string): {
-    usecase: Usecase;
-};
-/**
- * Get the config object either provided by a CLI path or a needle.config.json file in the parent directory.
- *
- * @example CLI argument where the path points to a json file containing the config as `Config`
- * ```sh
- * node script.js --config path/to/my-optimization-config.json
- * ```
- *
- * @example needle.config.json - the usecase can be provided as a string
- * ```json
- * {
- *    "optimization": "product"
- * }
- * ```
- *
- * @example needle.config.json - the whole config object can be provided
- * ```json
- * {
- *   "optimization": {
- *      "usecase": "product"
- *   }
- * }
- * ```
- *
- *
- */
-export declare function getConfig(configPath?: string, fallbackSearchDirectory?: string, opts?: {
-    logger: ILogger;
-}): Config;
-export declare function searchConfig(directory: string, logger: ILogger): Config | null;
-export {};
+import { ILogger } from "@gltf-transform/core";
+declare type Usecase = "default" | "product" | "world";
+export declare const UsecaseOptions: string[];
+/**
+ * The config object contains information about how a file should be processed.
+ */
+export type Config = {
+    /** High-level configuration */
+    usecase: Usecase;
+    textures?: {
+        lods: boolean;
+    };
+    meshes?: {
+        lods: boolean;
+    };
+};
+/**
+ * Create a config object with the given usecase.
+ */
+export declare function createConfig(usecase: string): {
+    usecase: Usecase;
+};
+/**
+ * Get the config object either provided by a CLI path or a needle.config.json file in the parent directory.
+ *
+ * @example CLI argument where the path points to a json file containing the config as `Config`
+ * ```sh
+ * node script.js --config path/to/my-optimization-config.json
+ * ```
+ *
+ * @example needle.config.json - the usecase can be provided as a string
+ * ```json
+ * {
+ *    "optimization": "product"
+ * }
+ * ```
+ *
+ * @example needle.config.json - the whole config object can be provided
+ * ```json
+ * {
+ *   "optimization": {
+ *      "usecase": "product"
+ *   }
+ * }
+ * ```
+ *
+ *
+ */
+export declare function getConfig(configPath?: string, fallbackSearchDirectory?: string, opts?: {
+    logger: ILogger;
+}): Config;
+export declare function searchConfig(directory: string, logger: ILogger): Config | null;
+export {};