@123ishatest/louter 0.2.0 → 0.3.0

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/LouterVsCodeSettingsWriter.d.ts

@@ -0,0 +1,9 @@
+import { LouterContext } from '../core/LouterContext';
+import { LouterStage } from '../core/LouterStage';
+import { KindDefinitions } from '../core/types';
+export declare class LouterVsCodeSettingsWriter implements LouterStage {
+    private readonly _settingsPath;
+    constructor(settingsPath?: string);
+    run<Kinds extends KindDefinitions>(ctx: LouterContext<Kinds>): void;
+}
+//# sourceMappingURL=LouterVsCodeSettingsWriter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LouterVsCodeSettingsWriter.d.ts","sourceRoot":"","sources":["../../src/export/LouterVsCodeSettingsWriter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAKrD,qBAAa,0BAA2B,YAAW,WAAW;IAC5D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;gBAE3B,YAAY,GAAE,MAAgC;IAI1D,GAAG,CAAC,KAAK,SAAS,eAAe,EAAE,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC;CA4C7D"}

package/dist/util/type.d.ts

@@ -0,0 +1,6 @@
+export declare function isObject(value: unknown): value is Record<string, unknown>;
+export declare function isJsonSchemaEntry(value: unknown): value is {
+    fileMatch: string[];
+    url: string;
+};
+//# sourceMappingURL=type.d.ts.map

package/dist/util/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/util/type.ts"],"names":[],"mappings":"AAAA,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI;IAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAU/F"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@123ishatest/louter",
   "private": false,
-  "version": "0.2.0",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public",
     "provenance": true