game-data-gen 2.3.0 → 3.0.1

package/README.md

@@ -16,7 +16,7 @@ If you're making a game in Javascript then you might (this was actually me):
 
 This library:
 
-- creates data structures based on a very easy syntax (I tried JSON, didn't feel it)
+- creates data structures based on Markdown file (see example below)
 - each data structure gets associated functions to zero out its memory so it can be reused
 
 ## Installation
@@ -33,41 +33,48 @@ npx game-data-gen <input-file-path> <optional-output-file-path>
 
 ## Example
 
-Create a plain text file somewhere in your source code (without a file extension).
+Create a Markdown file somewhere in your source code (without a file extension).
 
-For example `src/data/game`:
+For example `src/data.md`:
 
-```
-game group
-activeEntities array entity
-activeEntityIds array number
-playerId number
-
-vector struct
-x number
-y number
-
-entity struct
-position vector
-velocity vector
-health number
-items array number
-isActive boolean
-
-entities aos 2048 entity
-
-particle soa 10_000
-type string
-pos Vector
+```md
+# game group
+
+- activeEntities array entity
+- activeEntityIds array number
+- playerId number
+
+# vector struct
+
+- x number
+- y number
+
+# entity struct
+
+- position vector
+- velocity vector
+<!-- stats -->
+- health number
+<!-- inventory -->
+- items array number
+<!-- flags -->
+- isActive boolean
+
+# entities aos 2048 entity
+
+# particle soa 10_000
+
+- type string
+- pos Vector
 ```
 
 Run the package with (consider making this a script in your package.json):
 
 ```shell
-npx game-data-gen src/data/game
+npx game-data-gen src/data.md
 ```
 
-This will create or update the `src/data/game.ts` file (see below). The data and functions can then be imported from this file into your code.
+This will create or update the `src/data.ts` file (see below). The data and functions can then be imported from this file into your code.
 
 ```typescript
 /*
@@ -81,18 +88,18 @@ export let activeEntityIds = new Array<number>()
 export let playerId = 0
 
 /** Set the value of the activeEntities field within the game group. */
-export function setActiveEntities(value: Array<Entity>) {
-  activeEntities = value
+export function setActiveEntities(v: Array<Entity>) {
+  activeEntities = v
 }
 
 /** Set the value of the activeEntityIds field within the game group. */
-export function setActiveEntityIds(value: Array<number>) {
-  activeEntityIds = value
+export function setActiveEntityIds(v: Array<number>) {
+  activeEntityIds = v
 }
 
 /** Set the value of the playerId field within the game group. */
-export function setPlayerId(value: number) {
-  playerId = value
+export function setPlayerId(v: number) {
+  playerId = v
 }
 
 /** Zero the activeEntities field within the game group. */
@@ -224,8 +231,8 @@ export function zeroEntities() {
 }
 
 /** Zero an object at a specific index within the entities array of structures. */
-export function zeroEntitiesAt(index: number) {
-  zeroEntity(entities[index])
+export function zeroEntitiesAt(i: number) {
+  zeroEntity(entities[i])
 }
 
 /*
@@ -240,9 +247,9 @@ export const type = new Array(10_000).fill("")
 export const pos = Array.from({ length: 10_000 }, createVector)
 
 /** Zero an index within the particle structure of arrays. */
-export function zeroParticle(idx: number) {
-  type[idx] = ""
-  zeroVector(pos[idx])
+export function zeroParticle(i: number) {
+  type[i] = ""
+  zeroVector(pos[i])
 }
 
 /** Zero the type field within the particle structure of arrays. */

package/dist/lib/aos.js

@@ -27,7 +27,7 @@ function addArrayOfStructuresZeroFunction(name, type, length, output) {
 function addArrayOfStructuresZeroAtIndexFunction(name, type, output) {
     output.push("");
     output.push(`/** Zero an object at a specific index within the ${name} array of structures. */`);
-    output.push(`export function zero${capitalize(name)}At(index: number) {`);
-    output.push(`  zero${capitalize(type)}(${name}[index])`);
+    output.push(`export function zero${capitalize(name)}At(i: number) {`);
+    output.push(`  zero${capitalize(type)}(${name}[i])`);
     output.push("}");
 }

package/dist/lib/group.js

@@ -37,8 +37,8 @@ function addFieldSetFunction(name, field, output) {
     const [fieldName, fieldType, fieldArrayType] = field.split(" ");
     output.push("");
     output.push(`/** Set the value of the ${fieldName} field within the ${name} group. */`);
-    output.push(`export function set${capitalize(fieldName)}(value: ${getTypeName(fieldType, fieldArrayType)}) {`);
-    output.push(`  ${fieldName} = value`);
+    output.push(`export function set${capitalize(fieldName)}(v: ${getTypeName(fieldType, fieldArrayType)}) {`);
+    output.push(`  ${fieldName} = v`);
     output.push("}");
 }
 function addFieldZeroFunction(name, field, output) {

package/dist/lib/soa.js

@@ -69,21 +69,21 @@ function zeroField(name, type, output) {
 function addFieldZeroAtIndexFunction(name, fields, output) {
     output.push("");
     output.push(`/** Zero an index within the ${name} structure of arrays. */`);
-    output.push(`export function zero${capitalize(name)}(idx: number) {`);
+    output.push(`export function zero${capitalize(name)}(i: number) {`);
     for (const field of fields) {
         const [fieldName, fieldType] = field.split(" ");
         switch (fieldType) {
             case ArrayType.STRING:
-                output.push(`  ${fieldName}[idx] = ""`);
+                output.push(`  ${fieldName}[i] = ""`);
                 break;
             case ArrayType.NUMBER:
-                output.push(`  ${fieldName}[idx] = 0`);
+                output.push(`  ${fieldName}[i] = 0`);
                 break;
             case ArrayType.BOOLEAN:
-                output.push(`  ${fieldName}[idx] = false`);
+                output.push(`  ${fieldName}[i] = false`);
                 break;
             default:
-                output.push(`  zero${capitalize(fieldType)}(${fieldName}[idx])`);
+                output.push(`  zero${capitalize(fieldType)}(${fieldName}[i])`);
         }
     }
     output.push("}");

package/dist/main.js

@@ -6,13 +6,21 @@ import { addGroup } from "./lib/group.js";
 import { addStructureOfArrays } from "./lib/soa.js";
 import { addStruct } from "./lib/struct.js";
 const inputFile = process.argv[2];
-const outputFile = process.argv[3] || `${inputFile}.ts`;
+const outputFile = process.argv[3] || `${inputFile.replace(/\.md$/, "")}.ts`;
 const input = fs.readFileSync(inputFile, "utf-8");
 const output = [];
 output.push("/*");
 output.push(` * Generated with game-data-gen on ${new Date().toLocaleString()}. DO NOT MODIFY THIS FILE!`);
 output.push(" */");
-const blocks = input.trim().split("\n\n");
+const blocks = input
+    .replace(/^# (.+)\n\n- /gm, "$1\n")
+    .replace(/^# /gm, "")
+    .replace(/^- /gm, "")
+    .split("\n")
+    .filter((line) => !line.startsWith("<!--"))
+    .join("\n")
+    .trim()
+    .split("\n\n");
 for (const block of blocks) {
     const fields = block.split("\n");
     const header = fields.shift();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "game-data-gen",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "type": "module",
   "files": [
     "dist"
@@ -9,7 +9,7 @@
     "game-data-gen": "dist/main.js"
   },
   "scripts": {
-    "start": "tsc && node dist/main.js tests/data",
+    "start": "tsc && node dist/main.js tests/data.md",
     "build": "biome check && tsc"
   },
   "repository": {