@metajoy-preview/unplugin 0.0.1

package/README.md

@@ -0,0 +1,128 @@
+# @metajoy/unplugin
+
+Metajoy 的跨构建工具插件集合，统一提供配 api 管理等能力。
+
+## 1 概览
+
+当前已支持：
+
+- 多构建工具适配器：Vite、Webpack、Rollup、esbuild、Rspack、Astro、Nuxt、Farm
+- 自动加载 `metajoy.config.ts`
+- 自动加载 `.env` 与 `.env.{NODE_ENV}`
+- 1 个插件模块：`api`（来源于 `src/plugins/api.ts`）
+
+## 2 安装使用
+
+```bash
+npm install @metajoy/unplugin
+# 或
+pnpm add @metajoy/unplugin
+```
+
+### Vite
+
+```ts
+import { defineConfig } from "vite";
+import vue from "@vitejs/plugin-vue";
+import metajoy from "@metajoy/unplugin/vite";
+
+export default defineConfig({
+  plugins: [vue(), metajoy()],
+});
+```
+
+### Webpack
+
+```js
+const MetajoyPlugin = require("@metajoy/unplugin/webpack").default;
+
+module.exports = {
+  plugins: [new MetajoyPlugin()],
+};
+```
+
+### Nuxt
+
+```ts
+export default defineNuxtConfig({
+  modules: ["@metajoy/unplugin/nuxt"],
+});
+```
+
+## 3 插件配置
+
+所有插件均按照如下优先级加载配置：
+
+1. 插件参数
+2. `metajoy.config.ts`
+3. 环境变量
+
+## 4 适配器矩阵
+
+| 构建工具 | 导入路径                  |
+| -------- | ------------------------- |
+| Vite     | @metajoy/unplugin/vite    |
+| Webpack  | @metajoy/unplugin/webpack |
+| Rollup   | @metajoy/unplugin/rollup  |
+| esbuild  | @metajoy/unplugin/esbuild |
+| Rspack   | @metajoy/unplugin/rspack  |
+| Astro    | @metajoy/unplugin/astro   |
+| Nuxt     | @metajoy/unplugin/nuxt    |
+| Farm     | @metajoy/unplugin/farm    |
+
+## 5 插件行为
+
+- 自动加载配置（通常支持热重载）
+
+## 6 插件模块
+
+### `api`
+
+#### 参数
+
+- `api`：`boolean | object`
+- `api.baseUrl`：默认 API 基础地址
+- `api.overrides`：按 tag 覆盖目标地址
+- `api.proxy`：是否启用开发代理
+
+#### 配置
+
+`metajoy.config.ts` 示例：
+
+```ts
+import { defineConfig } from "@metajoy/unplugin/config";
+
+export default defineConfig({
+  api: {
+    baseUrl: "http://localhost:8080",
+    docPath: "/swagger/doc.json",
+    overrides: {
+      auth: "http://192.168.0.145:8081",
+      test: "http://192.168.0.148:8001",
+    },
+  },
+});
+```
+
+#### 示例
+
+获取 baseUrl:
+
+```typescript
+import { getBaseUrl } from "virtual:@metajoy/unplugin/api";
+
+console.log(getBaseUrl("auth"));
+console.log(getBaseUrl("test", { proxy: true }));
+```
+
+## 09 路线图
+
+暂无
+
+## 10 开发
+
+```bash
+vp install
+vp test
+vp pack
+```

package/dist/astro.d.mts

@@ -0,0 +1,6 @@
+import { Options } from "./option.mjs";
+
+//#region src/astro.d.ts
+declare const _default: (options: Options) => any;
+//#endregion
+export { _default as default };

package/dist/astro.mjs

@@ -0,0 +1,11 @@
+import { t as metajoyUnplugin } from "./src-2HigwrEC.mjs";
+//#region src/astro.ts
+var astro_default = (options) => ({
+	name: "metajoy-unplugin-astro",
+	hooks: { "astro:config:setup": async (astro) => {
+		astro.config.vite.plugins ||= [];
+		astro.config.vite.plugins.push(metajoyUnplugin.vite(options));
+	} }
+});
+//#endregion
+export { astro_default as default };

package/dist/client.d.mts

@@ -0,0 +1,35 @@
+//#region src/client.d.ts
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+declare module "virtual:@metajoy/unplugin/api" {
+  type Tags = never;
+  /**
+   * 获取 API 基础 URL
+   * @param tag 目标标签
+   * @param options 选项
+   */
+  function getBaseUrl<T extends LiteralUnion<Tags, string>>(
+  /**
+   * 目标标签
+   * - 如果提供了标签，则返回对应标签的 API 基础 URL
+   * - 如果提供了标签但未找到对应的 API 基础 URL，则返回 "default" 标签的 API 基础 URL（如果存在）
+   * - 如果未提供标签但存在 "default" 标签的 API 基础 URL，则返回 "default" 标签的 API 基础 URL
+   * - 否则返回 undefined。
+   * @default "default"
+   */
+
+  tag?: T,
+  /**
+   * 选项
+   */
+
+  options?: {
+    /**
+     * 是否使用代理
+     * - 如果代理启用并且在开发环境中，则会返回代理 URL
+     * - 否则返回实际的 API 基础 URL。
+     * @default false
+     */
+    proxy?: boolean;
+  }): T extends Tags ? string : "default" extends Tags ? string : void;
+}

package/dist/client.mjs

@@ -0,0 +1 @@
+export {};