@xyd-js/plugin-docs 0.1.0-build.160

package/src/types.ts

@@ -0,0 +1,40 @@
+import {Plugin as VitePlugin} from "vite"
+import {RouteConfigEntry} from "@react-router/dev/routes";
+
+import {Settings} from "@xyd-js/core";
+
+type VitePluginData = {
+    preinstall: any // TODO: fix any
+}
+
+export interface PresetData {
+    routes: RouteConfigEntry[]
+}
+
+export type Preset<T> = (
+    settings?: Settings,
+    options?: T
+) => {
+    // TODO: args and return should be based on passed preinstall plugin
+    preinstall: ((options?: any) => (settings: Settings, data: PresetData) => Promise<any>)[]
+    routes: RouteConfigEntry[]
+    // TODO: 'data' comes from merged object of preinstall
+    vitePlugins: (() => (data: VitePluginData) => Promise<VitePlugin>)[]
+    basePath: string
+}
+
+export interface PluginOutput {
+    vitePlugins: VitePlugin[],
+
+    settings: Settings,
+
+    routes: RouteConfigEntry[]
+
+    basePath: string
+
+    pagePathMapping: {[page: string]: string}
+
+    hasIndexPage: boolean
+}
+
+export type Plugin = () => Promise<PluginOutput | null>

package/src/utils.ts

@@ -0,0 +1,19 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const HOST_FOLDER_PATH = ".xyd/host"
+
+// TODO: share with documan
+export function getHostPath() {
+    if (process.env.XYD_DEV_MODE) {
+        return path.join(__dirname, "../../../", HOST_FOLDER_PATH)
+    }
+    return path.join(process.cwd(), HOST_FOLDER_PATH)
+}
+
+export function getDocsPluginBasePath() {
+    return path.join(getHostPath(), "./plugins/xyd-plugin-docs")
+}