@metajoy-preview/config 0.0.1

package/README.md

@@ -0,0 +1,147 @@
+# @metajoy/config
+
+Metajoy 的配置工具包，用来统一定义、加载和监听项目配置。
+
+## 安装
+
+```bash
+npm install @metajoy/config
+# 或
+pnpm add @metajoy/config
+```
+
+## 快速开始
+
+在项目根目录创建 `metajoy.config.ts`：
+
+```ts
+import { defineConfig } from "@metajoy/config";
+
+export default defineConfig({
+  api: {
+    baseUrl: "http://localhost:8080",
+    docPath: "/swagger/doc.json",
+  },
+});
+```
+
+在代码中读取配置：
+
+```ts
+import { loadConfig } from "@metajoy/config";
+
+const { config } = await loadConfig();
+console.log(config.api.baseUrl);
+```
+
+## 导出 API
+
+### defineConfig
+
+用于定义配置，提供类型提示：
+
+```ts
+import { defineConfig } from "@metajoy/config";
+
+export default defineConfig({
+  api: {
+    baseUrl: "https://api.example.com",
+  },
+});
+```
+
+### loadConfig
+
+加载并解析配置：
+
+```ts
+import { loadConfig } from "@metajoy/config";
+
+const result = await loadConfig();
+console.log(result.config);
+```
+
+### watchConfig
+
+监听配置变更（适合开发环境热更新）：
+
+```ts
+import { watchConfig } from "@metajoy/config";
+
+await watchConfig({
+  onUpdate(event) {
+    console.log("config updated", event.newConfig);
+  },
+});
+```
+
+## 配置结构
+
+当前支持的配置如下：
+
+```ts
+interface MetajoyConfig {
+  api?: {
+    baseUrl?: string;
+    docPath?: string; // 默认 "/swagger/doc.json"
+    overrides?: Record<string, string | { baseUrl?: string; docPath?: string }>;
+  };
+}
+```
+
+示例：
+
+```ts
+import { defineConfig } from "@metajoy/config";
+
+export default defineConfig({
+  api: {
+    baseUrl: "http://gateway:8080",
+    docPath: "/swagger/doc.json",
+    overrides: {
+      auth: "http://auth-service:8080",
+      user: {
+        baseUrl: "http://user-service:8080",
+        docPath: "/api/doc.json",
+      },
+    },
+  },
+});
+```
+
+## 配置来源
+
+底层基于 c12，默认配置名为 `metajoy`，并启用 package.json 配置读取。
+
+常见来源包括：
+
+- `metajoy.config.ts` / `metajoy.config.js`
+- `package.json` 中的 `metajoy` 字段
+
+## TypeScript 类型
+
+可直接使用以下类型：
+
+- `MetajoyConfig`
+- `MetajoyConfigDefaults`
+- `MetajoyConfigWithDefaults`
+
+示例：
+
+```ts
+import type { MetajoyConfig } from "@metajoy/config";
+
+const config: MetajoyConfig = {
+  api: {
+    baseUrl: "http://localhost:8080",
+  },
+};
+```
+
+## 开发
+
+```bash
+vp install
+vp test
+vp pack
+```

package/dist/index.d.mts

@@ -0,0 +1,114 @@
+import * as _$c12 from "c12";
+import { ConfigWatcher, InputConfig, LoadConfigOptions, ResolvedConfig, WatchConfigOptions } from "c12";
+import { Readable } from "node:stream";
+
+//#region ../../node_modules/.pnpm/giget@3.2.0/node_modules/giget/dist/_chunks/libs/nypm.d.mts
+type e = `npm` | `yarn` | `pnpm` | `bun` | `deno`;
+type t = {
+  name: e;
+  command: string;
+  version?: string;
+  buildMeta?: string;
+  majorVersion?: string;
+  lockFile?: string | string[];
+  files?: string[];
+};
+type n = {
+  cwd?: string;
+  env?: Record<string, string>;
+  silent?: boolean;
+  packageManager?: t | e;
+  installPeerDependencies?: boolean;
+  dev?: boolean;
+  workspace?: boolean | string;
+  global?: boolean;
+  corepack?: boolean;
+  dry?: boolean;
+};
+type r = {
+  exec?: {
+    command: string;
+    args: string[];
+  };
+};
+declare function i(e?: Pick<n, `cwd` | `silent` | `packageManager` | `dry` | `corepack`> & {
+  frozenLockFile?: boolean;
+  ignoreWorkspace?: boolean;
+}): Promise<r>;
+//#endregion
+//#region ../../node_modules/.pnpm/giget@3.2.0/node_modules/giget/dist/index.d.mts
+type TarOutput = Readable | ReadableStream<Uint8Array>;
+interface TemplateInfo {
+  name: string;
+  tar: string | ((options?: {
+    auth?: string;
+  }) => TarOutput | Promise<TarOutput>);
+  version?: string;
+  subdir?: string;
+  url?: string;
+  defaultDir?: string;
+  headers?: Record<string, string | undefined>;
+  source?: never;
+  dir?: never;
+  [key: string]: any;
+}
+type TemplateProvider = (input: string, options: {
+  auth?: string;
+}) => TemplateInfo | Promise<TemplateInfo> | null; //#endregion
+//#region src/giget.d.ts
+type InstallOptions = Parameters<typeof i>[0];
+interface DownloadTemplateOptions {
+  provider?: string;
+  force?: boolean;
+  forceClean?: boolean;
+  offline?: boolean;
+  preferOffline?: boolean;
+  providers?: Record<string, TemplateProvider>;
+  dir?: string;
+  registry?: false | string;
+  cwd?: string;
+  auth?: string;
+  install?: boolean | InstallOptions;
+  silent?: boolean;
+}
+//#endregion
+//#region src/config.d.ts
+interface ApiConfig {
+  /**
+   * 接口基础地址
+   * @example "https://api.example.com"
+   */
+  baseUrl?: string;
+  /**
+   * 接口文档路径
+   * @default "/swagger/doc.json"
+   */
+  docPath?: string;
+  /**
+   * 接口覆盖配置
+   * @example { "users": "https://users.example.com", "posts": "https://posts.example.com" }
+   */
+  overrides?: Record<string, string | Pick<ApiConfig, "baseUrl" | "docPath">>;
+}
+interface MetajoyConfig {
+  /**
+   * 接口配置
+   */
+  api?: ApiConfig;
+}
+//#endregion
+//#region src/index.d.ts
+declare function defineConfig(config: InputConfig<MetajoyConfig> & {
+  extends?: string | (string | [string, DownloadTemplateOptions])[];
+}): _$c12.C12InputConfig<MetajoyConfig, _$c12.ConfigLayerMeta> & MetajoyConfig & {
+  extends?: string | (string | [string, DownloadTemplateOptions])[];
+};
+declare const _defaults: {
+  api: {};
+};
+type MetajoyConfigDefaults = typeof _defaults;
+type MetajoyConfigWithDefaults = MetajoyConfig & MetajoyConfigDefaults;
+declare function loadConfig(options?: LoadConfigOptions<MetajoyConfig>): Promise<ResolvedConfig<MetajoyConfigWithDefaults, _$c12.ConfigLayerMeta>>;
+declare function watchConfig(options?: WatchConfigOptions<MetajoyConfig>): Promise<ConfigWatcher<MetajoyConfigWithDefaults>>;
+//#endregion
+export { type MetajoyConfig, MetajoyConfigDefaults, MetajoyConfigWithDefaults, defineConfig, loadConfig, watchConfig };

package/dist/index.mjs

@@ -0,0 +1,19 @@
+import { loadConfig as loadConfig$1, watchConfig as watchConfig$1 } from "c12";
+import { merge } from "lodash-es";
+//#region src/index.ts
+function defineConfig(config) {
+	return config;
+}
+const _options = {
+	name: "metajoy",
+	packageJson: true,
+	defaults: { api: {} }
+};
+async function loadConfig(options) {
+	return await loadConfig$1(merge({}, _options, options));
+}
+async function watchConfig(options) {
+	return await watchConfig$1(merge({}, _options, options));
+}
+//#endregion
+export { defineConfig, loadConfig, watchConfig };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@metajoy-preview/config",
+  "version": "0.0.1",
+  "description": "Metajoy 项目的配置工具",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "c12": "4.0.0-beta.5",
+    "lodash-es": "^4.18.1"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "giget": "^3.2.0"
+  },
+  "inlinedDependencies": {
+    "giget": "3.2.0"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check"
+  }
+}