feat: add loader given env to config registry (#246)

Author: Exeloo

e2e/game/client/main.ts

@@ -14,11 +14,6 @@ import { exampleSystem } from "./systems/example.system";
 export async function main(options: IRunOptions) {
   const app = NanoforgeFactory.createClient({
     tickRate: 60,
-    environment: {
-      serverAddress: "127.0.0.1",
-      serverTcpPort: "4445",
-      serverUdpPort: "4444",
-    },
   });
 
   const assetManager = new AssetManagerLibrary();
@@ -37,7 +32,15 @@ export async function main(options: IRunOptions) {
   app.useNetwork(network);
   app.use(Symbol("music"), music);
 
-  await app.init(options);
+  await app.init({
+    ...options,
+    env: {
+      ...options.env,
+      SERVER_ADDRESS: "127.0.0.1",
+      SERVER_TCP_PORT: "4445",
+      SERVER_UDP_PORT: "4444",
+    },
+  });
 
   const registry = ecs.registry;
 

example/pong-network/client/main.ts

@@ -12,7 +12,6 @@ import { controlPlayer, draw, move, packetHandler } from "./systems";
 
 export const app = NanoforgeFactory.createClient({
   tickRate: 60,
-  environment: { serverTcpPort: "4445", serverUdpPort: "4444", serverAddress: "127.0.0.1" },
 });
 
 export const layer = new Layer();
@@ -30,7 +29,15 @@ export const main = async (options: IRunOptions) => {
   app.useAssetManager(assetManager);
   app.useInput(input);
 
-  await app.init(options);
+  await app.init({
+    ...options,
+    env: {
+      ...options.env,
+      SERVER_TCP_PORT: "4445",
+      SERVER_UDP_PORT: "4444",
+      SERVER_ADDRESS: "127.0.0.1",
+    },
+  });
 
   const registry = ecsLibrary.registry;
 

example/pong-network/server/main.ts

@@ -9,7 +9,6 @@ import { bounce, move, packetHandler } from "./systems";
 
 export const app = NanoforgeFactory.createServer({
   tickRate: 60,
-  environment: { listeningTcpPort: "4445", listeningUdpPort: "4444" },
 });
 
 export const main = async (options: IRunOptions) => {
@@ -21,7 +20,10 @@ export const main = async (options: IRunOptions) => {
   app.useNetwork(network);
   app.useAssetManager(assetManager);
 
-  await app.init(options);
+  await app.init({
+    ...options,
+    env: { ...options.env, LISTENING_TCP_PORT: "4445", LISTENING_UDP_PORT: "4444" },
+  });
 
   const registry = ecsLibrary.registry;
 

packages/common/src/context/contexts/executions/init.context.ts

@@ -6,6 +6,7 @@ import { BaseContext } from "./base.context";
 export class InitContext extends BaseContext {
   private readonly _canvas: IRunClientOptions["canvas"] | undefined;
   private readonly _files: IRunOptions["files"];
+  private readonly _env: Record<string, string | undefined>;
   private readonly _config: IConfigRegistry;
 
   constructor(
@@ -18,6 +19,7 @@ export class InitContext extends BaseContext {
 
     this._canvas = (options as IRunClientOptions)["canvas"];
     this._files = options.files;
+    this._env = options.env;
     this._config = configRegistry;
   }
 
@@ -29,6 +31,10 @@ export class InitContext extends BaseContext {
     return this._files;
   }
 
+  get env(): Record<string, string | undefined> {
+    return this._env;
+  }
+
   get config(): IConfigRegistry {
     return this._config;
   }

packages/common/src/options/types/options.type.ts

@@ -3,8 +3,10 @@ export type IRunOptions = IRunClientOptions | IRunServerOptions;
 export interface IRunClientOptions {
   canvas: HTMLCanvasElement;
   files: Map<string, string>;
+  env: Record<string, string | undefined>;
 }
 
 export interface IRunServerOptions {
   files: Map<string, string>;
+  env: Record<string, string | undefined>;
 }

packages/config/README.md

@@ -31,27 +31,47 @@ bun add @nanoforge-dev/config
 
 ## Warning
 
-This library is of exclusive usage for other libraries. To put variables in the environment to allow libraries to use it through this config library, you must put it in factory options :
+This library is of exclusive usage for other libraries. To put variables in the environment to allow libraries to use it through this config library, you must put it in `.env` file at the root of your project (or in your environment) :
+
+```dotenv
+NANOFORGE_CLIENT_SERVER_TCP_PORT=4445
+NANOFORGE_CLIENT_SERVER_UDP_PORT=4444
+NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1
+```
+
+You must prefix your variables according to this table :
+
+| Prefix              | Availability             |
+| :------------------ | :----------------------- |
+| `NANOFORGE_CLIENT_` | Available in client only |
+| `NANOFORGE_SERVER_` | Available in server only |
+| `NANOFORGE_`        | Available in both apps   |
+
+⚠️ Prefixs are removed in libs
+
+You can also put it in init options (every value must be string or undefined) :
 
 ```ts
 import { type IRunOptions } from "@nanoforge-dev/common";
 import { NanoforgeFactory } from "@nanoforge-dev/core";
 import { NetworkLibrary } from "@nanoforge-dev/network";
 
 export async function main(options: IRunOptions) {
-  const app = NanoforgeFactory.createClient({
-    environment: {
-      serverTcpPort: "4445",
-      serverUdpPort: "4444",
-      serverAddress: "127.0.0.1",
-    },
-  });
+  const app = NanoforgeFactory.createClient();
 
   const network = new NetworkLibrary();
 
   app.useNetwork(network);
 
-  await app.init(options);
+  await app.init({
+    ...options,
+    env: {
+      ...options.env,
+      SERVER_TCP_PORT: "4445",
+      SERVER_UDP_PORT: "4444",
+      SERVER_ADDRESS: "127.0.0.1",
+    },
+  });
 
   await app.run();
 }
@@ -92,23 +112,23 @@ export class ClientConfigNetwork {
   @Expose()
   @IsOptional()
   @IsPort()
-  serverTcpPort?: string;
+  SERVER_TCP_PORT?: string;
 
   @Expose()
   @IsOptional()
   @IsPort()
-  serverUdpPort?: string;
+  SERVER_UDP_PORT?: string;
 
   // This var must be ip address or fqdn (it cannot be undefined)
   @Expose()
   @IsIpOrFQDN()
-  serverAddress?: string;
+  SERVER_ADDRESS?: string;
 
   // This var must be a byte length between 2 and 64. It can be undefined as it as a default value.
   @Expose()
   @Default("PACKET_END")
   @IsByteLength(2, 64)
-  magicValue!: string;
+  MAGIC_VALUE!: string;
 }
 ```
 

packages/config/src/index.ts

@@ -1,3 +1,4 @@
 export * from "./exports";
 export * from "./default";
+export * from "./transformers";
 export * from "./validators";

packages/config/src/transformers/boolean.transformer.ts

@@ -0,0 +1,9 @@
+import { Transform } from "class-transformer";
+
+const transformStringToBoolean = ({ value }: { value: string }) => {
+  if (value === "true") return true;
+  if (value === "false") return false;
+  return undefined;
+};
+
+export const TransformToBoolean = () => Transform(transformStringToBoolean);

packages/config/src/transformers/index.ts

@@ -0,0 +1 @@
+export { TransformToBoolean } from "./boolean.transformer";

packages/core/src/application/application-options.type.ts

@@ -1,4 +1,3 @@
 export interface IApplicationOptions {
   tickRate: number;
-  environment: Record<string, unknown>;
 }