bc-deeplib 2.4.1 → 3.0.0

package/dist/vendored_types/declarations.d.ts

@@ -28,7 +28,16 @@ declare const MOD_VERSION: string;
  * Used for build identification.
  * @example "a1b2c3d4"
  */
-declare const VERSION_HASH: string;
+declare const COMMIT_HASH: string;
+
+/**
+ * The current mod version caption.
+ * 
+ * This value is computed at build time depending on IS_DEVEL.
+ * @example
+ * IS_DEVEL === true ? "1.0.0 (a1b2c3d4)" : "1.0.0"
+ */
+declare const MOD_VERSION_CAPTION: string;
 
 /**
  * Whether the build is a development build.

package/dist/vendored_types/utility.d.ts

@@ -1,3 +1,5 @@
 type Prettify<T> = {
   [K in keyof T]: T[K];
-} & unknown;
+} & unknown;
+
+type Thunk<T> = T | (() => T);

package/lib/build.js

@@ -106,8 +106,9 @@ async function buildMod({
   const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
 
   const git = simpleGit({ baseDir: process.cwd() });
-  const LAST_COMMIT_HASH = await git.log({ maxCount: 1 });
-  const VERSION_HASH = LAST_COMMIT_HASH?.latest?.hash.substring(0, 8);
+  const VERSION = packageJson.version;  
+  const COMMIT_HASH = (await git.log({ maxCount: 1 }))?.latest?.hash.substring(0, 8);
+  const VERSION_CAPTION = IS_DEVEL ? `${VERSION} - ${COMMIT_HASH}` : VERSION;
 
   /** @type {import('esbuild').BuildOptions} */
   const buildOptions = {
@@ -122,15 +123,16 @@ async function buildMod({
     keepNames: true,
     define: {
       PUBLIC_URL: JSON.stringify(PUBLIC_URL),
-      MOD_VERSION: JSON.stringify(packageJson.version),
-      VERSION_HASH: JSON.stringify(VERSION_HASH),
+      MOD_VERSION: JSON.stringify(VERSION),
+      COMMIT_HASH: JSON.stringify(COMMIT_HASH),
+      MOD_VERSION_CAPTION: JSON.stringify(VERSION_CAPTION),
       IS_DEVEL: JSON.stringify(IS_DEVEL),
       IS_DEBUG: JSON.stringify(cliAllowDebug),
       ...defines
     },
     plugins: [progress(), time(), ...plugins],
   };
-  
+
   /** @type {NodeJS.Timeout | null} */
   let buildTimeout = null;
   const DEBOUNCE_MS = 100; // Adjust as needed
@@ -144,21 +146,21 @@ async function buildMod({
     const assetsSrc = path.resolve(__dirname, '../dist/public');
     const assetsDest = path.resolve(process.cwd(), distDirName, publicDirName);
 
-    await build(buildOptions);
-    copyMatchingFiles(assetsSrc, assetsDest);
+    try {
+      await build(buildOptions);
+      copyMatchingFiles(assetsSrc, assetsDest);
 
-    for (const script of scripts) {
-      try {
+      for (const script of scripts) {
         const { stdout } = await execAsync(`node ${script}`);
         console.log(stdout);
-      } catch (err) {
-        console.error(err);
       }
+    } catch (error) {
+      console.error(error);
     }
   }
 
   await runBuild();
-    
+
   if (isLocal) {
 
     if (isWatch) {
@@ -173,7 +175,7 @@ async function buildMod({
       watcher.on('change', debounceRunBuild);
       console.info('🔭 Watching for changes...');
     }
-    
+
     if (isServe) {
       try {
         serveWithCORS(distDirName, port, host);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bc-deeplib",
-  "version": "2.4.1",
+  "version": "3.0.0",
   "author": "dDeepLb",
   "description": "Library for easier development of BC mods, which strives to be a framework :D",
   "license": "MIT",
@@ -33,10 +33,10 @@
     "npm-dts": "^1.3.13",
     "sass": "^1.92.1",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.43.0"
+    "typescript-eslint": "^8.43.0",
+    "bondage-club-mod-sdk": "^1.2.0"
   },
   "dependencies": {
-    "bondage-club-mod-sdk": "^1.2.0",
     "serve-static": "^2.2.0",
     "simple-git": "^3.28.0",
     "finalhandler": "^2.1.0",
@@ -48,10 +48,13 @@
     "esbuild-sass-plugin": "^3.3.1"
   },
   "scripts": {
-    "all": "pnpm build && pnpm type-gen && pnpm asset-copy",
-    "lint": "eslint src/",
+    "all": "pnpm type:check && pnpm build && pnpm type:gen && pnpm type:copy && pnpm asset:copy",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "build": "node scripts/build.js",
-    "type-gen": "node scripts/type_gen.js",
-    "asset-copy": "node scripts/asset_copy.js"
+    "type:check": "tsc --noEmit",
+    "type:gen": "npm-dts generate -e ./src/deeplib.ts -o ./dist/deeplib.d.ts -L error",
+    "type:copy": "node scripts/type_copy.js",
+    "asset:copy": "node scripts/asset_copy.js"
   }
 }