@123ishatest/louter 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,101 @@
+# Louter
+
+> Louter is a zod-based content parser that transforms YAML into type-safe runtime data.
+
+It consists of 2 parts:
+
+- A build step, running in a node-only context such as a vite plugin or the `server` context of SvelteKit.
+- A content manager, providing fully-typed access to your content at run-time.
+
+## Installation
+
+```bash
+npm install @123ishatest/louter
+```
+
+## Setup
+
+Define your content kinds, a mapping between the `kind` of content and the Zod schema that represents it.
+
+```ts
+import { z } from 'zod';
+
+const schemas = {
+  currency: z.strictObject({ id: z.string(), name: z.string() }),
+  upgrade: z.strictObject({
+    id: z.string(),
+    name: z.string(),
+    cost: z.strictObject({
+      currency: z.string(),
+      amount: z.number().default(4),
+    }),
+  }),
+};
+```
+
+Add your content!
+
+```yaml
+# money.currency.yaml
+id: /currency/money
+name: Money
+```
+
+```yaml
+# more-money.upgrade.yaml
+id: /upgrade/more-money
+name: More money
+cost:
+  currency: /currency/money
+  amount: 4
+```
+
+## Usage (node)
+
+Louter comes with a composable pipeline, so you can add or remove behaviour to your heart's desire.
+
+```ts
+import { Louter, LouterValidator, LouterYamlParser } from '@123ishatest/louter';
+import { LouterContentWriter, LouterFileLoader, LouterJsonSchemaWriter } from '@123ishatest/louter/node';
+
+const louter = new Louter([
+  // Loads all files in the specified folder
+  new LouterFileLoader('content'),
+
+  // Parses the YAML that was found
+  new LouterYamlParser(),
+
+  // Validates it against the schemas
+  new LouterValidator(),
+
+  // Writes a big content object to the specified folder
+  new LouterContentWriter('.generated'),
+
+  // Writes utility JSON Schemas to the specified folder
+  new LouterJsonSchemaWriter('.generated'),
+]);
+
+const result = louter.run(schemas);
+
+// Check for warnings
+result.warnings.forEach(console.warn);
+```
+
+This result contains all parsed content, which can be used by your game!
+
+## Usage (browser)
+
+```ts
+import { ContentManager } from '@123ishatest/louter';
+
+const manager = new ContentManager(schemas);
+manager.load(result.content);
+
+// Type-safe accessors
+const currencies = manager.getList('currency');
+const currencyMap = manager.getMap('currency');
+
+// Fully typed objects
+const money = manager.get('/currency/money', 'currency');
+console.log(money.name);
+```

package/dist/export/LouterJsonSchemaWriter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LouterJsonSchemaWriter.d.ts","sourceRoot":"","sources":["../../src/export/LouterJsonSchemaWriter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D;;GAEG;AACH,qBAAa,sBAAuB,YAAW,WAAW;IACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAExB,SAAS,GAAE,MAAkB;IAIzC,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;CAUpE"}
+{"version":3,"file":"LouterJsonSchemaWriter.d.ts","sourceRoot":"","sources":["../../src/export/LouterJsonSchemaWriter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;GAEG;AACH,qBAAa,sBAAuB,YAAW,WAAW;IACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAExB,SAAS,GAAE,MAAkB;IAIzC,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;CAUpE"}

package/dist/loader/LouterFileLoader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LouterFileLoader.d.ts","sourceRoot":"","sources":["../../src/loader/LouterFileLoader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEhE;;GAEG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAElB,WAAW,EAAE,MAAM;IAIxB,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;IAU1E;;OAEG;IACH,OAAO,CAAC,WAAW;CAiBpB"}
+{"version":3,"file":"LouterFileLoader.d.ts","sourceRoot":"","sources":["../../src/loader/LouterFileLoader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEhE;;GAEG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAElB,WAAW,EAAE,MAAM;IAIxB,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;IAU1E;;OAEG;IACH,OAAO,CAAC,WAAW;CAkBpB"}

package/dist/node.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("node:fs"),n=require("node:path");class l{_contentRoot;constructor(e){this._contentRoot=e}run(e){const r=this.getAllFiles(this._contentRoot);e.files=r.map(t=>({path:t,data:o.readFileSync(t,"utf-8")}))}getAllFiles(e){const r=o.readdirSync(e,{withFileTypes:!0}),t=[];for(const i of r){const c=n.join(e,i.name);i.isDirectory()?t.push(...this.getAllFiles(c)):i.isFile()&&t.push(c)}return t}}class u{_directory;constructor(e=".louter"){this._directory=e}run(e){e.warnings.forEach(i=>{console.warn(i.path,i.message)}),o.mkdirSync(this._directory,{recursive:!0});const r=e.content,t=n.join(this._directory,"content.generated.json");o.writeFileSync(t,JSON.stringify(r,null,2))}}class a{_directory;constructor(e=".louter"){this._directory=e}run(e){o.mkdirSync(this._directory,{recursive:!0});for(const r in e.kinds){const t=e.kinds[r].toJSONSchema({io:"input"}),i=n.join(this._directory,`${r}.schema.json`);o.writeFileSync(i,JSON.stringify(t,null,2))}}}exports.LouterContentWriter=u;exports.LouterFileLoader=l;exports.LouterJsonSchemaWriter=a;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("node:fs"),n=require("node:path");class l{_contentRoot;constructor(t){this._contentRoot=t}run(t){const r=this.getAllFiles(this._contentRoot);t.files=r.map(e=>({path:e,data:o.readFileSync(e,"utf-8")}))}getAllFiles(t){const r=o.readdirSync(t,{withFileTypes:!0}),e=[];for(const i of r){const c=n.join(t,i.name);i.isDirectory()&&e.push(...this.getAllFiles(c)),i.isFile()&&e.push(c)}return e}}class u{_directory;constructor(t=".louter"){this._directory=t}run(t){t.warnings.forEach(i=>{console.warn(i.path,i.message)}),o.mkdirSync(this._directory,{recursive:!0});const r=t.content,e=n.join(this._directory,"content.generated.json");o.writeFileSync(e,JSON.stringify(r,null,2))}}class a{_directory;constructor(t=".louter"){this._directory=t}run(t){o.mkdirSync(this._directory,{recursive:!0});for(const r in t.kinds){const e=t.kinds[r].toJSONSchema({io:"input"}),i=n.join(this._directory,`${r}.schema.json`);o.writeFileSync(i,JSON.stringify(e,null,2))}}}exports.LouterContentWriter=u;exports.LouterFileLoader=l;exports.LouterJsonSchemaWriter=a;

package/dist/node.es.js

@@ -18,8 +18,8 @@ class f {
   getAllFiles(t) {
     const r = a(t, { withFileTypes: !0 }), e = [];
     for (const o of r) {
-      const n = i.join(t, o.name);
-      o.isDirectory() ? e.push(...this.getAllFiles(n)) : o.isFile() && e.push(n);
+      const s = i.join(t, o.name);
+      o.isDirectory() && e.push(...this.getAllFiles(s)), o.isFile() && e.push(s);
     }
     return e;
   }

package/dist/parser/LouterYamlParser.d.ts

@@ -1,6 +1,6 @@
 import { KindDefinitions } from '../core/types';
-import { LouterContext } from '../core/LouterContext';
 import { LouterStage } from '../core/LouterStage';
+import { LouterContext } from '../core/LouterContext';
 /**
  * Turns loaded files into objects by parsing YAML parsing them
  */

package/dist/parser/LouterYamlParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LouterYamlParser.d.ts","sourceRoot":"","sources":["../../src/parser/LouterYamlParser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;GAEG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAC3C,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;CAgD3E"}
+{"version":3,"file":"LouterYamlParser.d.ts","sourceRoot":"","sources":["../../src/parser/LouterYamlParser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAG5D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D;;GAEG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAC3C,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI;CAgD3E"}

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@123ishatest/louter",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.1",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "url": "https://github.com/123ishaTest/louter"
+  },
   "files": [
     "dist"
   ],
@@ -25,15 +32,22 @@
     "check": "tsc -p ./tsconfig.build.json --noEmit",
     "dev": "vite build --watch",
     "lint": "prettier --check . && eslint .",
+    "format": "prettier --write .",
     "test": "vitest",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "publish-packages": "npm run build && npm run lint && npm run test && changeset version && changeset publish"
   },
   "devDependencies": {
-    "@123ishatest/ludiek-eslint-config": "*",
-    "@123ishatest/ludiek-typescript-config": "*",
+    "@changesets/cli": "^2.29.5",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.5.0",
     "@vitest/coverage-v8": "^4.0.6",
+    "eslint": "^10.0.3",
+    "globals": "^17.4.0",
+    "jiti": "^2.6.1",
     "jsdom": "^27.1.0",
     "memfs": "^4.56.11",
+    "typescript-eslint": "^8.57.0",
     "vite": "^7.0.5",
     "vite-plugin-dts": "^4.5.4",
     "vite-tsconfig-paths": "^5.1.4",