@needle-tools/gltf-build-pipeline 1.6.0-alpha.4 → 1.6.0-alpha.6

package/CHANGELOG.md

@@ -4,8 +4,12 @@ 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).
 
-## [1.6.0-alpha.4] - 2023-05-28
+## [1.6.0-alpha.6] - 2023-05-30
+- fix: npx cli command return wrong error due to `packGLTF` not returning a booelan
+
+## [1.6.0-alpha.5] - 2023-05-28
 - fix: determine build pipeline version
+- change: throw error and exit process if packing or transform fails
 
 ## [1.6.0-alpha.2] - 2023-05-27
 - add: `gltf-build-pipeline` commandline support with `transform` and `compress` (pack-gltf) options.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@needle-tools/gltf-build-pipeline",
-    "version": "1.6.0-alpha.4",
+    "version": "1.6.0-alpha.6",
     "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
     "main": "index.mjs",
     "type": "module",
@@ -51,7 +51,8 @@
     },
     "devDependencies": {
         "@types/node": "^18.7.23",
-        "npm-watch": "^0.11.0",
+        "nodemon": "^3.1.2",
+        "npm-watch": "^0.13.0",
         "typescript": "^4.9.5"
     },
     "author": {

package/dist/src/cli/index.js

@@ -9,6 +9,7 @@ import { cacheSizeLimit, clearCache } from '../cache/cache.js';
 import { existsSync, statSync } from 'fs';
 import { foreachGLTF } from '../utils/fileutils.js';
 import { 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
@@ -77,7 +78,7 @@ Compress a single glTF file. The input file is compressed and written to the out
             const filename = file.replaceAll("\\", "/").split("/").pop();
             outputFile = options.output?.toString() + "/" + filename;
         }
-        await packGLTF(file, outputFile, {
+        const res = await packGLTF(file, outputFile, {
             config,
             packedFiles: set,
             stats,
@@ -86,6 +87,9 @@ Compress a single glTF file. The input file is compressed and written to the out
             logger: logger,
             file_stats: file_stats,
         });
+        if (res === false) {
+            process.exit(ERROR_CODES.PACKING_FAILED);
+        }
     });
     printStats(stats);
     console.log("Stats: ", options);
@@ -136,6 +140,9 @@ Each version will be compressed and written to the output directory.
             config,
             debug: false,
             useCache: true,
+        }).catch(err => {
+            logger.error(err);
+            process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
         });
         const opts = {
             config,
@@ -148,10 +155,14 @@ Each version will be compressed and written to the output directory.
         };
         for (const res of progressive_results) {
             logger.info("> Compress " + res);
-            await packGLTF(res, res, opts);
+            if (await packGLTF(res, res, opts) === false) {
+                process.exit(ERROR_CODES.PACKING_FAILED);
+            }
         }
         logger.info("> Compress " + file);
-        await packGLTF(file, file, opts);
+        if (await packGLTF(file, file, opts) === false) {
+            process.exit(ERROR_CODES.PACKING_FAILED);
+        }
     });
     printStats(stats);
     if (options.outputStats) {

package/dist/src/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const ERROR_CODES: {
+    UNKNOWN_ERROR: number;
+    PACKING_FAILED: number;
+    PROGRESSIVE_FAILED: number;
+};

package/dist/src/constants.js

@@ -0,0 +1,5 @@
+export const ERROR_CODES = {
+    UNKNOWN_ERROR: 1,
+    PACKING_FAILED: 2,
+    PROGRESSIVE_FAILED: 3,
+};

package/dist/src/index.d.ts

@@ -5,3 +5,4 @@ export * from "./transforms/index.js";
 export * from "./extensions/index.js";
 export * from "./cache/index.js";
 export * from "./scripts/index.js";
+export * from "./constants.js";

package/dist/src/index.js

@@ -5,3 +5,4 @@ export * from "./transforms/index.js";
 export * from "./extensions/index.js";
 export * from "./cache/index.js";
 export * from "./scripts/index.js";
+export * from "./constants.js";

package/dist/src/scripts/pack-gltf.js

@@ -22,7 +22,7 @@ export async function packGLTF(inputFile, outputFile, options) {
         return;
     }
     if (debug && inputFile.includes(".debug.")) {
-        return;
+        return true;
     }
     // check if it's in the cache. 
     // We only need to check mesh LOD files because image LODs are cache via our toktx transform
@@ -36,12 +36,12 @@ export async function packGLTF(inputFile, outputFile, options) {
         if (cached) {
             logger.info(`→ Loaded compressed file from cache: \"${path.basename(inputFile)}\"`);
             writeFileSync(inputFile, cached);
-            return;
+            return true;
         }
     }
     if (packedFiles) {
         if (packedFiles.has(inputFile))
-            return;
+            return true;
         packedFiles.add(inputFile);
     }
     try {

package/dist/src/transforms/needle_progressive.js

@@ -53,15 +53,7 @@ async function onProcess(file, opts) {
             'draco3d.decoder': await draco3d.createDecoderModule(),
             'draco3d.encoder': await draco3d.createEncoderModule(),
         });
-        const document = await io.read(file).catch((err) => {
-            // Log this message as a warning, it happens when trying to run on a already compressed gltf file (e.g. pre-processed. When logging an error we fail the build which is not desired)
-            if (err.message === "Cannot read properties of undefined (reading 'DT_FLOAT32')") {
-                console.log("WARN: \"" + err.message + "\" at \"" + file + "\"");
-            }
-            else
-                console.log("ERR: \"" + err.message + "\" at \"" + file + "\"\nStacktrace:\n" + err.stack);
-            return;
-        });
+        let document = await io.read(file);
         if (document) {
             if (opts.debug === true) {
                 if (file.includes(".debug.")) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.6.0-alpha.4",
+  "version": "1.6.0-alpha.6",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "index.mjs",
   "type": "module",
@@ -51,7 +51,8 @@
   },
   "devDependencies": {
     "@types/node": "^18.7.23",
-    "npm-watch": "^0.11.0",
+    "nodemon": "^3.1.2",
+    "npm-watch": "^0.13.0",
     "typescript": "^4.9.5"
   },
   "author": {
@@ -63,4 +64,4 @@
     "type": "git",
     "url": "git+https://github.com/needle-tools/needle-gltf-extensions.git"
   }
-}
+}