@heyo-sh/create-heyo-docs 0.1.0 → 0.1.1

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@heyo-sh/create-heyo-docs",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create a standalone Heyo Docs documentation project.",
   "homepage": "https://heyo.sh",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/heyo/heyo-docs.git"
+    "url": "git+https://github.com/heyo-sh/heyo-docs.git"
   },
   "bugs": {
-    "url": "https://github.com/heyo/heyo-docs/issues"
+    "url": "https://github.com/heyo-sh/heyo-docs/issues"
   },
   "license": "MIT",
   "type": "module",

package/templates/react-router/content/mdx-components.mdx

@@ -21,7 +21,7 @@ Every component below is available without an import. The examples show every vi
 
 <Button
   align="right"
-  href="https://github.com/heyo/heyo-docs"
+  href="https://github.com/heyo-sh/heyo-docs"
   target="_blank"
   variant="ghost"
   size="xs"
@@ -262,7 +262,7 @@ export function CompactExample() {
 
 <GitHub href="https://github.com/react/react" variant="inset" />
 
-<GitHub href="https://github.com/heyo/heyo-docs" />
+<GitHub href="https://github.com/heyo-sh/heyo-docs" />
 
 ## Steps
 

package/dist/index.d.ts

@@ -1,13 +0,0 @@
-#!/usr/bin/env bun
-import type { CreateOptions } from "./types";
-export { detectPackageManager, packageManagerField, packageManagerRunCommand, } from "./package-manager";
-export { scaffoldProject } from "./scaffold";
-export { mergePackageJson, replacePlaceholders } from "./utils";
-export type * from "./types";
-export declare function run(argv?: string[]): Promise<void>;
-export declare function parseArguments(argv: string[]): {
-    options: CreateOptions;
-    interactive: boolean;
-    showHelp: boolean;
-};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChE,mBAAmB,SAAS,CAAC;AA2C7B,wBAAsB,GAAG,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAC9C,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAsDA"}

package/dist/index.js

@@ -1,328 +0,0 @@
-#!/usr/bin/env bun
-// @bun
-
-// src/index.ts
-import * as p from "@clack/prompts";
-
-// src/package-manager.ts
-var FALLBACK_VERSIONS = {
-  bun: "1.3.1",
-  pnpm: "10.17.0",
-  npm: "11.6.0",
-  yarn: "4.9.4"
-};
-function detectPackageManager(userAgent = process.env.npm_config_user_agent ?? "") {
-  const match = userAgent.match(/(?:^|\s)(bun|pnpm|npm|yarn)\/([^\s]+)/);
-  if (!match)
-    return { name: "bun", version: Bun.version };
-  return { name: match[1], version: match[2] };
-}
-function packageManagerField(manager, detected = detectPackageManager()) {
-  if (manager === detected.name && detected.version)
-    return `${manager}@${detected.version}`;
-  const executable = manager === "yarn" ? "yarn" : manager;
-  try {
-    const result = Bun.spawnSync([executable, "--version"]);
-    const version = new TextDecoder().decode(result.stdout).trim();
-    if (result.exitCode === 0 && /^\d+(?:\.\d+)+/.test(version))
-      return `${manager}@${version}`;
-  } catch {}
-  return `${manager}@${FALLBACK_VERSIONS[manager]}`;
-}
-function packageManagerInstallCommand(manager) {
-  return manager === "yarn" ? ["yarn"] : [manager, "install"];
-}
-function packageManagerRunCommand(manager, script) {
-  if (manager === "npm")
-    return `npm run ${script}`;
-  if (manager === "yarn")
-    return `yarn ${script}`;
-  return `${manager} run ${script}`;
-}
-
-// src/project-name.ts
-var PROJECT_NAME_PATTERN = /^[a-z0-9][a-z0-9-]*$/i;
-function projectNameError(value) {
-  if (!value.trim())
-    return "Enter a project name.";
-  if (!PROJECT_NAME_PATTERN.test(value))
-    return "Use letters, numbers and hyphens only.";
-}
-function assertProjectName(value) {
-  const error = projectNameError(value);
-  if (error)
-    throw new Error(error);
-  return value.trim();
-}
-
-// src/scaffold.ts
-import { existsSync } from "fs";
-import { mkdir as mkdir2, readdir as readdir2 } from "fs/promises";
-import { join as join2, resolve } from "path";
-
-// src/utils.ts
-import {
-  cp,
-  mkdir,
-  readFile,
-  readdir,
-  rm,
-  stat,
-  writeFile
-} from "fs/promises";
-import { dirname, join } from "path";
-function replacePlaceholders(source, values) {
-  return source.replace(/\{\{([A-Z0-9_]+)\}\}/g, (placeholder, key) => values[key] ?? placeholder);
-}
-function mergePackageJson(base, overlay) {
-  const merged = { ...base };
-  for (const [key, value] of Object.entries(overlay)) {
-    const current = merged[key];
-    if (isRecord(current) && isRecord(value))
-      merged[key] = mergePackageJson(current, value);
-    else
-      merged[key] = value;
-  }
-  return merged;
-}
-async function copyTemplate(source, destination, placeholders) {
-  await cp(source, destination, { recursive: true, force: true });
-  await replacePlaceholdersAtPath(destination, placeholders);
-}
-async function replacePlaceholdersAtPath(path, values) {
-  if (!(await stat(path)).isDirectory()) {
-    const contents = await readFile(path, "utf8");
-    await writeFile(path, replacePlaceholders(contents, values));
-    return;
-  }
-  const entries = await readdir(path, { withFileTypes: true });
-  await Promise.all(entries.map((entry) => replacePlaceholdersAtPath(join(path, entry.name), values)));
-}
-async function writeJson(path, data) {
-  await mkdir(dirname(path), { recursive: true });
-  await writeFile(path, `${JSON.stringify(data, null, 2)}
-`);
-}
-async function readJson(path) {
-  return JSON.parse(await readFile(path, "utf8"));
-}
-function isRecord(value) {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-// src/scaffold.ts
-var packageRoot = resolve(import.meta.dirname, "..");
-async function scaffoldProject(options) {
-  const cwd = options.cwd ?? process.cwd();
-  const projectName = assertProjectName(options.projectName);
-  const projectPath = resolve(cwd, projectName);
-  if (existsSync(projectPath))
-    throw new Error(`Directory already exists: ${projectPath}`);
-  const placeholders = {
-    PROJECT_NAME: projectName,
-    HEYO_DOCS_VERSION: options.heyoDocsVersion ?? "0.1.0",
-    PACKAGE_MANAGER: packageManagerField(options.packageManager),
-    THEME: options.theme
-  };
-  const templatePath = join2(packageRoot, "templates", options.template);
-  const deploymentPath = join2(packageRoot, "deployments", options.deployment, options.template);
-  await mkdir2(projectPath, { recursive: true });
-  await copyTemplate(templatePath, projectPath, placeholders);
-  const basePackage = await readJson(join2(projectPath, "package.json"));
-  const overlayPackage = options.deployment === "later" ? {} : await readJson(join2(deploymentPath, "package.json"));
-  if (options.deployment !== "later") {
-    await copyOverlay(deploymentPath, projectPath, placeholders);
-  }
-  await writeJson(join2(projectPath, "package.json"), mergePackageJson(basePackage, overlayPackage));
-  if (options.install)
-    await installDependencies(projectPath, options.packageManager);
-  return { projectPath };
-}
-async function copyOverlay(source, destination, placeholders) {
-  const entries = await readdir2(source, { withFileTypes: true });
-  await Promise.all(entries.filter((entry) => entry.name !== "package.json").map(async (entry) => {
-    const sourcePath = join2(source, entry.name);
-    const destinationPath = join2(destination, entry.name);
-    return copyTemplate(sourcePath, destinationPath, placeholders);
-  }));
-}
-async function installDependencies(projectPath, packageManager) {
-  const command = packageManagerInstallCommand(packageManager);
-  const process2 = Bun.spawn(command, {
-    cwd: projectPath,
-    stdout: "inherit",
-    stderr: "inherit"
-  });
-  if (await process2.exited !== 0)
-    throw new Error(`Dependency installation failed with ${command.join(" ")}.`);
-}
-
-// src/index.ts
-var USAGE = "Usage: create-heyo-docs [project-name] [--template react-router|next|astro] [--deployment cloudflare|vercel|later] [--theme grain|shade|moss] [--package-manager bun|pnpm|npm|yarn] [--no-install]";
-var TEMPLATE_OPTIONS = [
-  { value: "react-router", label: "React Router" },
-  { value: "next", label: "Next.js" },
-  { value: "astro", label: "Astro" }
-];
-var DEPLOYMENT_OPTIONS = [
-  { value: "cloudflare", label: "Cloudflare" },
-  { value: "vercel", label: "Vercel" },
-  { value: "later", label: "Configure later" }
-];
-var THEME_OPTIONS = [
-  { value: "grain", label: "Grain" },
-  { value: "shade", label: "Shade" },
-  { value: "moss", label: "Moss" },
-  {
-    value: "dripper",
-    label: "Dripper \u2014 Soon",
-    hint: "Unavailable in this MVP"
-  },
-  {
-    value: "fixed-gear",
-    label: "Fixed Gear \u2014 Soon",
-    hint: "Unavailable in this MVP"
-  }
-];
-var PACKAGE_MANAGER_OPTIONS = [
-  { value: "bun", label: "bun" },
-  { value: "pnpm", label: "pnpm" },
-  { value: "npm", label: "npm" },
-  { value: "yarn", label: "yarn" }
-];
-if (import.meta.main) {
-  run(process.argv.slice(2)).catch((error) => {
-    p.log.error(error instanceof Error ? error.message : String(error));
-    process.exitCode = 1;
-  });
-}
-async function run(argv = process.argv.slice(2)) {
-  const parsed = parseArguments(argv);
-  if (parsed.showHelp) {
-    p.note(USAGE, "@heyo-sh/create-heyo-docs");
-    return;
-  }
-  const options = parsed.interactive ? await askQuestions(parsed.options) : parsed.options;
-  const spinner2 = p.spinner();
-  spinner2.start("Creating your Heyo Docs project");
-  try {
-    await scaffoldProject(options);
-  } catch (error) {
-    spinner2.stop("Unable to create your documentation project");
-    throw error;
-  }
-  spinner2.stop("Your documentation project is ready");
-  const install = options.install ? "" : `
-${options.packageManager} install`;
-  p.note(`cd ${options.projectName}${install}
-${packageManagerRunCommand(options.packageManager, "dev")}`, "Next steps");
-  p.outro("Happy documenting.");
-}
-function parseArguments(argv) {
-  const detected = detectPackageManager();
-  const options = {
-    projectName: "",
-    template: "react-router",
-    deployment: "later",
-    theme: "grain",
-    packageManager: detected.name,
-    install: true
-  };
-  let explicit = false;
-  let showHelp = false;
-  for (let index = 0;index < argv.length; index += 1) {
-    const value = argv[index];
-    if (!value.startsWith("-")) {
-      options.projectName ||= value;
-      continue;
-    }
-    explicit = true;
-    if (value === "--template") {
-      options.template = readEnum(argv[++index], ["react-router", "next", "astro"], "template");
-    } else if (value === "--deployment") {
-      options.deployment = readEnum(argv[++index], ["cloudflare", "vercel", "later"], "deployment");
-    } else if (value === "--theme") {
-      options.theme = readEnum(argv[++index], ["grain", "shade", "moss"], "theme");
-    } else if (value === "--package-manager") {
-      options.packageManager = readEnum(argv[++index], ["bun", "pnpm", "npm", "yarn"], "package manager");
-    } else if (value === "--no-install") {
-      options.install = false;
-    } else if (value === "--install") {
-      options.install = true;
-    } else if (value === "--help" || value === "-h") {
-      showHelp = true;
-    } else {
-      throw new Error(`Unknown option: ${value}`);
-    }
-  }
-  return { options, interactive: !explicit && !options.projectName, showHelp };
-}
-async function askQuestions(defaults) {
-  p.intro("Create Heyo Docs");
-  const projectName = await p.text({
-    message: "Project name",
-    placeholder: "my-docs",
-    defaultValue: "my-docs",
-    validate: projectNameError
-  });
-  if (p.isCancel(projectName))
-    cancelCreation();
-  const template = await selectAvailable("Template", TEMPLATE_OPTIONS, [
-    "react-router",
-    "next",
-    "astro"
-  ]);
-  const deployment = await selectAvailable("Deployment", DEPLOYMENT_OPTIONS, ["cloudflare", "vercel", "later"], defaults.deployment);
-  const theme = await selectAvailable("Theme", THEME_OPTIONS, [
-    "grain",
-    "shade",
-    "moss"
-  ]);
-  const packageManager = await selectAvailable("Package manager", PACKAGE_MANAGER_OPTIONS, ["bun", "pnpm", "npm", "yarn"], defaults.packageManager);
-  const install = await p.confirm({
-    message: "Install dependencies?",
-    initialValue: true
-  });
-  if (p.isCancel(install))
-    cancelCreation();
-  return {
-    projectName,
-    template,
-    deployment,
-    theme,
-    packageManager,
-    install
-  };
-}
-async function selectAvailable(message, options, available, initialValue) {
-  for (;; ) {
-    const answer = await p.select({ message, options, initialValue });
-    if (p.isCancel(answer))
-      cancelCreation();
-    if (isOneOf(answer, available))
-      return answer;
-    p.log.warn("That option is planned but not available in this MVP.");
-  }
-}
-function isOneOf(value, values) {
-  return values.some((candidate) => candidate === value);
-}
-function cancelCreation() {
-  p.cancel("Creation cancelled.");
-  process.exit(0);
-}
-function readEnum(value, allowed, label) {
-  if (value && isOneOf(value, allowed))
-    return value;
-  throw new Error(`Use one of ${allowed.join(", ")} for ${label}.`);
-}
-export {
-  scaffoldProject,
-  run,
-  replacePlaceholders,
-  parseArguments,
-  packageManagerRunCommand,
-  packageManagerField,
-  mergePackageJson,
-  detectPackageManager
-};

package/dist/package-manager.d.ts

@@ -1,6 +0,0 @@
-import type { DetectedPackageManager, PackageManager } from "./types";
-export declare function detectPackageManager(userAgent?: string): DetectedPackageManager;
-export declare function packageManagerField(manager: PackageManager, detected?: DetectedPackageManager): string;
-export declare function packageManagerInstallCommand(manager: PackageManager): string[];
-export declare function packageManagerRunCommand(manager: PackageManager, script: string): string;
-//# sourceMappingURL=package-manager.d.ts.map

package/dist/package-manager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"package-manager.d.ts","sourceRoot":"","sources":["../src/package-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAStE,wBAAgB,oBAAoB,CAClC,SAAS,SAA0C,GAClD,sBAAsB,CAIxB;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,cAAc,EACvB,QAAQ,yBAAyB,GAChC,MAAM,CAaR;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,cAAc,GACtB,MAAM,EAAE,CAEV;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GACb,MAAM,CAIR"}

package/dist/project-name.d.ts

@@ -1,3 +0,0 @@
-export declare function projectNameError(value: string): string | undefined;
-export declare function assertProjectName(value: string): string;
-//# sourceMappingURL=project-name.d.ts.map

package/dist/project-name.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"project-name.d.ts","sourceRoot":"","sources":["../src/project-name.ts"],"names":[],"mappings":"AAEA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIlE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIvD"}

package/dist/scaffold.d.ts

@@ -1,5 +0,0 @@
-import type { CreateOptions } from "./types";
-export declare function scaffoldProject(options: CreateOptions): Promise<{
-    projectPath: string;
-}>;
-//# sourceMappingURL=scaffold.d.ts.map

package/dist/scaffold.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,wBAAsB,eAAe,CACnC,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CA0ClC"}

package/dist/types.d.ts

@@ -1,19 +0,0 @@
-export type Template = "react-router" | "next" | "astro";
-export type Deployment = "cloudflare" | "vercel" | "later";
-export type Theme = "grain" | "shade" | "moss";
-export type PackageManager = "bun" | "pnpm" | "npm" | "yarn";
-export interface CreateOptions {
-    projectName: string;
-    template: Template;
-    deployment: Deployment;
-    theme: Theme;
-    packageManager: PackageManager;
-    install: boolean;
-    cwd?: string;
-    heyoDocsVersion?: string;
-}
-export interface DetectedPackageManager {
-    name: PackageManager;
-    version?: string;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC;AACzD,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC3D,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/utils.d.ts

@@ -1,8 +0,0 @@
-export declare function replacePlaceholders(source: string, values: Record<string, string>): string;
-export declare function mergePackageJson<T extends Record<string, unknown>>(base: T, overlay: Record<string, unknown>): T;
-export declare function copyTemplate(source: string, destination: string, placeholders: Record<string, string>): Promise<void>;
-export declare function replacePlaceholdersInDirectory(directory: string, values: Record<string, string>): Promise<void>;
-export declare function writeJson(path: string, data: unknown): Promise<void>;
-export declare function readJson<T>(path: string): Promise<T>;
-export declare function emptyDirectory(path: string): Promise<void>;
-//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAWA,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,MAAM,CAKR;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,CAAC,CASH;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACnC,OAAO,CAAC,IAAI,CAAC,CAGf;AAED,wBAAsB,8BAA8B,CAClD,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,OAAO,CAAC,IAAI,CAAC,CAOf;AAoBD,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;AAED,wBAAsB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAE1D;AAED,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhE"}