docus 1.0.6 → 2.0.0-alpha.0

package/dist/main.mjs

@@ -0,0 +1,238 @@
+#!/usr/bin/env node
+
+// cli/main.ts
+import * as dotenv from "dotenv";
+
+// cli/cli.ts
+import { resolve as resolve2 } from "path";
+import { defineCommand, runMain } from "citty";
+
+// cli/setup.ts
+import { fileURLToPath } from "url";
+import { resolve } from "path";
+import { readFile } from "fs/promises";
+
+// cli/git.ts
+import { execSync } from "child_process";
+import { readGitConfig } from "pkg-types";
+import gitUrlParse from "git-url-parse";
+function getGitBranch() {
+  const envName = process.env.CF_PAGES_BRANCH || process.env.CI_COMMIT_BRANCH || process.env.VERCEL_GIT_COMMIT_REF || process.env.BRANCH || process.env.GITHUB_REF_NAME;
+  if (envName && envName !== "HEAD") {
+    return envName;
+  }
+  try {
+    const branch = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
+    if (branch && branch !== "HEAD") {
+      return branch;
+    }
+  } catch {
+    return "main";
+  }
+}
+async function getLocalGitInfo(rootDir) {
+  const remote = await getLocalGitRemote(rootDir);
+  if (!remote) {
+    return;
+  }
+  const { name, owner, source } = gitUrlParse(remote);
+  const url = `https://${source}/${owner}/${name}`;
+  return {
+    name,
+    owner,
+    url
+  };
+}
+async function getLocalGitRemote(dir) {
+  var _a, _b;
+  try {
+    const parsed = await readGitConfig(dir);
+    if (!parsed) {
+      return;
+    }
+    return (_b = (_a = parsed.remote) == null ? void 0 : _a["origin"]) == null ? void 0 : _b.url;
+  } catch {
+  }
+}
+function getGitEnv() {
+  var _a, _b, _c;
+  const envInfo = {
+    // Provider
+    provider: process.env.VERCEL_GIT_PROVIDER || (process.env.GITHUB_SERVER_URL ? "github" : void 0) || "",
+    // Owner
+    owner: process.env.VERCEL_GIT_REPO_OWNER || process.env.GITHUB_REPOSITORY_OWNER || ((_a = process.env.CI_PROJECT_PATH) == null ? void 0 : _a.split("/").shift()) || "",
+    // Name
+    name: process.env.VERCEL_GIT_REPO_SLUG || ((_b = process.env.GITHUB_REPOSITORY) == null ? void 0 : _b.split("/").pop()) || ((_c = process.env.CI_PROJECT_PATH) == null ? void 0 : _c.split("/").splice(1).join("/")) || "",
+    // Url
+    url: process.env.REPOSITORY_URL || ""
+    // netlify
+  };
+  if (!envInfo.url && envInfo.provider && envInfo.owner && envInfo.name) {
+    envInfo.url = `https://${envInfo.provider}.com/${envInfo.owner}/${envInfo.name}`;
+  }
+  if (!envInfo.name && !envInfo.owner && envInfo.url) {
+    try {
+      const { name, owner } = gitUrlParse(envInfo.url);
+      envInfo.name = name;
+      envInfo.owner = owner;
+    } catch {
+    }
+  }
+  return {
+    name: envInfo.name,
+    owner: envInfo.owner,
+    url: envInfo.url
+  };
+}
+
+// cli/setup.ts
+var appDir = fileURLToPath(new URL("../app", import.meta.url));
+var pkgDir = fileURLToPath(new URL("..", import.meta.url));
+async function getNuxtConfig(dir, _opts = {}) {
+  const meta = await getPackageJsonMetadata(dir);
+  const fixLayers = (_, nuxt) => {
+    const hasDocsDir = nuxt.options._layers.some((layer) => layer.cwd === dir);
+    if (!hasDocsDir) {
+      nuxt.options._layers.unshift({
+        cwd: dir,
+        config: {
+          rootDir: dir,
+          srcDir: dir
+        }
+      });
+    }
+  };
+  global.__DOCS_DIR__ = resolve(dir, "content");
+  const gitInfo = await getLocalGitInfo(dir) || getGitEnv();
+  const url = inferSiteURL();
+  return {
+    compatibilityDate: "2025-04-24",
+    extends: [appDir],
+    modulesDir: [resolve(pkgDir, "node_modules"), resolve(appDir, "node_modules")],
+    modules: ["nuxt-llms", fixLayers],
+    appConfig: {
+      header: {
+        title: meta.name || ""
+      },
+      github: {
+        owner: gitInfo == null ? void 0 : gitInfo.owner,
+        name: gitInfo == null ? void 0 : gitInfo.name,
+        url: gitInfo == null ? void 0 : gitInfo.url,
+        branch: getGitBranch()
+      },
+      seo: {
+        titleTemplate: `%s - ${meta.name}`,
+        title: meta.name || "",
+        description: meta.description || ""
+      },
+      toc: {}
+    },
+    site: {
+      url,
+      name: meta.name || ""
+    },
+    llms: {
+      domain: url,
+      title: meta.name || "",
+      description: meta.description || ""
+    },
+    future: {
+      compatibilityVersion: 4
+    }
+  };
+}
+function inferSiteURL() {
+  return process.env.NUXT_SITE_URL || process.env.NEXT_PUBLIC_VERCEL_URL && `https://${process.env.NEXT_PUBLIC_VERCEL_URL}` || process.env.URL || process.env.CI_PAGES_URL || process.env.CF_PAGES_URL;
+}
+async function getPackageJsonMetadata(dir) {
+  try {
+    const packageJson = await readFile(resolve(dir, "package.json"), "utf-8");
+    const parsed = JSON.parse(packageJson);
+    return {
+      name: parsed.name,
+      description: parsed.description
+    };
+  } catch {
+    return {
+      name: "docs"
+    };
+  }
+}
+
+// cli/cli.ts
+function createCLI(opts) {
+  const sharedArgs = {
+    dir: {
+      type: "positional",
+      description: "Docs directory",
+      required: true,
+      default: "."
+    }
+  };
+  const init = defineCommand({
+    meta: {
+      name: "init",
+      description: "Initialize a fresh Docus project"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const { runCommand } = await import("nuxi");
+      await runCommand("init", [dir, "-t", "gh:nuxt-themes/docus/.starter#feat/docus-v2", dir]);
+    }
+  });
+  const dev = defineCommand({
+    meta: {
+      name: "dev",
+      description: "Start docs in development mode"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const nuxtConfig = await getNuxtConfig(dir, {
+        ...opts.setup,
+        dev: true
+      });
+      const { runCommand } = await import("nuxi");
+      await runCommand("dev", [dir, "--no-fork", "--port", process.env.PORT || "4000"], { overrides: nuxtConfig });
+    }
+  });
+  const build = defineCommand({
+    meta: {
+      name: "build",
+      description: "Build docs for production"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const nuxtConfig = await getNuxtConfig(dir, opts.setup);
+      const { runCommand } = await import("nuxi");
+      await runCommand("build", [dir], { overrides: nuxtConfig });
+    }
+  });
+  const main = defineCommand({
+    meta: {
+      name: opts.name,
+      description: opts.description
+    },
+    subCommands: {
+      init,
+      dev,
+      build
+    }
+  });
+  return {
+    runMain: () => runMain(main)
+  };
+}
+
+// cli/main.ts
+dotenv.config();
+var cli = createCLI({
+  name: "Docus",
+  description: "Docus Docs CLI",
+  setup: {
+    defaults: {}
+  }
+});
+cli.runMain();

package/package.json

@@ -1,72 +1,73 @@
 {
   "name": "docus",
-  "version": "1.0.6",
-  "description": "The Docus CLI.",
-  "repository": "https://github.com/docusgen/cli",
-  "bugs": {
-    "url": "https://github.com/docusgen/cli/issues"
+  "description": "Minimal Documentation theme and CLI for shared usage across Nuxt modules",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nuxtlabs/docus"
   },
-  "homepage": "https://github.com/docusgen/cli#readme",
-  "author": "Yaël GUILLOUX <yael.guilloux@gmail.com>",
+  "private": false,
+  "version": "2.0.0-alpha.0",
+  "keywords": [],
   "license": "MIT",
-  "keywords": [
-    "typescript",
-    "starter"
-  ],
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/src/index.d.ts",
-  "scripts": {
-    "dev": "jiti scripts/watch.ts --cache",
-    "build": "unbuild",
-    "lint": "prettier -c --parser typescript \"{src,tests}/**/*.[jt]s?(x)\"",
-    "lint:fix": "yarn run lint --write",
-    "test:types": "tsc --build tsconfig.json",
-    "test:unit": "jest",
-    "test": "yarn run test:types && yarn run test:unit"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
   "bin": {
-    "create-docus": "dist/create-docus/create-docus.js"
+    "docus": "./dist/main.mjs"
   },
   "files": [
-    "dist/**/*",
-    "LICENSE",
-    "README.md"
+    "app",
+    "dist",
+    "!app/**/node_modules",
+    "!app/**/.nuxt",
+    "!app/**/tsconfig.json"
   ],
+  "scripts": {
+    "dev": "npm run docs:dev",
+    "docs:dev": "NUXT_DOCS_DEV=1 npm run docus dev docs",
+    "docs:build": "npm run docus build docs",
+    "dev:prepare": "nuxi prepare app && nuxi prepare docs",
+    "build": "tsup-node ./cli/main.ts --format esm",
+    "docus": "tsx ./cli/main.ts",
+    "test": "echo \"Error: no test specified\"",
+    "lint": "eslint .",
+    "release": "npm run lint && npm run test && npm run build && release-it"
+  },
   "dependencies": {
-    "degit": "^2.8.4",
-    "execa": "^5.1.1",
-    "kolorist": "^1.5.0",
-    "minimist": "^1.2.5",
-    "prompts": "^2.4.1"
+    "@iconify-json/lucide": "^1.2.47",
+    "@iconify-json/simple-icons": "^1.2.38",
+    "@iconify-json/vscode-icons": "^1.2.22",
+    "@nuxt/content": "https://pkg.pr.new/@nuxt/content@d98bf49",
+    "@nuxt/image": "^1.10.0",
+    "@nuxt/ui-pro": "^3.1.3",
+    "@nuxtjs/robots": "^5.2.10",
+    "c12": "^3.0.4",
+    "citty": "^0.1.6",
+    "dotenv": "^16.5.0",
+    "git-url-parse": "^16.1.0",
+    "minimark": "^0.2.0",
+    "motion-v": "^1.2.1",
+    "nuxi": "^3.25.1",
+    "nuxt-llms": "^0.1.3",
+    "nuxt-og-image": "^5.1.6",
+    "pkg-types": "^2.1.0",
+    "tailwindcss": "^4.1.8",
+    "ufo": "^1.6.1",
+    "unctx": "^2.4.1"
   },
   "devDependencies": {
-    "@types/degit": "^2.8.3",
-    "@types/jest": "^27.0.1",
-    "@types/minimist": "^1.2.2",
-    "@types/prompts": "^2.0.14",
-    "chokidar": "^3.5.2",
-    "jest": "^27.0.6",
-    "jiti": "^1.11.0",
-    "lint-staged": "^11.1.2",
-    "pascalcase": "^1.0.0",
-    "prettier": "^2.3.2",
-    "ts-jest": "^27.0.5",
-    "typescript": "^4.3.5",
-    "unbuild": "^0.4.2"
+    "@nuxt/eslint-config": "^1.4.1",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@stylistic/eslint-plugin": "^4.4.1",
+    "@types/node": "^24.0.0",
+    "@typescript-eslint/parser": "^8.34.0",
+    "changelogen": "^0.6.1",
+    "eslint": "^9.28.0",
+    "release-it": "^19.0.3",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
   },
-  "gitHooks": {
-    "pre-commit": "lint-staged"
+  "peerDependencies": {
+    "better-sqlite3": "11.x",
+    "nuxt": "3.x"
   },
-  "lint-staged": {
-    "*.js": [
-      "prettier --write"
-    ],
-    "*.ts?(x)": [
-      "prettier --parser=typescript --write"
-    ]
-  }
+  "packageManager": "pnpm@10.12.1"
 }

package/dist/create-docus/create-docus.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-// #!/usr/bin/env node
-"use strict";
-
-var _index = require("./index");
-
-(0, _index.createDocus)().catch(console.log);

package/dist/create-docus/index.js

@@ -1,122 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDocus = createDocus;
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _minimist = _interopRequireDefault(require("minimist"));
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _execa = _interopRequireDefault(require("execa"));
-
-var _helpers = require("../helpers");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const argv = (0, _minimist.default)(process.argv.slice(2));
-const {
-  motd,
-  primary,
-  secondary,
-  bold,
-  space,
-  broadcast
-} = (0, _helpers.log)();
-const cwd = process.cwd();
-
-async function createDocus() {
-  motd();
-  let targetDir = argv._[0];
-
-  if (!targetDir) {
-    const {
-      projectName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "projectName",
-      message: "Project name:",
-      initial: "my-website"
-    });
-    targetDir = projectName.trim();
-  }
-
-  const packageName = await (0, _helpers.getValidPackageName)(targetDir);
-
-  const root = _path.default.join(cwd, targetDir);
-
-  await (0, _helpers.overwriteDir)(root);
-  space();
-  broadcast(secondary("Scaffolding project in ") + targetDir + secondary("..."));
-  const {
-    templateDir
-  } = await (0, _helpers.getTemplate)();
-
-  const write = (file, content = void 0) => {
-    const targetPath = _path.default.join(root, file);
-
-    if (content) _fs.default.writeFileSync(targetPath, content);else (0, _helpers.copy)(_path.default.join(templateDir, file), targetPath);
-  };
-
-  const files = _fs.default.readdirSync(templateDir);
-
-  for (const file of files.filter(f => f !== "package.json")) write(file);
-
-  const pkg = require(_path.default.join(templateDir, "package.json"));
-
-  pkg.name = packageName;
-  write("package.json", JSON.stringify(pkg, null, 2));
-  const pkgManager = /pnpm/.test(process.env.npm_execpath || "") || /pnpm/.test(process.env.npm_config_user_agent || "") ? "pnpm" : /yarn/.test(process.env.npm_execpath || "") ? "yarn" : "npm";
-
-  const related = _path.default.relative(cwd, root);
-
-  broadcast(primary("Done."));
-  space();
-  const {
-    yes
-  } = await (0, _prompts.default)({
-    type: "confirm",
-    name: "yes",
-    initial: "Y",
-    message: "Install and start it now?"
-  });
-  if (yes) await startProject(root);else startItLater(pkgManager, root, related);
-}
-
-async function startProject(projectPath) {
-  space();
-  const {
-    agent
-  } = await (0, _prompts.default)({
-    name: "agent",
-    type: "select",
-    message: "Choose the agent",
-    choices: ["yarn", "npm", "pnpm"].map(i => ({
-      value: i,
-      title: i
-    }))
-  });
-  if (!agent) return;
-  await (0, _execa.default)(agent, ["install"], {
-    stdio: "inherit",
-    cwd: projectPath
-  });
-  await (0, _execa.default)(agent, ["run", "dev"], {
-    stdio: "inherit",
-    cwd: projectPath
-  });
-}
-
-function startItLater(pkgManager, root, dir) {
-  space();
-  broadcast(secondary("Start it later with:"));
-  space();
-  if (root !== cwd) broadcast(primary(`cd ${bold(dir)}`));
-  broadcast(primary(`${pkgManager === "yarn" ? "yarn" : `${pkgManager} install`}`));
-  broadcast(primary(`${pkgManager === "yarn" ? "yarn dev" : `${pkgManager} run dev`}`));
-}

package/dist/helpers.js

@@ -1,154 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.copy = copy;
-exports.log = log;
-exports.getTemplate = getTemplate;
-exports.overwriteDir = overwriteDir;
-exports.getValidPackageName = getValidPackageName;
-
-var _package = require("../package.json");
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _kolorist = require("kolorist");
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _degit = _interopRequireDefault(require("degit"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function copyDir(srcDir, destDir) {
-  _fs.default.mkdirSync(destDir, {
-    recursive: true
-  });
-
-  for (const file of _fs.default.readdirSync(srcDir)) {
-    const srcFile = _path.default.resolve(srcDir, file);
-
-    const destFile = _path.default.resolve(destDir, file);
-
-    copy(srcFile, destFile);
-  }
-}
-
-function emptyDir(dir) {
-  if (!_fs.default.existsSync(dir)) return;
-
-  for (const file of _fs.default.readdirSync(dir)) {
-    const abs = _path.default.resolve(dir, file);
-
-    if (_fs.default.lstatSync(abs).isDirectory()) {
-      emptyDir(abs);
-
-      _fs.default.rmdirSync(abs);
-    } else {
-      _fs.default.unlinkSync(abs);
-    }
-  }
-}
-
-function copy(src, dest) {
-  const stat = _fs.default.statSync(src);
-
-  if (stat.isDirectory()) copyDir(src, dest);else _fs.default.copyFileSync(src, dest);
-}
-
-function log() {
-  const commands = {
-    space: () => console.log(),
-    bold: str => (0, _kolorist.bold)(str),
-    primary: str => (0, _kolorist.green)(str),
-    secondary: str => (0, _kolorist.dim)(str),
-    warning: str => (0, _kolorist.yellow)(str),
-    broadcast: str => console.log(`  ${str}`),
-    motd: () => {
-      commands.space();
-      commands.broadcast(`${(0, _kolorist.bold)("Docus") + commands.secondary(" CLI")} ${commands.primary(`v${_package.version}`)}`);
-      commands.space();
-    }
-  };
-  return commands;
-}
-
-async function getTemplate() {
-  const {
-    broadcast,
-    primary,
-    secondary
-  } = log();
-
-  const templateDir = _path.default.join(__dirname, "./template");
-
-  broadcast([secondary("Cloning the latest"), primary("Docus"), secondary("template...")].join(" "));
-  emptyDir(templateDir);
-  const repo = (0, _degit.default)("git@github.com:docusgen/starter.git", {
-    force: true,
-    verbose: true,
-    mode: "git"
-  });
-  await repo.clone(templateDir);
-  return {
-    templateDir
-  };
-}
-
-async function overwriteDir(path2) {
-  const {
-    broadcast,
-    warning,
-    space
-  } = log();
-
-  if (!_fs.default.existsSync(path2)) {
-    _fs.default.mkdirSync(path2, {
-      recursive: true
-    });
-  } else {
-    const existing = _fs.default.readdirSync(path2);
-
-    const dir = path2.split("/");
-    const dirName = dir[dir.length - 1];
-
-    if (existing.length) {
-      space();
-      broadcast(warning(`Target directory "${dirName}" is not empty.`));
-      space();
-      const {
-        yes
-      } = await (0, _prompts.default)({
-        type: "confirm",
-        name: "yes",
-        initial: "Y",
-        message: "Remove existing files and continue?"
-      });
-      if (yes) emptyDir(path2);else return;
-    }
-  }
-}
-
-async function getValidPackageName(projectName) {
-  projectName = _path.default.basename(projectName);
-  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
-
-  if (packageNameRegExp.test(projectName)) {
-    return projectName;
-  } else {
-    const suggestedPackageName = projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z0-9-~]+/g, "-");
-    const {
-      inputPackageName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "inputPackageName",
-      message: "Package name:",
-      initial: suggestedPackageName,
-      validate: input => packageNameRegExp.test(input) ? true : "Invalid package.json name"
-    });
-    return inputPackageName;
-  }
-}

package/dist/index.js

@@ -1,10 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-module.exports = void 0;
-
-var _default = () => {};
-
-module.exports = _default;