doclific 0.1.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+*.log
+package-lock.json
+

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 4,
+  "useTabs": true,
+  "arrowParens": "always"
+}

package/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package/dist/bin/doclific.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=doclific.d.ts.map

package/dist/bin/doclific.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doclific.d.ts","sourceRoot":"","sources":["../../src/bin/doclific.ts"],"names":[],"mappings":""}

package/dist/bin/doclific.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { spawn } from 'child_process';
+import { startServer } from '../server/index.js';
+const port = process.argv.find((arg) => arg.startsWith('-p=') || arg.startsWith('--port='))?.split('=')[1] ||
+    6767;
+const cwd = process.cwd();
+console.log('Doclific CLI running in directory:', cwd);
+startServer(Number(port));
+// Optional: open browser automatically
+const open = process.platform === 'win32' ? 'start' : process.platform === 'darwin' ? 'open' : 'xdg-open';
+spawn(open, [`http://localhost:${port}`]);

package/dist/core/codebase.js

@@ -0,0 +1,31 @@
+import path from 'path';
+import fs from 'fs/promises';
+/**
+ * Get all contents of a folder given a filePath.
+ * @param filePath - The relative path to the folder
+ */
+export const getFolderContents = async (filePath) => {
+    const currentDir = process.cwd();
+    let fullPath = '';
+    if (filePath !== '') {
+        fullPath = path.join(currentDir, filePath);
+    }
+    else {
+        fullPath = currentDir;
+    }
+    const entries = await fs.readdir(fullPath, { withFileTypes: true });
+    const nodes = [];
+    for (const entry of entries) {
+        nodes.push({
+            path: path.join(filePath, entry.name),
+            name: entry.name,
+            type: entry.isDirectory() ? 'directory' : 'file',
+        });
+    }
+    return nodes;
+};
+export const getFileContents = async (filePath) => {
+    const currentDir = process.cwd();
+    const fullPath = path.join(currentDir, filePath);
+    return fs.readFile(fullPath, 'utf8');
+};

package/dist/core/docs.js

@@ -0,0 +1,75 @@
+import fs from 'fs/promises';
+import path from 'path';
+const scanDirectory = async (dirPath) => {
+    const entries = await fs.readdir(dirPath, { withFileTypes: true });
+    const folders = [];
+    for (const entry of entries) {
+        if (entry.isDirectory()) {
+            const fullPath = path.join(dirPath, entry.name);
+            const children = await scanDirectory(fullPath);
+            let config = {
+                title: entry.name,
+                icon: undefined,
+            };
+            // get the config.json file
+            const configPath = path.join(fullPath, 'config.json');
+            try {
+                const configFile = await fs.readFile(configPath, 'utf8');
+                config = JSON.parse(configFile);
+            }
+            catch {
+                throw new Error(`Config file not found for ${entry.name}`);
+            }
+            folders.push({
+                name: entry.name,
+                title: config.title,
+                icon: config.icon,
+                children,
+            });
+        }
+    }
+    return folders;
+};
+export const getDocs = async () => {
+    const docsFolder = path.join(process.cwd(), 'doclific');
+    try {
+        await fs.access(docsFolder);
+    }
+    catch {
+        return [];
+    }
+    return scanDirectory(docsFolder);
+};
+/**
+ * This function will return the content of the .mdx file in the directory with the given filePath.
+ * @param filePath - The path to the file
+ * @returns
+ */
+export const getDoc = async (filePath) => {
+    const currentDir = process.cwd();
+    const fullPath = path.join(currentDir, 'doclific', filePath);
+    try {
+        return fs.readFile(path.join(fullPath, 'content.mdx'), 'utf8');
+    }
+    catch {
+        return undefined;
+    }
+};
+export const updateDoc = async (filePath, content) => {
+    const currentDir = process.cwd();
+    const fullPath = path.join(currentDir, 'doclific', filePath);
+    await fs.writeFile(path.join(fullPath, 'content.mdx'), content);
+};
+export const createDoc = async (filePath, title, icon) => {
+    const currentDir = process.cwd();
+    const fullPath = path.join(currentDir, 'doclific', filePath);
+    const newFolderName = crypto.randomUUID();
+    const newFolderPath = path.join(fullPath, newFolderName);
+    await fs.mkdir(newFolderPath, { recursive: true });
+    // create content.mdx file
+    await fs.writeFile(path.join(newFolderPath, 'content.mdx'), '# Hello World');
+    // create config.json file
+    await fs.writeFile(path.join(newFolderPath, 'config.json'), JSON.stringify({ title, icon }, null, 2));
+    // return the new folder path
+    return newFolderPath;
+};

package/dist/core/git.js

@@ -0,0 +1,47 @@
+import util from 'util';
+import { exec } from 'child_process';
+const execAsync = util.promisify(exec);
+export const getGitRepositoryName = async () => {
+    try {
+        const GET_REPO_NAME_COMMAND = `git config --get remote.origin.url | sed -E "s|.*/(.+)\\.git|\\1|"`;
+        const repoName = await execAsync(GET_REPO_NAME_COMMAND);
+        return repoName.stdout.toString().trim();
+    }
+    catch (error) {
+        console.error(error);
+        return null;
+    }
+};
+export const getGitRepositoryBranch = async () => {
+    try {
+        const GET_REPO_BRANCH_COMMAND = `git rev-parse --abbrev-ref HEAD`;
+        const repoBranch = await execAsync(GET_REPO_BRANCH_COMMAND);
+        return repoBranch.stdout.toString().trim();
+    }
+    catch (error) {
+        console.error(error);
+        return null;
+    }
+};
+export const getGitUser = async () => {
+    try {
+        const GET_USER_COMMAND = `git config user.name`;
+        const user = await execAsync(GET_USER_COMMAND);
+        return user.stdout.toString().trim();
+    }
+    catch (error) {
+        console.error(error);
+        return null;
+    }
+};
+export const getGitUserEmail = async () => {
+    try {
+        const GET_USER_EMAIL_COMMAND = `git config user.email`;
+        const userEmail = await execAsync(GET_USER_EMAIL_COMMAND);
+        return userEmail.stdout.toString().trim();
+    }
+    catch (error) {
+        console.error(error);
+        return null;
+    }
+};

package/dist/server/index.d.ts

@@ -0,0 +1,2 @@
+export declare function startServer(port?: number): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/server/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAMA,wBAAgB,WAAW,CAAC,IAAI,GAAE,MAAa,QAyB9C"}

package/dist/server/index.js

@@ -0,0 +1,46 @@
+import express from 'express';
+import cors from 'cors';
+import { RPCHandler } from '@orpc/server/node';
+import { onError } from '@orpc/server';
+import { router } from './router.js';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const frontendDist = path.join(__dirname, '../../frontend/dist');
+export function startServer(port = 6767) {
+    const app = express();
+    app.use(cors());
+    const handler = new RPCHandler(router, {
+        interceptors: [
+            onError((error) => {
+                console.error(error);
+            }),
+        ],
+    });
+    app.use('/rpc{/*path}', async (req, res, next) => {
+        const { matched } = await handler.handle(req, res, {
+            prefix: '/rpc',
+            context: {},
+        });
+        if (matched)
+            return;
+        next();
+    });
+    // serve static files in frontend/dist
+    app.use((req, res, next) => {
+        if (req.url === '/') {
+            const html = fs.readFileSync(path.join(frontendDist, 'index.html'), 'utf8');
+            res.send(html.replace(': BACKEND_PORT', `: ${port.toString()}`));
+        }
+        else {
+            express.static(frontendDist)(req, res, next);
+        }
+    });
+    app.get('/{*splat}', (req, res) => {
+        const html = fs.readFileSync(path.join(frontendDist, 'index.html'), 'utf8');
+        res.send(html.replace(': BACKEND_PORT', `: ${port.toString()}`));
+    });
+    app.listen(port, () => console.log(`Access your documentation here: http://localhost:${port}`));
+}

package/dist/server/router.d.ts

@@ -0,0 +1,9 @@
+export declare const router: {
+    ping: import("@orpc/server").DecoratedProcedure<Record<never, never>, Record<never, never>, import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<string, string>, Record<never, never>, Record<never, never>>;
+    pong: import("@orpc/server").DecoratedProcedure<Record<never, never>, Record<never, never>, import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<string, string>, Record<never, never>, Record<never, never>>;
+    nested: {
+        ping: import("@orpc/server").DecoratedProcedure<Record<never, never>, Record<never, never>, import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<string, string>, Record<never, never>, Record<never, never>>;
+        pong: import("@orpc/server").DecoratedProcedure<Record<never, never>, Record<never, never>, import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<string, string>, Record<never, never>, Record<never, never>>;
+    };
+};
+//# sourceMappingURL=router.d.ts.map

package/dist/server/router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/server/router.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,MAAM;;;;;;;CAIlB,CAAC"}

package/dist/server/router.js

@@ -0,0 +1,55 @@
+import { os } from '@orpc/server';
+import { getGitRepositoryBranch, getGitRepositoryName, getGitUser, getGitUserEmail, } from '../core/git.js';
+import { createDoc, getDoc, getDocs, updateDoc } from '../core/docs.js';
+import { z } from 'zod';
+import { getFileContents, getFolderContents } from '../core/codebase.js';
+import path from 'path';
+export const router = {
+    git: {
+        getRepoInfo: os.handler(async () => {
+            return {
+                repositoryName: await getGitRepositoryName(),
+                repositoryBranch: await getGitRepositoryBranch(),
+                user: await getGitUser(),
+                userEmail: await getGitUserEmail(),
+            };
+        }),
+    },
+    docs: {
+        getDocs: os.handler(async () => {
+            return await getDocs();
+        }),
+        getDoc: os.input(z.object({ filePath: z.string() })).handler(async ({ input }) => {
+            const { filePath } = input;
+            return await getDoc(filePath);
+        }),
+        updateDoc: os
+            .input(z.object({ filePath: z.string(), content: z.string() }))
+            .handler(async ({ input }) => {
+            const { filePath, content } = input;
+            return await updateDoc(filePath, content);
+        }),
+        createDoc: os
+            .input(z.object({ filePath: z.string(), title: z.string(), icon: z.string().optional() }))
+            .handler(async ({ input }) => {
+            const { filePath, title, icon } = input;
+            return await createDoc(filePath, title, icon);
+        }),
+    },
+    codebase: {
+        getFolderContents: os
+            .input(z.object({ filePath: z.string() }))
+            .handler(async ({ input }) => {
+            const { filePath } = input;
+            return await getFolderContents(filePath);
+        }),
+        getFileContents: os.input(z.object({ filePath: z.string() })).handler(async ({ input }) => {
+            const { filePath } = input;
+            const currentDir = process.cwd();
+            return {
+                contents: await getFileContents(filePath),
+                fullPath: path.join(currentDir, '..', filePath),
+            };
+        }),
+    },
+};

package/frontend/README.md

@@ -0,0 +1,73 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## React Compiler
+
+The React Compiler is currently not compatible with SWC. See [this issue](https://github.com/vitejs/vite-plugin-react/issues/428) for tracking the progress.
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

package/frontend/components.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "src/index.css",
+    "baseColor": "zinc",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "registries": {
+    "@plate": "https://platejs.org/r/{name}.json"
+  }
+}

package/frontend/eslint.config.js

@@ -0,0 +1,23 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+  },
+])

package/frontend/index.html

@@ -0,0 +1,25 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Doclific</title>
+		<link rel="preconnect" href="https://fonts.googleapis.com" />
+		<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+		<link
+			href="https://fonts.googleapis.com/css2?family=Google+Sans+Code:ital,wght@0,300..800;1,300..800&display=swap"
+			rel="stylesheet"
+		/>
+		<script>
+			const BACKEND_PORT = 6767;
+			window.env = {
+				PORT: BACKEND_PORT,
+			};
+		</script>
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>