@needle-tools/engine 4.7.0 → 4.7.2-alpha

package/plugins/vite/build.js

@@ -1,20 +1,20 @@
-
-export const needleBuild = (command, config, userSettings) => {
-
-    // TODO: need to set this when building a dist
-    const isDeployOnlyBuild = config?.deployOnly === true;
-
-    return {
-        name: 'needle-build',
-        config(config) {
-            if (!config.build) {
-                config.build = {};
-            }
-            if (isDeployOnlyBuild)
-            {
-                console.log("Deploy only build - will not empty output directory")
-                config.build.emptyOutDir = false;
-            }
-        }
-    }
+
+export const needleBuild = (command, config, userSettings) => {
+
+    // TODO: need to set this when building a dist
+    const isDeployOnlyBuild = config?.deployOnly === true;
+
+    return {
+        name: 'needle-build',
+        config(config) {
+            if (!config.build) {
+                config.build = {};
+            }
+            if (isDeployOnlyBuild)
+            {
+                console.log("Deploy only build - will not empty output directory")
+                config.build.emptyOutDir = false;
+            }
+        }
+    }
 }

package/plugins/vite/buildinfo.js

@@ -1,42 +1,42 @@
-import { createBuildInfoFile } from '../common/buildinfo.js';
-import { waitForBuildPipelineToFinish } from './build-pipeline.js';
-import { getOutputDirectory } from './config.js';
-
-let level = 0;
-
-/** Create a buildinfo file in the build directory
- * @param {import('../types').userSettings} userSettings
- * @returns {import('vite').Plugin | null}
- */
-export const needleBuildInfo = (command, config, userSettings) => {
-
-    if (userSettings?.noBuildInfo) return null;
-
-    return {
-        name: 'needle:buildinfo',
-        apply: "build",
-        enforce: "post",
-        buildStart: () => {
-            level++;
-        },
-        closeBundle: async () => {
-            if (--level > 0) {
-                console.log("[needle-buildinfo] - Skipped because of nested build");
-                return;
-            }
-            const task = waitForBuildPipelineToFinish();
-            if (task instanceof Promise) {
-                console.log("[needle-buildinfo] - Waiting for build pipeline to finish");
-                await task.catch(() => { }).finally(() => console.log("[needle-buildinfo] - Build pipeline finished!"));
-            }
-            // wait for gzip
-            await delay(500);
-            const buildDirectory = getOutputDirectory();
-            createBuildInfoFile(buildDirectory);
-        }
-    }
-}
-
-function delay(ms) {
-    return new Promise(res => setTimeout(res, ms));
+import { createBuildInfoFile } from '../common/buildinfo.js';
+import { waitForBuildPipelineToFinish } from './build-pipeline.js';
+import { getOutputDirectory } from './config.js';
+
+let level = 0;
+
+/** Create a buildinfo file in the build directory
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export const needleBuildInfo = (command, config, userSettings) => {
+
+    if (userSettings?.noBuildInfo) return null;
+
+    return {
+        name: 'needle:buildinfo',
+        apply: "build",
+        enforce: "post",
+        buildStart: () => {
+            level++;
+        },
+        closeBundle: async () => {
+            if (--level > 0) {
+                console.log("[needle-buildinfo] - Skipped because of nested build");
+                return;
+            }
+            const task = waitForBuildPipelineToFinish();
+            if (task instanceof Promise) {
+                console.log("[needle-buildinfo] - Waiting for build pipeline to finish");
+                await task.catch(() => { }).finally(() => console.log("[needle-buildinfo] - Build pipeline finished!"));
+            }
+            // wait for gzip
+            await delay(500);
+            const buildDirectory = getOutputDirectory();
+            createBuildInfoFile(buildDirectory);
+        }
+    }
+}
+
+function delay(ms) {
+    return new Promise(res => setTimeout(res, ms));
 }

package/plugins/vite/config.js

@@ -1,107 +1,107 @@
-import { existsSync, readFileSync } from 'fs';
-import path from 'path';
-
-let didLogCanNotFindConfig = false;
-
-/**  the codegen meta file
- * @param {string | null} path
- * @returns {Promise<import("../types/needleConfig").needleMeta | null>}
- */
-export async function loadConfig(path = null) {
-    try {
-        // First try to get the path from the config
-        if (!path) {
-            const configJson = tryLoadProjectConfig();
-            if (configJson?.codegenDirectory) {
-                path = configJson.codegenDirectory + "/meta.json";
-            }
-        }
-        // If that fails, try the default path
-        if (!path)
-            path = './src/generated/meta.json';
-
-        if (existsSync(path)) {
-            const text = readFileSync(path, 'utf8');
-            if (!text) return null;
-            /**@type {import("../types/needleConfig").needleMeta} */
-            const meta = JSON.parse(text);
-            return meta;
-        }
-        else {
-            if (!didLogCanNotFindConfig) {
-                didLogCanNotFindConfig = true;
-                console.error("Could not find config file at " + path);
-            }
-        }
-        return null;
-    }
-    catch (err) {
-        console.error("ERR: Error loading config file");
-        console.error(err);
-        return null;
-    }
-}
-
-/** get the needle.config.json
- * @returns {import("../types/needleConfig").needleConfig | null}
- */
-export function tryLoadProjectConfig() {
-    try {
-        const root = process.cwd();
-        const path = root + '/needle.config.json';
-        if (existsSync(path)) {
-            const text = readFileSync(path);
-            if (!text) return null;
-            const json = JSON.parse(text.toString());
-            return json;
-        }
-    }
-    catch (err) {
-        console.error("Error loading config file");
-        console.error(err);
-    }
-
-    return null;
-}
-
-
-/** "assets" -> the directory name inside the output directory to put e.g. glb files into */
-export function builtAssetsDirectory() {
-    return "assets";
-}
-
-/** @returns the fullpath of the build */
-export function getOutputDirectory() {
-    const projectConfig = tryLoadProjectConfig();
-    if (projectConfig?.buildDirectory) {
-        return path.join(process.cwd(), projectConfig.buildDirectory);
-    }
-
-    // if it's a sveltekit project
-    try {
-        const sveltekitConfig = path.join(process.cwd(), 'svelte.config.js');
-        if (existsSync(sveltekitConfig)) {
-            const regex = /outDir\s?:\s?\"(.*?)\"/g;
-            const content = readFileSync(sveltekitConfig, 'utf8');
-            const match = regex.exec(content);
-            if (match) {
-                const outputPath = path.join(process.cwd(), match[1]);
-                if (existsSync(outputPath)) {
-                    return outputPath;
-                }
-            }
-            else {
-                // default output directory
-                const outputPath = path.join(process.cwd(), 'build');
-                if (existsSync(outputPath)) {
-                    return outputPath;
-                }
-            }
-        }
-    }
-    catch {
-        // ignore
-    }
-
-    return path.join(process.cwd(), 'dist');
+import { existsSync, readFileSync } from 'fs';
+import path from 'path';
+
+let didLogCanNotFindConfig = false;
+
+/**  the codegen meta file
+ * @param {string | null} path
+ * @returns {Promise<import("../types/needleConfig").needleMeta | null>}
+ */
+export async function loadConfig(path = null) {
+    try {
+        // First try to get the path from the config
+        if (!path) {
+            const configJson = tryLoadProjectConfig();
+            if (configJson?.codegenDirectory) {
+                path = configJson.codegenDirectory + "/meta.json";
+            }
+        }
+        // If that fails, try the default path
+        if (!path)
+            path = './src/generated/meta.json';
+
+        if (existsSync(path)) {
+            const text = readFileSync(path, 'utf8');
+            if (!text) return null;
+            /**@type {import("../types/needleConfig").needleMeta} */
+            const meta = JSON.parse(text);
+            return meta;
+        }
+        else {
+            if (!didLogCanNotFindConfig) {
+                didLogCanNotFindConfig = true;
+                console.error("Could not find config file at " + path);
+            }
+        }
+        return null;
+    }
+    catch (err) {
+        console.error("ERR: Error loading config file");
+        console.error(err);
+        return null;
+    }
+}
+
+/** get the needle.config.json
+ * @returns {import("../types/needleConfig").needleConfig | null}
+ */
+export function tryLoadProjectConfig() {
+    try {
+        const root = process.cwd();
+        const path = root + '/needle.config.json';
+        if (existsSync(path)) {
+            const text = readFileSync(path);
+            if (!text) return null;
+            const json = JSON.parse(text.toString());
+            return json;
+        }
+    }
+    catch (err) {
+        console.error("Error loading config file");
+        console.error(err);
+    }
+
+    return null;
+}
+
+
+/** "assets" -> the directory name inside the output directory to put e.g. glb files into */
+export function builtAssetsDirectory() {
+    return "assets";
+}
+
+/** @returns the fullpath of the build */
+export function getOutputDirectory() {
+    const projectConfig = tryLoadProjectConfig();
+    if (projectConfig?.buildDirectory) {
+        return path.join(process.cwd(), projectConfig.buildDirectory);
+    }
+
+    // if it's a sveltekit project
+    try {
+        const sveltekitConfig = path.join(process.cwd(), 'svelte.config.js');
+        if (existsSync(sveltekitConfig)) {
+            const regex = /outDir\s?:\s?\"(.*?)\"/g;
+            const content = readFileSync(sveltekitConfig, 'utf8');
+            const match = regex.exec(content);
+            if (match) {
+                const outputPath = path.join(process.cwd(), match[1]);
+                if (existsSync(outputPath)) {
+                    return outputPath;
+                }
+            }
+            else {
+                // default output directory
+                const outputPath = path.join(process.cwd(), 'build');
+                if (existsSync(outputPath)) {
+                    return outputPath;
+                }
+            }
+        }
+    }
+    catch {
+        // ignore
+    }
+
+    return path.join(process.cwd(), 'dist');
 }

package/plugins/vite/copyfiles.js

@@ -1,139 +1,139 @@
-
-import { resolve, join, isAbsolute } from 'path'
-import { existsSync, statSync, mkdirSync, readdirSync, copyFileSync, mkdir, rmSync } from 'fs';
-import { builtAssetsDirectory, tryLoadProjectConfig } from './config.js';
-import { copyFilesSync } from '../common/files.js';
-
-const pluginName = "needle-copy-files";
-
-
-/** copy files on build from assets to dist 
- * @param {import('../types').userSettings} userSettings
- * @returns {import('vite').Plugin | null}
- */
-export const needleCopyFiles = (command, config, userSettings) => {
-
-    if (config?.noCopy === true || userSettings?.noCopy === true) {
-        return null;
-    }
-
-    return {
-        name: 'needle-copy-files',
-        // explicitly don't enforce post or pre because we want to run before the build-pipeline plugin
-        enforce: "pre",
-        buildStart() {
-            return run("start", config);
-        },
-        closeBundle() {
-            return run("end", config);
-        },
-    }
-}
-
-/**
- * @param {"start" | "end"} buildstep
- * @param {import('../types').userSettings} config
- */
-async function run(buildstep, config) {
-    console.log(`[${pluginName}] - Copy files at ${buildstep}`);
-    const copyIncludesFromEngine = config?.copyIncludesFromEngine ?? true;
-
-    const baseDir = process.cwd();
-    const override = buildstep === "start";
-
-    let assetsDirName = "assets";
-    let outdirName = "dist";
-
-    const needleConfig = tryLoadProjectConfig();
-    if (needleConfig) {
-        assetsDirName = needleConfig.assetsDirectory || assetsDirName;
-        while (assetsDirName.startsWith('/')) assetsDirName = assetsDirName.substring(1);
-
-        if (needleConfig.buildDirectory)
-            outdirName = needleConfig.buildDirectory;
-    }
-
-    if (copyIncludesFromEngine !== false) {
-        // copy include from engine
-        const engineIncludeDir = resolve(baseDir, 'node_modules', '@needle-tools', 'engine', 'src', 'include');
-        if (existsSync(engineIncludeDir)) {
-            console.log(`[${pluginName}] - Copy engine include to ${baseDir}/include`)
-            const projectIncludeDir = resolve(baseDir, 'include');
-            copyFilesSync(engineIncludeDir, projectIncludeDir);
-        }
-    }
-
-    const outDir = resolve(baseDir, outdirName);
-    if (!existsSync(outDir)) {
-        mkdirSync(outDir, { recursive: true });
-    }
-
-    // copy a list of files or directories declared in build.copy = [] in the needle.config.json
-    /*
-    "build": {
-        "copy": ["myFolder", "myFile.txt"]
-    }
-    */
-    if (needleConfig?.build?.copy) {
-        const arr = needleConfig.build.copy;
-        for (let i = 0; i < arr.length; i++) {
-            const entry = arr[i];
-            if (Array.isArray(entry)) {
-                console.log("WARN: build.copy can only contain string paths to copy to. Found array instead.");
-                continue;
-            }
-            const src = resolve(baseDir, entry);
-            const dest = resolvePath(outDir, entry);
-            if (existsSync(src) && dest) {
-                console.log(`[${pluginName}] - Copy ${entry} to ${outdirName}/${entry}`)
-                copyFilesSync(src, dest, override);
-            }
-        }
-    }
-
-    // copy assets dir
-    const assetsDir = resolve(baseDir, assetsDirName);
-    if (existsSync(assetsDir)) {
-        const targetDir = resolve(outDir, 'assets');
-        // ensure that the target directory exists and is cleared if it already exists
-        // otherwise we might run into issues where the build pipeline is running for already compressed files
-        if (override && existsSync(targetDir)) {
-            console.log(`[${pluginName}] - Clearing target directory \"${targetDir}\"`);
-            rmSync(targetDir, { recursive: true, force: true });
-        }
-        console.log(`[${pluginName}] - Copy assets to ${outdirName}/${builtAssetsDirectory()}`)
-        copyFilesSync(assetsDir, targetDir, override);
-    }
-    else console.log(`WARN: No assets directory found. Skipping copy of ${assetsDirName} resolved to ${assetsDir}`)
-
-    // copy include dir
-    const includeDir = resolve(baseDir, 'include');
-    if (existsSync(includeDir)) {
-        console.log(`[${pluginName}] - Copy include to ${outdirName}/include`)
-        const targetDir = resolve(outDir, 'include');
-        copyFilesSync(includeDir, targetDir, override);
-    }
-}
-
-/** resolves relative or absolute paths to a path inside the out directory
- * for example D:/myFile.txt would resolve to outDir/myFile.txt
- * wherereas "some/relative/path" would become outDir/some/relative/path
- * @param {string} outDir
- * @param {string} pathValue
- */
-function resolvePath(outDir, pathValue) {
-    if (isAbsolute(pathValue)) {
-        var exists = existsSync(pathValue);
-        if (!exists) return null;
-        var stats = exists && statSync(pathValue);
-        if (stats.isDirectory()) {
-            const dirName = pathValue.replaceAll('\\', '/').split('/').pop();
-            if (!dirName) return null;
-            return resolve(outDir, dirName);
-        }
-        const fileName = pathValue.replaceAll('\\', '/').split('/').pop();
-        if (!fileName) return null;
-        return resolve(outDir, fileName);
-    }
-    return resolve(outDir, pathValue);
+
+import { resolve, join, isAbsolute } from 'path'
+import { existsSync, statSync, mkdirSync, readdirSync, copyFileSync, mkdir, rmSync } from 'fs';
+import { builtAssetsDirectory, tryLoadProjectConfig } from './config.js';
+import { copyFilesSync } from '../common/files.js';
+
+const pluginName = "needle-copy-files";
+
+
+/** copy files on build from assets to dist 
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export const needleCopyFiles = (command, config, userSettings) => {
+
+    if (config?.noCopy === true || userSettings?.noCopy === true) {
+        return null;
+    }
+
+    return {
+        name: 'needle-copy-files',
+        // explicitly don't enforce post or pre because we want to run before the build-pipeline plugin
+        enforce: "pre",
+        buildStart() {
+            return run("start", config);
+        },
+        closeBundle() {
+            return run("end", config);
+        },
+    }
+}
+
+/**
+ * @param {"start" | "end"} buildstep
+ * @param {import('../types').userSettings} config
+ */
+async function run(buildstep, config) {
+    console.log(`[${pluginName}] - Copy files at ${buildstep}`);
+    const copyIncludesFromEngine = config?.copyIncludesFromEngine ?? true;
+
+    const baseDir = process.cwd();
+    const override = buildstep === "start";
+
+    let assetsDirName = "assets";
+    let outdirName = "dist";
+
+    const needleConfig = tryLoadProjectConfig();
+    if (needleConfig) {
+        assetsDirName = needleConfig.assetsDirectory || assetsDirName;
+        while (assetsDirName.startsWith('/')) assetsDirName = assetsDirName.substring(1);
+
+        if (needleConfig.buildDirectory)
+            outdirName = needleConfig.buildDirectory;
+    }
+
+    if (copyIncludesFromEngine !== false) {
+        // copy include from engine
+        const engineIncludeDir = resolve(baseDir, 'node_modules', '@needle-tools', 'engine', 'src', 'include');
+        if (existsSync(engineIncludeDir)) {
+            console.log(`[${pluginName}] - Copy engine include to ${baseDir}/include`)
+            const projectIncludeDir = resolve(baseDir, 'include');
+            copyFilesSync(engineIncludeDir, projectIncludeDir);
+        }
+    }
+
+    const outDir = resolve(baseDir, outdirName);
+    if (!existsSync(outDir)) {
+        mkdirSync(outDir, { recursive: true });
+    }
+
+    // copy a list of files or directories declared in build.copy = [] in the needle.config.json
+    /*
+    "build": {
+        "copy": ["myFolder", "myFile.txt"]
+    }
+    */
+    if (needleConfig?.build?.copy) {
+        const arr = needleConfig.build.copy;
+        for (let i = 0; i < arr.length; i++) {
+            const entry = arr[i];
+            if (Array.isArray(entry)) {
+                console.log("WARN: build.copy can only contain string paths to copy to. Found array instead.");
+                continue;
+            }
+            const src = resolve(baseDir, entry);
+            const dest = resolvePath(outDir, entry);
+            if (existsSync(src) && dest) {
+                console.log(`[${pluginName}] - Copy ${entry} to ${outdirName}/${entry}`)
+                copyFilesSync(src, dest, override);
+            }
+        }
+    }
+
+    // copy assets dir
+    const assetsDir = resolve(baseDir, assetsDirName);
+    if (existsSync(assetsDir)) {
+        const targetDir = resolve(outDir, 'assets');
+        // ensure that the target directory exists and is cleared if it already exists
+        // otherwise we might run into issues where the build pipeline is running for already compressed files
+        if (override && existsSync(targetDir)) {
+            console.log(`[${pluginName}] - Clearing target directory \"${targetDir}\"`);
+            rmSync(targetDir, { recursive: true, force: true });
+        }
+        console.log(`[${pluginName}] - Copy assets to ${outdirName}/${builtAssetsDirectory()}`)
+        copyFilesSync(assetsDir, targetDir, override);
+    }
+    else console.log(`WARN: No assets directory found. Skipping copy of ${assetsDirName} resolved to ${assetsDir}`)
+
+    // copy include dir
+    const includeDir = resolve(baseDir, 'include');
+    if (existsSync(includeDir)) {
+        console.log(`[${pluginName}] - Copy include to ${outdirName}/include`)
+        const targetDir = resolve(outDir, 'include');
+        copyFilesSync(includeDir, targetDir, override);
+    }
+}
+
+/** resolves relative or absolute paths to a path inside the out directory
+ * for example D:/myFile.txt would resolve to outDir/myFile.txt
+ * wherereas "some/relative/path" would become outDir/some/relative/path
+ * @param {string} outDir
+ * @param {string} pathValue
+ */
+function resolvePath(outDir, pathValue) {
+    if (isAbsolute(pathValue)) {
+        var exists = existsSync(pathValue);
+        if (!exists) return null;
+        var stats = exists && statSync(pathValue);
+        if (stats.isDirectory()) {
+            const dirName = pathValue.replaceAll('\\', '/').split('/').pop();
+            if (!dirName) return null;
+            return resolve(outDir, dirName);
+        }
+        const fileName = pathValue.replaceAll('\\', '/').split('/').pop();
+        if (!fileName) return null;
+        return resolve(outDir, fileName);
+    }
+    return resolve(outDir, pathValue);
 }