config2ts 2.5.2 → 2.5.5

package/README.md

@@ -27,6 +27,7 @@ config2ts -d config -o dist -n csv.ts -a public
 | RefEnum    | namespace.type    |
 |  RefEnum[] |  namespace.type[] |
 |   Object   |   type (Record)   |
+|  Object[]  | type[] (Record[]) |
 
 * `Number` support Infinity and NaN
 * `Enum` support empty string type
@@ -34,6 +35,8 @@ config2ts -d config -o dist -n csv.ts -a public
 * `EnumIndex` will generate index type, and will use `Enum` type to generate interface
 * `Ref` / `RefEnum` reference another csv's Record/type by id
 * `Object` parse `key:value,key:value` format, auto-infer value types (number/boolean/string), generates a dedicated `type` that merges all keys
+* `Object[]` parse `key:value,key:value;key:value,key:value` format (`;` separates objects, `,` separates key-value pairs), empty value generates `[]`, generates a dedicated element `type` with the field typed as `type[]`
+* unrecognized field types fall back to `string` and print a warning (check for typos)
 
 ## assets2ts
 
@@ -41,9 +44,9 @@ Scan assets directory and generate an `assets.ts` index file with nested resourc
 
 - `-a, --assets <path>` set assets resource directory. default: `public`
 - Output file: `assets.ts` (alongside the merged config file)
-- Directory/filenames are converted to camelCase keys
+- File and directory names are used exactly as-is (e.g., `Direction.png` → `Direction`, `adjust-horizontal.png` → `'adjust-horizontal'`); keys with special characters are automatically quoted
 - `type` field uses file extension (lowercase), e.g. `'png'`, `'mp3'`, `'svg'`
-- Directories containing 2+ files of the same extension get a dedicated type (e.g. `PngAsset`, `Mp3Asset`) and `as Record<string, XxxAsset>` annotation
+- Directories containing 2+ files of the same extension get a dedicated type (e.g. `PngAsset`, `Mp3Asset`) and `satisfies Record<string, XxxAsset>` annotation
 - Directories with ≤1 file or mixed extensions do not get a type annotation
 - Nested directories are supported (e.g. `public/sub/image/`)
 
@@ -59,14 +62,14 @@ export type SvgAsset = { path: string; type: 'svg' };
 export const ASSETS = {
     public: {
         image: {
-            adjustHorizontal: {path:'public/image/adjust-horizontal.png',type:'png'},
-            direction: {path:'public/image/direction.png',type:'png'}
+            'adjust-horizontal': {path:'public/image/adjust-horizontal.png',type:'png'},
+            Direction: {path:'public/image/Direction.png',type:'png'}
         } satisfies Record<string, PngAsset>,
         music: {
             effect1: {path:'public/music/effect1.mp3',type:'mp3'},
             effect2: {path:'public/music/effect2.mp3',type:'mp3'}
         } satisfies Record<string, Mp3Asset>,
-        singleFile: {
+        'single-file': {
             effect1: {path:'public/single-file/effect1.mp3',type:'mp3'}
         }
     }
@@ -78,9 +81,12 @@ export const ASSETS = {
 ```typescript
 import { ASSETS } from "./assets";
 
-const meta = ASSETS.public.image.adjustHorizontal;
-// meta.path → 'public/image/adjust-horizontal.png'
+const meta = ASSETS.public.image.Direction;
+// meta.path → 'public/image/Direction.png'
 // meta.type → 'png'
+
+const adjustMeta = ASSETS.public.image['adjust-horizontal'];
+// adjustMeta.path → 'public/image/adjust-horizontal.png'
 ```
 
 ## Options

package/lib/config2ts.js

@@ -50,6 +50,7 @@ const EnumIndexStr = "EnumIndex";
 const EnumArrayString = "Enum[]";
 const IndexStr = "Index";
 const ObjectStr = "Object";
+const ObjectArrayString = "Object[]";
 const RefPrefix = "Ref[";
 const RefSuffix = "]";
 const RefEnumPrefix = "RefEnum[";
@@ -82,6 +83,9 @@ function csv2ts(csvString, moduleName) {
                 if (parseRefEnum(convert[k])) {
                     refEnumFields.push(k);
                 }
+                if (!isKnownType(convert[k])) {
+                    console.warn(`[config2ts] warning: ${moduleName} field "${k}" has unrecognized type "${convert[k]}", values will be treated as string`);
+                }
             }
             return null;
         }
@@ -90,6 +94,9 @@ function csv2ts(csvString, moduleName) {
                 if (convert[k] === ObjectStr) {
                     d[k] = parseObject(d[k]);
                 }
+                else if (convert[k] === ObjectArrayString) {
+                    d[k] = parseObjectArray(d[k]);
+                }
                 else if (typeof global[convert[k]] === "function") {
                     d[k] = global[convert[k]](d[k]);
                 }
@@ -172,15 +179,18 @@ function csv2ts(csvString, moduleName) {
             template += `    export type ${field} = ${enumValueStrings.join(" | ")};\n`;
             template += `    export const ${field}List: ${field}[] = [${enumValueStrings.join(", ")}];\n\n`;
         }
-        else if (convert[field] == ObjectStr) {
+        else if (convert[field] == ObjectStr || convert[field] == ObjectArrayString) {
             const keyTypes = {};
+            const isArray = convert[field] == ObjectArrayString;
             for (const row of result) {
-                const objValue = row[field];
-                for (const key in objValue) {
-                    if (!keyTypes[key]) {
-                        keyTypes[key] = new Set();
+                const objValues = isArray ? row[field] : [row[field]];
+                for (const objValue of objValues) {
+                    for (const key in objValue) {
+                        if (!keyTypes[key]) {
+                            keyTypes[key] = new Set();
+                        }
+                        keyTypes[key].add(getTypeName(objValue[key]));
                     }
-                    keyTypes[key].add(getTypeName(objValue[key]));
                 }
             }
             template += `    export type ${field} = {\n`;
@@ -212,6 +222,9 @@ function csv2ts(csvString, moduleName) {
             else if (convert[field] == ObjectStr) {
                 fieldType = field;
             }
+            else if (convert[field] == ObjectArrayString) {
+                fieldType = field + "[]";
+            }
             else if (convert[field].startsWith(RefPrefix) && convert[field].endsWith(RefSuffix)) {
                 const refModule = convert[field].slice(RefPrefix.length, -RefSuffix.length);
                 const refModuleName = changeCase.pascalCase(refModule);
@@ -291,6 +304,13 @@ function parseObject(str) {
     }
     return result;
 }
+function parseObjectArray(str) {
+    const trimmed = str.trim();
+    if (trimmed === "") {
+        return [];
+    }
+    return trimmed.split(";").map((part) => parseObject(part));
+}
 function parseObjectValue(value) {
     if (value === "true")
         return true;
@@ -311,6 +331,25 @@ function getTypeName(value) {
         return "boolean";
     return "string";
 }
+function isKnownType(typeStr) {
+    if (typeStr === "") {
+        return true;
+    }
+    const knownTypes = [EnumStr, EnumIndexStr, EnumArrayString, IndexStr, ObjectStr, ObjectArrayString, "String[]", "Number[]"];
+    if (knownTypes.includes(typeStr)) {
+        return true;
+    }
+    if (typeStr.startsWith(RefPrefix) && typeStr.endsWith(RefSuffix)) {
+        return true;
+    }
+    if (parseRefEnum(typeStr)) {
+        return true;
+    }
+    if (typeof global[typeStr] === "function") {
+        return true;
+    }
+    return false;
+}
 function parseRefEnum(typeStr) {
     if (typeStr.startsWith(RefEnumPrefix)) {
         let isArray = false;
@@ -342,7 +381,7 @@ function scanDir(dir, basePath) {
     for (const entry of entries) {
         const fullPath = path.join(dir, entry.name);
         if (entry.isDirectory()) {
-            const key = changeCase.camelCase(entry.name);
+            const key = entry.name;
             const childNode = scanDir(fullPath, path.posix.join(basePath, entry.name));
             if (childNode !== null) {
                 node[key] = childNode;
@@ -352,7 +391,7 @@ function scanDir(dir, basePath) {
         else if (entry.isFile()) {
             const parsed = path.parse(entry.name);
             const ext = parsed.ext.slice(1).toLowerCase();
-            const key = changeCase.camelCase(parsed.name);
+            const key = parsed.name;
             const relPath = path.posix.join(basePath, entry.name);
             node[key] = { path: relPath, type: ext };
             hasContent = true;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "config2ts",
-  "version": "2.5.2",
-  "description": "convert config to ts file.",
+  "version": "2.5.5",
+  "description": "Generate type-safe TypeScript from CSV/INI/TOML config tables — inferred types, enums, cross-table references, and a typed asset index, all from one CLI command.",
   "main": "lib/config2ts.js",
   "types": "lib/config2ts.d.ts",
   "bin": {