@xyd-js/plugin-docs 0.1.0-xyd.2 → 0.1.0-xyd.4

package/src/types.ts

@@ -0,0 +1,38 @@
+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}
+}
+
+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")
+}

package/tsconfig.json

@@ -0,0 +1,51 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@xyd-js/atlas": [
+        "../xyd-atlas"
+      ],
+      "@xyd-js/core": [
+        "../xyd-core/index.ts"
+      ],
+      "@xyd-js/themes": [
+        "../xyd-themes/src/index.ts"
+      ],
+      "@xyd-js/components/content": [
+        "../xyd-components/content.ts"
+      ],
+      "@xyd-js/framework/react": [
+        "../xyd-framework/packages/react/index.ts"
+      ]
+    },
+    "types": [
+      "unplugin-icons/types/react"
+    ],
+    "module": "esnext",
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "baseUrl": ".",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "noEmit": true,
+    "incremental": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [],
+    "strictNullChecks": true
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/tsup.config.ts

@@ -0,0 +1,74 @@
+import {defineConfig, Options} from 'tsup';
+
+import pkg from './package.json';
+
+const deps = [
+    ...Object.keys(pkg.dependencies || {}),
+    ...Object.keys(pkg.devDependencies || {}),
+].filter((dep) => [
+   
+].indexOf(dep) === -1)
+
+const config: Options = {
+    entry: {
+        index: 'src/index.ts',
+    },
+    dts: {
+        entry: {
+            index: 'src/index.ts',
+        },
+        resolve: true, // Resolve external types
+    },
+    format: ['esm'],
+    platform: 'node',
+    shims: false,
+    splitting: false,
+    sourcemap: true,
+    clean: true,
+    external: [
+        ...deps,
+
+    //     "@graphql-markdown/core": "^1.12.0",
+    // "@graphql-markdown/graphql": "^1.1.4",
+    // "@graphql-markdown/types": "^1.4.0",
+    // "graphql-config": "^5.1.2",
+    // "gray-matter": "^4.0.3",
+    // "json-to-graphql-query": "^2.3.0"
+
+        // Externalize gql modules
+        // '@graphql-markdown/core',
+        // '@graphql-markdown/graphql',
+        // '@graphql-markdown/types',
+        // 'graphql-config',
+        // 'gray-matter',
+        // 'json-to-graphql-query',
+
+        // Externalize Node.js built-in modules
+        /^node:.*/,
+        'fs',
+        'path',
+        'url',
+        'os',
+        'http',
+        'https',
+        'stream',
+        'zlib',
+        'util',
+        'crypto',
+        'tty',
+        // Add other built-in modules as needed
+    ],
+    esbuildPlugins: [
+        {
+            name: 'external-node-builtins',
+            setup(build) {
+                const filter = /^node:/;
+                build.onResolve({filter}, args => {
+                    return {path: args.path, external: true};
+                });
+            },
+        },
+    ],
+}
+
+export default defineConfig(config);

package/dist/index.d.ts

@@ -1,42 +0,0 @@
-import { Plugin as Plugin$1 } from 'vite';
-import { RouteConfigEntry } from '@react-router/dev/routes';
-import { Settings } from '@xyd-js/core';
-
-interface PluginOutput {
-    vitePlugins: Plugin$1[];
-    settings: Settings;
-    routes: RouteConfigEntry[];
-    basePath: string;
-    pagePathMapping: {
-        [page: string]: string;
-    };
-}
-type Plugin = () => Promise<PluginOutput | null>;
-
-/**
- * Reads `xyd` settings from the current working directory.
- *
- * This function searches for a file named 'xyd' with one of the supported extensions
- * (tsx, jsx, js, ts, json) in the current working directory. If found, it loads the
- * settings from that file.
- *
- * For React-based settings files (tsx, jsx, js, ts), it uses Vite's SSR module loading
- * to evaluate the file and extract the default export. For JSON files, it simply
- * parses the JSON content.
- *
- * @returns A Promise that resolves to:
- *   - The Settings object if a valid settings file was found and loaded
- *   - A string if the settings file contains a string value
- *   - null if no settings file was found or an error occurred
- *
- * @throws May throw errors if file reading or parsing fails
- */
-declare function readSettings(): Promise<Settings | null>;
-
-interface PluginDocsOptions {
-    disableAPIGeneration?: boolean;
-    disableFSWrite?: boolean;
-}
-declare function pluginDocs(options?: PluginDocsOptions): Promise<PluginOutput | null>;
-
-export { type Plugin, type PluginDocsOptions, type PluginOutput, pluginDocs, readSettings };