@dou-ui/resolver 0.0.0-stage → 0.1.0-alpha.0

package/dist/types/generated/names.d.ts

@@ -0,0 +1,10 @@
+/** Every component `dou-ui` exports, with the directory of its style entry. */
+export declare const componentDirs: Record<string, string>;
+/** Every component of the packages built on `dou-ui`, its package, where to import it from and its style entry. */
+export declare const packageComponents: Record<string, {
+    package: string;
+    from: string;
+    style: string;
+}>;
+/** Every icon component `@dou-ui/icons` exports. */
+export declare const iconNames: readonly string[];

package/dist/types/index.d.ts

@@ -0,0 +1,81 @@
+import { componentDirs, iconNames, packageComponents } from './generated/names';
+/** What a resolver hands back: the export to import, where from, and what to import with it. */
+export interface ImportInfo {
+    name: string;
+    from: string;
+    sideEffects?: string | string[];
+}
+export type ResolverFunction = (name: string) => ImportInfo | undefined;
+/** The resolver shape of on-demand component plugins. */
+export interface ComponentResolver {
+    type: 'component' | 'directive';
+    resolve: ResolverFunction;
+}
+export interface DouUIResolverOptions {
+    /**
+     * Import each component's stylesheet along with it. Turn off when the
+     * full stylesheet (`dou-ui/style.css`) is loaded once instead.
+     *
+     * @default true
+     */
+    importStyle?: boolean;
+    /**
+     * Resolve `v-loading` and `v-infinite-scroll` too.
+     *
+     * @default true
+     */
+    directives?: boolean;
+    /**
+     * Resolve `<SearchIcon />` and the other icons of `@dou-ui/icons`.
+     *
+     * @default true when `@dou-ui/icons` can be found from `root`
+     */
+    icons?: boolean;
+    /**
+     * The project directory, where `@dou-ui/icons` is looked for. Pass Vite's
+     * `root` when it is not the directory Vite runs in (`vite --root apps/web`).
+     *
+     * @default process.cwd()
+     */
+    root?: string;
+    /** Names to leave alone, e.g. ones the app defines itself. */
+    exclude?: RegExp | string[];
+}
+/**
+ * The functions of `dou-ui` worth importing automatically, with the
+ * directory of the style entry for what they render (`null` when they
+ * render nothing).
+ */
+export declare const functionDirs: Readonly<Record<string, string | null>>;
+/** The directives of `dou-ui`, by the name they are written with (`v-loading` → `Loading`). */
+export declare const directives: Readonly<Record<string, {
+    name: string;
+    dir: string;
+}>>;
+/**
+ * Resolve DouUI components (and the directives) as they are used in templates,
+ * for an on-demand components plugin. Besides `dou-ui`, this covers the
+ * packages built on it (`<DouChart>`, `<DouEditor>`, …) and the icons of
+ * `@dou-ui/icons`.
+ *
+ * ```ts
+ * Components({ resolvers: [DouUIResolver()] })
+ * ```
+ *
+ * `<DouButton>` becomes `import { DouButton } from 'dou-ui'` plus
+ * `import 'dou-ui/components/button/style'`; `<DouChartLine>` becomes
+ * `import { DouChartLine } from '@dou-ui/chart'` plus
+ * `import '@dou-ui/chart/style'`.
+ */
+export declare function DouUIResolver(options?: DouUIResolverOptions): ComponentResolver[];
+/**
+ * Resolve the functions of DouUI (`toast`, `dialog`, `useDialog`,
+ * `vLoading`, `vInfiniteScroll`, `useSortable`, `useColorMode`,
+ * `useCountdown`) for an auto-import plugin, with the styles of what they show.
+ *
+ * ```ts
+ * AutoImport({ resolvers: [DouUIApiResolver()] })
+ * ```
+ */
+export declare function DouUIApiResolver(options?: Pick<DouUIResolverOptions, 'importStyle' | 'exclude'>): ResolverFunction;
+export { componentDirs, iconNames, packageComponents };

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@dou-ui/resolver",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.0",
+  "description": "DouUI 的按需自动导入解析器：组件、图标、指令、函数与样式入口",
+  "keywords": [
+    "vue",
+    "dou-ui",
+    "auto-import",
+    "resolver"
+  ],
+  "license": "MIT",
+  "author": "daidr <daidr@daidr.me>",
+  "homepage": "https://github.com/daidr/dou-ui#readme",
+  "bugs": "https://github.com/daidr/dou-ui/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/daidr/dou-ui.git",
+    "directory": "packages/resolver"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "gen": "bun scripts/gen.ts",
+    "build": "bun scripts/build.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}