@bf6mods/cli 1.0.1 → 1.1.0

package/README.md

@@ -7,15 +7,17 @@ Create Battlefield 6 mods quickly with a vite like development experience.
 To create a new project, simply run the following command and answer the questions
 
 ```
-npx bf6mods init
+npx @bf6mods/cli init
 ```
 
+![Initializing a repo](https://raw.githubusercontent.com/bf6mods/bf6mods/refs/heads/main/media/terminal.gif "Initializing a repo")
+
 ## Import from JSON
 
 Already have a project? Just export your currently existing project in [portal.battlefield.com](https://portal.battlefield.com), and run...
 
 ```
-npx bf6mods import <input> <output>
+npx @bf6mods/cli import <input> <output>
 ```
 
 ## Deploying Project to Portal
@@ -27,8 +29,9 @@ Just run `npm run build` in your project dir, open [portal.battlefield.com](http
 - Use multiple different files, instead of just one large TypeScript file!
 - Use a programatic interface for defining your gamemode.
 - Extensive documentation
-- Extended standard library
+- Extended standard library (still in progress)
 - Hot reload
+- Automatic string injection
 
 ## Structure
 
@@ -68,3 +71,7 @@ export default defineBf6Config({
 ## @bf6mods/sdk
 
 This is a seperate library that exports the `PortalSdk`'s `mod` and `modlib`. Additionally it exports some stdlib helper functions and classes to help accelerate development.
+
+## Join the discord with fellow modders!
+
+You can join the discord by clicking this [link](https://discord.gg/2gJ9fheYYK)!

package/dist/cli/index.js

@@ -6,7 +6,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@bf6mods/cli",
-  version: "1.0.1",
+  version: "1.0.2",
   description: "CLI and library for bundling BF6 mods",
   license: "MIT",
   type: "module",
@@ -28,8 +28,12 @@ var package_default = {
   files: [
     "dist/"
   ],
+  repository: {
+    type: "git",
+    url: "git+https://github.com/bf6mods/bf6mods.git"
+  },
   dependencies: {
-    "@bf6mods/sdk": "1.0.1",
+    "@bf6mods/sdk": "1.0.3",
     "@clack/prompts": "^0.11.0",
     chokidar: "^4.0.3",
     colors: "^1.4.0",
@@ -43,15 +47,17 @@ var package_default = {
     access: "public"
   },
   devDependencies: {
+    "@oxc-project/types": "^0.95.0",
     "@types/stringify-object": "^4.0.5",
     "cross-env": "^10.1.0",
     tsx: "^4.20.6"
   }
 };
 
-// src/cli/build.ts
+// src/cli/build/index.ts
 import fs from "fs";
 import path from "path";
+import { fileURLToPath } from "url";
 import {
   AttachmentType
 } from "@bf6mods/sdk";
@@ -72,7 +78,156 @@ var MapId = /* @__PURE__ */ ((MapId2) => {
   return MapId2;
 })(MapId || {});
 
-// src/cli/build.ts
+// src/cli/build/generated-strings.ts
+function extractBf6Strings(bf6Strings, generateFromLiterals) {
+  return {
+    name: "extract-bf6-strings",
+    generateBundle(_options, bundle) {
+      if (!generateFromLiterals) return;
+      let id = 0;
+      const existingStrings = new Set(Object.values(bf6Strings));
+      for (const [_file, output] of Object.entries(bundle)) {
+        let walk2 = function(node) {
+          if (node.type === "Literal") {
+            if (typeof node.value !== "string" || node.value === "" || node.value === "----uniquename----")
+              return;
+            if (!(node.value in bf6Strings) && !existingStrings.has(node.value)) {
+              existingStrings.add(node.value);
+              bf6Strings[`__auto__${id++}`] = node.value;
+            }
+          }
+          for (const value of Object.values(node)) {
+            if (!value) continue;
+            if (Array.isArray(value)) {
+              for (const v of value) {
+                if (v && typeof v === "object" && "type" in v) walk2(v);
+              }
+            } else if (typeof value === "object" && "type" in value) {
+              walk2(value);
+            }
+          }
+        };
+        var walk = walk2;
+        if (output.type !== "chunk") continue;
+        const code = output.code;
+        const program2 = this.parse(code, {
+          lang: "ts",
+          astType: "js",
+          range: true
+        });
+        for (const item of program2.body) {
+          walk2(item);
+        }
+      }
+    },
+    moduleParsed(moduleInfo) {
+      if (moduleInfo.code && moduleInfo.exports.includes("bf6Strings")) {
+        const code = moduleInfo.code;
+        const getSnippet = (start, end, linesBefore = 2, linesAfter = 2) => {
+          const lines = code.split(/\r?\n/);
+          const startLine = Math.max(
+            0,
+            code.slice(0, start).split(/\r?\n/).length - 1 - linesBefore
+          );
+          const endLine = Math.min(
+            lines.length,
+            code.slice(0, end).split(/\r?\n/).length - 1 + linesAfter
+          );
+          return lines.slice(startLine, endLine).map((line, i) => {
+            const actualLine = startLine + i + 1;
+            return `${actualLine.toString().padStart(3)} | ${line}`;
+          }).join("\n");
+        };
+        const program2 = this.parse(code, {
+          lang: "ts",
+          astType: "js",
+          range: true
+        });
+        const extractObjectLiteral = (declaration) => {
+          if (declaration.init?.type !== "ObjectExpression") {
+            const snippet = getSnippet(...declaration.range ?? [0, 0]);
+            this.error(
+              `\u274C Invalid bf6Strings export: expected an object literal.
+
+${snippet}`
+            );
+          }
+          for (const property of declaration.init.properties) {
+            if (property.type !== "Property") {
+              const snippet = getSnippet(...property.range ?? [0, 0]);
+              this.error(
+                `\u274C Invalid bf6Strings property: expected a key/value pair.
+Found type: ${property.type}
+
+${snippet}`
+              );
+            }
+            let key = void 0;
+            if (property.key.type === "Literal") {
+              key = property.key.value;
+            } else if (property.key.type === "Identifier") {
+              key = property.key.name;
+            } else {
+              const snippet = getSnippet(...property.range ?? [0, 0]);
+              this.error(
+                `\u274C Invalid bf6Strings key: expected a string literal or identifier.
+Found type: ${property.key.type}
+
+${snippet}`
+              );
+              continue;
+            }
+            if (property.value.type !== "Literal") {
+              const snippet = getSnippet(...property.range ?? [0, 0]);
+              this.error(
+                `\u274C Invalid bf6Strings value: expected a string literal.
+Found type: ${property.value.type}
+
+${snippet}`
+              );
+            }
+            const value = property.value.value;
+            if (typeof key !== "string" && typeof key !== "number" && typeof key !== "bigint" && typeof key !== "boolean") {
+              const snippet = getSnippet(...property.range ?? [0, 0]);
+              this.error(
+                `\u274C bf6Strings key must be a string, found: ${typeof key}
+
+${snippet}`
+              );
+            }
+            if (typeof value !== "string" && typeof value !== "number" && typeof value !== "bigint" && typeof value !== "boolean") {
+              const snippet = getSnippet(...property.range ?? [0, 0]);
+              this.error(
+                `\u274C bf6Strings value must be a string, found: ${typeof value}
+
+${snippet}`
+              );
+            }
+            bf6Strings[`${key}`] = `${value}`;
+          }
+        };
+        for (const item of program2.body) {
+          if (item.type === "VariableDeclaration") {
+            for (const declaration of item.declarations) {
+              if (declaration.type === "VariableDeclarator" && declaration.id.type === "Identifier" && declaration.id.name === "bf6Strings") {
+                extractObjectLiteral(declaration);
+              }
+            }
+          }
+          if (item.type === "ExportNamedDeclaration" && item.declaration?.type === "VariableDeclaration") {
+            for (const declaration of item.declaration.declarations) {
+              if (declaration.type === "VariableDeclarator" && declaration.id.type === "Identifier" && declaration.id.name === "bf6Strings") {
+                extractObjectLiteral(declaration);
+              }
+            }
+          }
+        }
+      }
+    }
+  };
+}
+
+// src/cli/build/index.ts
 async function getBf6Config(rootDir) {
   globalThis.defineBf6Config = (c) => c;
   globalThis.MapId = MapId;
@@ -90,39 +245,43 @@ async function build() {
     fs.rmSync(outDir, { recursive: true, force: true });
   fs.mkdirSync(outDir, { recursive: true });
   const minifyJson = typeof config.minify === "boolean" ? config.minify : config.minify?.json ?? false;
+  const generatedStrings = {};
   let tsAttachment;
   if (config.entrypoint) {
     const entryAbs = path.resolve(workingDir, config.entrypoint);
     const compiled = await buildEntrypoint(
       entryAbs,
-      outDir,
-      !!config.outputArtifacts
+      generatedStrings,
+      config.generateStrings ?? true
     );
     tsAttachment = createTsAttachment(entryAbs, compiled);
   }
   const { attachments, mapRotation } = await collectAttachments(
     config,
     workingDir,
-    tsAttachment
+    tsAttachment,
+    generatedStrings
   );
   await writeModJson(config, outDir, attachments, mapRotation, minifyJson);
   console.log(`\u2714 Built mod: ${config.name}`);
 }
-async function buildEntrypoint(entry, outDir, emit) {
+async function buildEntrypoint(entry, bf6Strings, generateStringsFromLiterals) {
   const bundle = await rolldown({
-    input: entry
+    input: entry,
+    plugins: [extractBf6Strings(bf6Strings, generateStringsFromLiterals)],
+    logLevel: "debug"
   });
   const result = await bundle.generate({
     format: "esm",
     inlineDynamicImports: true
   });
   const code = result.output[0].code;
-  if (emit) {
-    await fs.promises.writeFile(path.resolve(outDir, "index.js"), code);
-  }
   return code;
 }
-async function collectAttachments(config, workingDir, tsAttachment) {
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = path.dirname(__filename);
+var spatialsDir = path.resolve(__dirname, "../resources/maps/spatial");
+async function collectAttachments(config, workingDir, tsAttachment, generatedStrings) {
   const attachments = [];
   const mapRotation = [];
   if (tsAttachment) attachments.push(tsAttachment);
@@ -130,11 +289,20 @@ async function collectAttachments(config, workingDir, tsAttachment) {
     const strPath = path.resolve(workingDir, config.strings);
     if (!fs.existsSync(strPath)) throw new Error("Cannot find strings file");
     const raw = await fs.promises.readFile(strPath, "utf8");
-    attachments.push(createStringsAttachment(strPath, raw));
+    const attachment = createStringsAttachment(strPath, raw, generatedStrings);
+    attachments.push(attachment);
   }
   if (config.scenes) {
     let mapIdx = 0;
-    for (const [mapId, scene] of config.scenes) {
+    for (const map of config.scenes) {
+      let mapId;
+      let scene;
+      if (Array.isArray(map)) {
+        [mapId, scene] = map;
+      } else {
+        mapId = map;
+        scene = path.resolve(spatialsDir, `${mapId}.spatial.json`);
+      }
       const scenePath = path.resolve(workingDir, scene);
       if (!fs.existsSync(scenePath))
         throw new Error(`Cannot find spatial data file: ${scene}`);
@@ -160,6 +328,19 @@ async function writeModJson(config, outDir, attachments, mapRotation, minify) {
   };
   const jsonOutput = minify ? JSON.stringify(finalJson) : JSON.stringify(finalJson, null, 2);
   await fs.promises.writeFile(path.resolve(outDir, "mod.json"), jsonOutput);
+  if (config.outputArtifacts && finalJson?.attachments) {
+    for (const attachment of finalJson.attachments) {
+      const attachmentsDir = path.resolve(outDir, "attachments");
+      if (!fs.existsSync(attachmentsDir))
+        fs.mkdirSync(attachmentsDir, {
+          recursive: true
+        });
+      await fs.promises.writeFile(
+        path.resolve(outDir, "attachments", attachment.filename),
+        atob(attachment.attachmentData.original)
+      );
+    }
+  }
 }
 function createTsAttachment(filePath, compiled) {
   return {
@@ -173,7 +354,18 @@ function createTsAttachment(filePath, compiled) {
     errors: []
   };
 }
-function createStringsAttachment(filePath, raw) {
+function createStringsAttachment(filePath, raw, generatedStrings) {
+  let result = raw;
+  if (generatedStrings) {
+    result = JSON.stringify(
+      {
+        ...generatedStrings,
+        ...JSON.parse(raw)
+      },
+      null,
+      4
+    );
+  }
   return {
     id: crypto.randomUUID(),
     version: "1.0",
@@ -181,7 +373,7 @@ function createStringsAttachment(filePath, raw) {
     isProcessable: true,
     processingStatus: 2,
     attachmentType: AttachmentType.Strings,
-    attachmentData: { original: toBase64(raw), compiled: "" },
+    attachmentData: { original: toBase64(result), compiled: "" },
     errors: []
   };
 }
@@ -293,11 +485,11 @@ import stringifyObject from "stringify-object";
 import child_process from "child_process";
 import fs3 from "fs";
 import path3 from "path";
-import { fileURLToPath } from "url";
+import { fileURLToPath as fileURLToPath2 } from "url";
 import * as prompts from "@clack/prompts";
-var __filename = fileURLToPath(import.meta.url);
-var __dirname = path3.dirname(__filename);
-var templatesDir = path3.resolve(__dirname, "../resources/templates");
+var __filename2 = fileURLToPath2(import.meta.url);
+var __dirname2 = path3.dirname(__filename2);
+var templatesDir = path3.resolve(__dirname2, "../resources/templates");
 function renameFilesRecursively(dir, modName) {
   const entries = fs3.readdirSync(dir, { withFileTypes: true });
   for (const entry of entries) {
@@ -540,7 +732,7 @@ function stringifyWithRaw(value, options = {}) {
 // src/cli/prepare.ts
 import fs5 from "fs";
 import path5 from "path";
-import { fileURLToPath as fileURLToPath2 } from "url";
+import { fileURLToPath as fileURLToPath3 } from "url";
 import colors3 from "colors";
 import { genExport, genInlineTypeImport } from "knitwork";
 
@@ -580,11 +772,11 @@ var printToConsole = (message) => {
 // src/cli/prepare.ts
 async function prepare() {
   try {
-    const __filename2 = fileURLToPath2(import.meta.url);
-    const __dirname2 = path5.dirname(__filename2);
+    const __filename3 = fileURLToPath3(import.meta.url);
+    const __dirname3 = path5.dirname(__filename3);
     const _workingDir = path5.resolve(".");
     const buildDir = path5.resolve(".bf6");
-    const resources = path5.resolve(__dirname2, "../resources/prepare");
+    const resources = path5.resolve(__dirname3, "../resources/prepare");
     fs5.cpSync(
       path5.resolve(resources, "tsconfig.json"),
       path5.resolve(buildDir, "tsconfig.json")