rename x class and rename start to build

Author: nahtnam

.changeset/kind-squids-draw.md

@@ -0,0 +1,6 @@
+---
+"@xframework/core": minor
+"@xframework/next": minor
+---
+
+rename x class and rename start to build

README.md

@@ -7,26 +7,27 @@ It is a lightweight **un-opinionated** framework of pluggable modules, allowing
 ## Example
 
 ```ts
-import { X } from "@xframework/next";
+import { XFramework } from "@xframework/core";
 import { createDrizzleModule } from "@xframework/db/drizzle";
 import { createAuthJsModule } from "@xframework/auth/auth-js/next";
 import { createStripeModule } from "@xframework/payment/stripe";
 
-export const x = X({
-  modules: {
-    db: createDrizzleModule(db),
-    auth: createAuthJsModule(authConfig),
-    stripe: createStripeModule({
-      apiKey,
-      webhooks: {
-        onCustomerCreated() {
-          // ...
-        },
-      },
-    }),
-    // ... and more ...
-  },
-});
+export const x = new XFramework()
+  .module("db", () => new DrizzleModule(db))
+  .module("auth", () => new AuthJsModule(auth))
+  .module("mailer", () => new NodemailerModule(mailer))
+  .module("stripe", () => new StripeModule({
+    apiKey,
+    webhooks: {
+      onCustomerCreated() {
+        // ...
+      }
+    }
+  }))
+  .module("next", () => new NextModule())
+  // ... and more ...
+  .build();
+
 
 // Usage
 const users = x.db.select().from(users);

examples/mailer/src/x/index.ts

@@ -1,15 +1,15 @@
 import { AuthJsModule } from "@xframework/auth/authjs/next";
-import { X } from "@xframework/core";
+import { XFramework } from "@xframework/core";
 import { DrizzleModule } from "@xframework/db/drizzle";
 import { NodemailerModule } from "@xframework/mailer/nodemailer";
 import { NextModule } from "@xframework/next";
 import { db } from "../db";
 import { auth } from "./auth";
 import { mailer } from "./mailer";
 
-export const x = new X()
+export const x = new XFramework()
   .module("auth", () => new AuthJsModule(auth))
   .module("db", () => new DrizzleModule(db))
   .module("mailer", () => new NodemailerModule(mailer))
   .module("next", () => new NextModule())
-  .start();
+  .build();

examples/next-auth/src/x/index.ts

@@ -1,12 +1,12 @@
 import { AuthJsModule } from "@xframework/auth/authjs/next";
-import { X } from "@xframework/core";
+import { XFramework } from "@xframework/core";
 import { DrizzleModule } from "@xframework/db/drizzle";
 import { NextModule } from "@xframework/next";
 import { db } from "../db";
 import { auth } from "./auth";
 
-export const x = new X()
+export const x = new XFramework()
   .module("db", () => new DrizzleModule(db))
   .module("auth", () => new AuthJsModule(auth))
   .module("next", () => new NextModule())
-  .start();
+  .build();

examples/next-drizzle/src/x/index.ts

@@ -1,5 +1,7 @@
-import { X } from "@xframework/core";
+import { XFramework } from "@xframework/core";
 import { DrizzleModule } from "@xframework/db/drizzle";
 import { db } from "../db";
 
-export const x = new X().module("db", () => new DrizzleModule(db)).start();
+export const x = new XFramework()
+  .module("db", () => new DrizzleModule(db))
+  .build();

examples/next-prisma/src/x/index.ts

@@ -1,5 +1,7 @@
-import { X } from "@xframework/core";
+import { XFramework } from "@xframework/core";
 import { PrismaModule } from "@xframework/db/prisma";
 import { prisma } from "../db";
 
-export const x = new X().module("db", () => new PrismaModule(prisma)).start();
+export const x = new XFramework()
+  .module("db", () => new PrismaModule(prisma))
+  .build();

examples/pg-boss/src/x/index.ts

@@ -1,4 +1,4 @@
-import { X } from "@xframework/core";
+import { XFramework } from "@xframework/core";
 import { DrizzleModule } from "@xframework/db/drizzle";
 import { PgBossModule } from "@xframework/queue/pg-boss";
 import { count } from "drizzle-orm";
@@ -13,10 +13,10 @@ type Queues = {
 // biome-ignore lint/style/noNonNullAssertion: <explanation>
 const boss = new PgBoss(process.env.DATABASE_URL!);
 
-export const x = new X()
+export const x = new XFramework()
   .module("db", () => new DrizzleModule(db))
   .module("queue", () => new PgBossModule<Queues>(boss))
-  .start();
+  .build();
 
 x.queue.registerWorkers({
   sayHello: {

packages/core/src/index.ts

@@ -2,13 +2,13 @@ import { Hono } from "hono";
 import type { Module, ModuleFactory, Modules } from "./module";
 
 type XWithModules<T extends Modules> = Omit<
-  X<T>,
+  XFramework<T>,
   "get" | "module" | "use" | "start"
 > &
   T;
 
 // biome-ignore lint/complexity/noBannedTypes: <explanation>
-export class X<RegisteredModules extends Modules = {}> {
+export class XFramework<RegisteredModules extends Modules = {}> {
   private modules: Map<string, Module> = new Map();
   private cache: Map<string, unknown> = new Map();
   private workers: (() => Promise<void> | void)[] = [];
@@ -26,27 +26,27 @@ export class X<RegisteredModules extends Modules = {}> {
   module<ModuleKey extends string, ModuleReturnType>(
     key: ModuleKey,
     factory: ModuleFactory<RegisteredModules, ModuleReturnType>,
-  ): X<RegisteredModules & { [Key in ModuleKey]: ModuleReturnType }> {
-    const moduleInstance = factory(this as X<RegisteredModules>);
+  ): XFramework<RegisteredModules & { [Key in ModuleKey]: ModuleReturnType }> {
+    const moduleInstance = factory(this as XFramework<RegisteredModules>);
 
     void moduleInstance.initialize();
     this._.hono.route("/", moduleInstance.hono);
     this.modules.set(key, moduleInstance);
     this.workers.push(moduleInstance.worker.bind(moduleInstance));
 
-    return this as X<
+    return this as XFramework<
       RegisteredModules & { [Key in ModuleKey]: ModuleReturnType }
     >;
   }
 
   use<NewModules extends Modules>(
-    other: X<NewModules>,
-  ): X<RegisteredModules & NewModules> {
+    other: XFramework<NewModules>,
+  ): XFramework<RegisteredModules & NewModules> {
     other.modules.forEach((module, key) => {
       this.modules.set(key, module);
     });
 
-    return this as X<RegisteredModules & NewModules>;
+    return this as XFramework<RegisteredModules & NewModules>;
   }
 
   private get<ModuleKey extends keyof RegisteredModules>(
@@ -67,12 +67,12 @@ export class X<RegisteredModules extends Modules = {}> {
     return this.cache.get(key as string) as RegisteredModules[ModuleKey];
   }
 
-  start(): XWithModules<RegisteredModules> {
+  build(): XWithModules<RegisteredModules> {
     return new Proxy(this, {
       get: (target, prop: string | symbol) => {
         if (prop in target) {
-          return (target as X<RegisteredModules>)[
-            prop as keyof X<RegisteredModules>
+          return (target as XFramework<RegisteredModules>)[
+            prop as keyof XFramework<RegisteredModules>
           ];
         }
 

packages/core/src/module.ts

@@ -1,5 +1,5 @@
 import { Hono } from "hono";
-import type { X } from ".";
+import type { XFramework } from ".";
 
 export class Module {
   hono: Hono;
@@ -8,7 +8,7 @@ export class Module {
     this.hono = new Hono();
   }
 
-  install(x: X): unknown {
+  install(x: XFramework): unknown {
     throw new Error("install method must be implemented");
   }
 
@@ -20,5 +20,5 @@ export class Module {
 export type Modules = Record<string, unknown>;
 
 export type ModuleFactory<CurrentModules extends Modules, ReturnType> = (
-  x: X<CurrentModules>,
-) => Module & { install: (x: X) => ReturnType };
+  x: XFramework<CurrentModules>,
+) => Module & { install: (x: XFramework) => ReturnType };

packages/next/src/index.ts

@@ -1,4 +1,4 @@
-import type { X } from "@xframework/core";
+import type { XFramework } from "@xframework/core";
 import { Module } from "@xframework/core/module";
 import type { FetchEventLike } from "hono/types";
 import { handle } from "hono/vercel";
@@ -23,7 +23,7 @@ type Handlers = {
 };
 
 export class NextModule extends Module {
-  install(x: X) {
+  install(x: XFramework) {
     const createHandlers = (): Handlers => {
       const handlers = {} as Handlers;