@needle-tools/gltf-build-pipeline 2.2.0-alpha.1 → 2.2.0-alpha.3

package/CHANGELOG.md

@@ -4,12 +4,13 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [2.2.0-alpha] - 2023-06-06
-- Add: CLI `--progressive` option to `transform` command (default is enabled)
-- Add: config `meshes: { lods: boolean }` option
-- Remove: CLI "compress" command
-- Change: enable texture LODs by default
-- Fix: `--config` path can now point to a directory or a `needle.config.json` file as well
+## [2.2.0-alpha.2] - 2023-06-06
+- add: CLI `--progressive` option to `transform` command (default is true)
+- add: CLI `--compress` option to `transform` command (default is true)
+- add: config `meshes: { lods: boolean }` option
+- remove: CLI "compress" command
+- change: enable texture LODs by default
+- fix: `--config` path can now point to a directory or a `needle.config.json` file as well
 
 ## [2.1.0-alpha.6] - 2023-06-04
 - fix: errors when invoking npm scripts caused by the cli program

package/dist/cli/index.js

@@ -32,6 +32,7 @@ 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 })
@@ -39,6 +40,10 @@ Each version will be compressed and written to the output directory.
     .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 })
     .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(),
@@ -83,23 +88,25 @@ Each version will be compressed and written to the output directory.
                 process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
             });
         }
-        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) {
+        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);
             }
         }
-        if (await packGLTF(file, file, opts) === false) {
-            process.exit(ERROR_CODES.PACKING_FAILED);
-        }
     });
     printStats(stats, logger, config);
     if (options.stats) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.2.0-alpha.1",
+  "version": "2.2.0-alpha.3",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
-  "main": "src/index.js",
+  "main": "dist/index.js",
   "type": "module",
   "readme": "README.md",
   "author": {

package/scripts/clear-caches.mjs

@@ -1,4 +1,4 @@
 
-import { clearCache } from '../dist/src/cache/index.js';
+import { clearCache } from '../dist/cache/index.js';
 
 clearCache();

package/scripts/defaults.mjs

@@ -1,6 +1,6 @@
 import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
-import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS } from "../dist/src/extensions/NEEDLE_opaque/index.js";
-import { NEEDLE_progressive } from '../dist/src/index.js';
+import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS } from "../dist/extensions/NEEDLE_opaque/index.js";
+import { NEEDLE_progressive } from '../dist/index.js';
 
 
 export function registerExtensions(node) {

package/scripts/fileutils.mjs

@@ -1,4 +1,4 @@
-import { foreachGLTF as foreach } from '../dist/src/index.js';
+import { foreachGLTF as foreach } from '../dist/index.js';
 
 
 export function foreachGLTF(args, callback) {

package/scripts/index.mjs

@@ -1,6 +1,6 @@
 
 import { spawnSync } from "child_process";
-import { getVersion } from "../dist/src/index.js";
+import { getVersion } from "../dist/index.js";
 
 const workingDir = process.cwd();
 

package/scripts/limit-caches.mjs

@@ -1,4 +1,4 @@
 
-import { limitCacheSize } from '../dist/src/cache/index.js';
+import { limitCacheSize } from '../dist/cache/index.js';
 
 limitCacheSize(512);

package/scripts/make-progressive.mjs

@@ -1,5 +1,5 @@
-import { getConfig, getVersion } from '../dist/src/index.js';
-import { make_progressive } from '../dist/src/transforms/needle_progressive.js';
+import { getConfig, getVersion } from '../dist/index.js';
+import { make_progressive } from '../dist/transforms/needle_progressive.js';
 
 const args = process.argv;
 

package/scripts/pack-gltf.mjs

@@ -1,6 +1,6 @@
 import commandLineArgs from "command-line-args";
 import { foreachGLTF } from './fileutils.mjs';
-import { getVersion, limitCacheSize, getConfig, packGLTF, printStats } from '../dist/src/index.js';
+import { getVersion, limitCacheSize, getConfig, packGLTF, printStats } from '../dist/index.js';
 import { Logger, Verbosity } from "@gltf-transform/core";
 
 console.log(`[Needle Build Pipeline] pack glTF — version ${getVersion()}`)
@@ -60,7 +60,7 @@ if (noToktx)
 const packedFiles = new Set();
 
 /**
- * @type {import("../dist/src/index.js").Stats}
+ * @type {import("../dist/index.js").Stats}
  */
 const stats = {
     startTime: Date.now(),