bc-deeplib 4.0.0 → 5.0.0

package/dist/vendored_types/declarations.d.ts

@@ -51,4 +51,18 @@ declare const IS_DEVEL: boolean;
  * 
  * `true` when mod is built with `--debug`/`-d`.
  */
-declare const IS_DEBUG: boolean;
+declare const IS_DEBUG: boolean;
+
+/**
+ * The current Deeplib version.
+ * 
+ * This value is set at build time and configured via `version` field in the `package.json` file of this package.
+ */
+declare const DEEPLIB_VERSION: string;
+
+/**
+ * The current mod info.
+ * 
+ * This value is set at build time and configured via `modInfo` field in the `deeplib.config.js` file.
+ */
+declare const MOD_INFO: Omit<import('bondage-club-mod-sdk').ModSDKModInfo, 'version'>;

package/lib/build.d.ts

@@ -1,10 +1,10 @@
 export declare interface BuildConfig {
   /** Entry file located in `src/` */
-  entry?: string,
+  entry: string,
   /** Output file located in `{distDirName}/` */
-  outfile?: string,
-  /** Global name of the mod */
-  globalName: string,
+  outfile: string,
+  /** Mod info to register with the Mod SDK */
+  modInfo: Omit<import('bondage-club-mod-sdk').ModSDKModInfo, 'version'>,
   /** Directory name of the dist folder, where the mod will be built */
   distDirName?: string,
   /** Directory name of the public folder, where the mod assets will be copied */
@@ -12,21 +12,15 @@ export declare interface BuildConfig {
   /** `node` scripts to run */
   scripts?: string[],
   /** URL to the mod on the production server */
-  prodRemoteURL: string,
+  prodRemoteURL?: string,
   /** URL to the mod on the development server */
-  devRemoteURL: string,
-  /** Target version of the build */
-  target?: string[],
-  /** Additional esbuild plugins */
-  plugins?: import('esbuild').Plugin[],
-  /** Additional esbuild defines (like global variables) */
-  defines?: {
-    [key: string]: unknown
-  },
+  devRemoteURL?: string,
   /** Host of the local dev server */
   host?: string,
   /** Port of the local dev server */
-  port?: number
+  port?: number,
+  /** Additional esbuild options (target, plugins, define, globalName, etc.) */
+  esbuildOptions?: import('esbuild').BuildOptions,
 } 
 
-export declare function defineConfig(config: BuildConfig): BuildConfig;
+export declare function defineConfig(config: BuildConfig, esbuildOptions?: import('esbuild').BuildOptions): BuildConfig;

package/lib/{build.js → deeplib.js}

@@ -6,88 +6,135 @@ import { watch } from 'chokidar';
 import { build } from 'esbuild';
 import progress from 'esbuild-plugin-progress';
 import time from 'esbuild-plugin-time';
-import { existsSync, readFileSync, readdirSync, mkdirSync, copyFileSync } from 'fs';
+import { existsSync, readFileSync, readdirSync, mkdirSync, copyFileSync, writeFileSync } from 'fs';
 import path, { dirname } from 'path';
 import simpleGit from 'simple-git';
 import { fileURLToPath, pathToFileURL } from 'url';
 import { promisify } from 'util';
 import http from 'http';
 import serveStatic from 'serve-static';
-import finalhandler from 'finalhandler';
+import { Command } from 'commander';
 
 const execAsync = promisify(exec);
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+const packageJsonPath = path.resolve(__dirname, '../package.json');
+const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+const thisVersion = packageJson.version;
+
 /**
  * @param {import('./build').BuildConfig} config 
- * @returns {Required<import('./build').BuildConfig>}
+ * @param {import('esbuild').BuildOptions} [esbuildOptions]
+ * @returns {import('./build').BuildConfig}
  */
-export function defineConfig(config) {
+export function defineConfig(config, esbuildOptions) {
+  const defaultEsbuildOptions = {
+    target: [],
+    plugins: [],
+    define: {},
+    ...esbuildOptions
+  };
+
   return {
-    entry: 'index.ts',
-    outfile: 'index.js',
     distDirName: 'dist',
     publicDirName: 'public',
     scripts: [],
-    target: [],
-    plugins: [],
-    defines: {},
     host: 'localhost',
-    port: 45000,
-    ...config
+    port: Math.min(3000, Math.floor(Math.random() * 10000)),
+    ...config,
+    // Merge esbuildOptions from parameter, default, and config
+    esbuildOptions: {
+      ...defaultEsbuildOptions,
+      ...config.esbuildOptions,
+      // Deep merge plugins array
+      plugins: [
+        ...(defaultEsbuildOptions.plugins || []),
+        ...(config.esbuildOptions?.plugins || [])
+      ],
+      // Deep merge define object
+      define: {
+        ...(defaultEsbuildOptions.define || {}),
+        ...(config.esbuildOptions?.define || {})
+      }
+    }
   };
 }
 
-async function runDeeplibBuild() {
+function initConfig() {
+  const configPath = path.resolve(process.cwd(), 'deeplib.config.js');
+
+  if (existsSync(configPath)) {
+    console.error('❌ deeplib.config.js already exists in the project root');
+    process.exit(1);
+  }
+
+  const defaultConfig = `import { defineConfig } from 'bc-deeplib/build';
+
+export default defineConfig({
+  entry: 'index.ts',
+  outfile: 'index.js',
+  modInfo: {
+    name: 'ModName',
+    fullName: 'ModFullName',
+    repository: 'https://github.com/ModAuthor/ModRepository'
+  },
+  esbuildOptions: {
+    globalName: 'ModName',
+    target: ['es2020']
+  }
+});
+`;
+
+  writeFileSync(configPath, defaultConfig, 'utf-8');
+  console.log('✅ Created deeplib.config.js with default configuration');
+  console.log('📝 Please update the following in deeplib.config.js:');
+  console.log('   - entry: path to your entry file in src/');
+  console.log('   - outfile: name of the output file');
+  console.log('   - esbuildOptions.globalName: your mod\'s global name');
+  console.log('   - esbuildOptions.target: target JavaScript version(s)');
+  console.log('   - Add any additional esbuild options in esbuildOptions');
+}
+
+/**
+ * @param {{ watch?: boolean, serve?: boolean, libLocal?: boolean, debug?: boolean }} options
+ */
+async function runDeeplib(options) {
   const configPath = path.resolve(process.cwd(), 'deeplib.config.js');
 
   if (!existsSync(configPath)) {
     console.error('❌ Missing deeplib.config.js in project root');
+    console.error('💡 Run "deeplib init" to create a default config file');
     process.exit(1);
   }
 
   const { default: config } = await import(pathToFileURL(configPath).toString());
-  await buildMod(config);
+  await buildMod(config, options);
 }
 
 /**
  * @param {Required<import('./build').BuildConfig>} config 
+ * @param {{ watch?: boolean, serve?: boolean, libLocal?: boolean, debug?: boolean }} options
  */
 async function buildMod({
   entry,
   outfile,
-  globalName,
+  modInfo,
   distDirName,
   publicDirName,
   scripts,
   prodRemoteURL,
   devRemoteURL,
-  target,
-  plugins,
-  defines,
   host,
-  port
-}) {
-  if (process.argv.includes('--help') || process.argv.includes('-h')) {
-    console.log(`
-			Usage: deeplib [options]
-
-			Options:
-				--help, -h              Show this help message
-				--watch, -w             Watch for changes and rebuild
-				--serve, -s             Serve mod on http://${host}:${port}
-				--lib-local, -l         Use local build of deeplib
-				--debug, -d             Enable debug mode
-		`.replaceAll('\t', ''));
-    return;
-  }
+  port,
+  esbuildOptions = {}
+}, options = {}) {
   const cliLocal = !process.env.environment;
-  const cliWatch = process.argv.includes('--watch') || process.argv.includes('-w');
-  const cliServe = process.argv.includes('--serve') || process.argv.includes('-s');
-  const cliLibLocal = process.argv.includes('--lib-local') || process.argv.includes('-l');
-  const cliAllowDebug = process.argv.includes('--debug') || process.argv.includes('-d');
+  const cliWatch = options.watch || false;
+  const cliServe = options.serve || false;
+  const cliLibLocal = options.libLocal || false;
+  const cliAllowDebug = options.debug || false;
 
   const envMode = process.env.environment || 'production';
   const mode = cliLocal ? 'local' : envMode;
@@ -105,22 +152,28 @@ async function buildMod({
   const packageJsonPath = path.resolve(process.cwd(), 'package.json');
   const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
 
-  const git = simpleGit({ baseDir: process.cwd() });
-  const VERSION = packageJson.version;  
-  const COMMIT_HASH = (await git.log({ maxCount: 1 }))?.latest?.hash.substring(0, 8);
+  const VERSION = packageJson.version;
+
+  let COMMIT_HASH = '';
+  try {
+    if (await simpleGit().checkIsRepo()) {
+      COMMIT_HASH = (await simpleGit().log({ maxCount: 1 }))?.latest?.hash?.substring(0, 8) ?? '';
+    }
+  } catch (_) {
+    COMMIT_HASH = 'unknown';
+  }
   const VERSION_CAPTION = IS_DEVEL ? `${VERSION} - ${COMMIT_HASH}` : VERSION;
 
   /** @type {import('esbuild').BuildOptions} */
   const buildOptions = {
-    entryPoints: [`src/${entry}`],
-    outfile: `${distDirName}/${outfile}`,
     format: 'iife',
-    globalName,
     bundle: true,
     sourcemap: true,
-    target,
     treeShaking: true,
     keepNames: true,
+    ...esbuildOptions,
+    entryPoints: [`src/${entry}`],
+    outfile: `${distDirName}/${outfile}`,
     define: {
       PUBLIC_URL: JSON.stringify(PUBLIC_URL),
       MOD_VERSION: JSON.stringify(VERSION),
@@ -128,9 +181,10 @@ async function buildMod({
       MOD_VERSION_CAPTION: JSON.stringify(VERSION_CAPTION),
       IS_DEVEL: JSON.stringify(IS_DEVEL),
       IS_DEBUG: JSON.stringify(cliAllowDebug),
-      ...defines
+      MOD_INFO: JSON.stringify(modInfo),
+      ...(esbuildOptions.define || {})
     },
-    plugins: [progress(), time(), ...plugins],
+    plugins: [progress(), time(), ...(esbuildOptions.plugins || [])]
   };
 
   /** @type {NodeJS.Timeout | null} */
@@ -193,13 +247,23 @@ async function buildMod({
  */
 function serveWithCORS(dir, port, host) {
   const serve = serveStatic(dir, {
+    /** @param {import('http').ServerResponse} res */
     setHeaders: (res) => {
       res.setHeader('Access-Control-Allow-Origin', '*');
     }
   });
 
   const server = http.createServer((req, res) => {
-    serve(req, res, finalhandler(req, res));
+    serve(req, res, (err) => {
+      if (err) {
+        res.statusCode = err.statusCode || 500;
+        res.end(err.message || 'Internal Server Error');
+        return;
+      }
+
+      res.statusCode = 404;
+      res.end('Not Found');
+    });
   });
 
   server.listen(port, host, () => {
@@ -248,4 +312,28 @@ function relativeToProject(absolutePath) {
   return path.relative(process.cwd(), absolutePath);
 }
 
-runDeeplibBuild();
+const program = new Command();
+
+program
+  .name('deeplib')
+  .description('Build tool for BC mods using DeepLib')
+  .version(thisVersion);
+
+program
+  .command('init')
+  .description('Create a default deeplib.config.js file')
+  .action(() => {
+    initConfig();
+  });
+
+// Build command (default)
+program
+  .option('-w, --watch', 'Watch for changes and rebuild')
+  .option('-s, --serve', 'Serve mod on local dev server')
+  .option('-l, --lib-local', 'Use local build of deeplib')
+  .option('-d, --debug', 'Enable debug mode')
+  .action(async (options) => {
+    await runDeeplib(options);
+  });
+
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bc-deeplib",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "author": "dDeepLb",
   "description": "Library for easier development of BC mods, which strives to be a framework :D",
   "license": "MIT",
@@ -17,38 +17,39 @@
       "import": "./dist/deeplib.js"
     },
     "./build": {
-      "import": "./lib/build.js"
+      "import": "./lib/deeplib.js"
     }
   },
   "bin": {
-    "deeplib": "./lib/build.js"
+    "deeplib": "./lib/deeplib.js"
   },
   "devDependencies": {
-    "@eslint/js": "^9.35.0",
-    "@stylistic/eslint-plugin": "^5.3.1",
-    "@types/node": "^22.13.10",
-    "bc-stubs": "121.0.0",
-    "eslint": "^9.35.0",
-    "globals": "^16.4.0",
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/node": "^22.19.19",
+    "bc-stubs": "128.0.0",
+    "bondage-club-mod-sdk": "^1.2.0",
+    "eslint": "^10.4.0",
+    "globals": "^17.6.0",
     "npm-dts": "^1.3.13",
-    "sass": "^1.92.1",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.43.0",
-    "bondage-club-mod-sdk": "^1.2.0"
+    "sass": "^1.99.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.4"
   },
   "dependencies": {
-    "serve-static": "^2.2.0",
-    "simple-git": "^3.28.0",
-    "finalhandler": "^2.1.0",
-    "fs-extra": "^11.3.1",
-    "chokidar": "^4.0.3",
-    "esbuild": "^0.25.9",
-    "esbuild-plugin-progress": "^1.3.0",
+    "chokidar": "^5.0.0",
+    "commander": "^14.0.3",
+    "esbuild": "^0.28.0",
+    "esbuild-plugin-progress": "^1.3.9",
     "esbuild-plugin-time": "^1.0.0",
-    "esbuild-sass-plugin": "^3.3.1"
+    "esbuild-sass-plugin": "^3.7.0",
+    "fs-extra": "^11.3.5",
+    "js-logger": "^1.6.1",
+    "serve-static": "^2.2.1",
+    "simple-git": "^3.36.0"
   },
   "scripts": {
-    "all": "pnpm type:check && pnpm build && pnpm type:gen && pnpm type:copy && pnpm asset:copy",
+    "all": "pnpm lint && 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",