@riebeckite/honox 0.0.3 → 0.0.5

package/dist/src/scaffold/index.d.ts

@@ -1,3 +1,4 @@
+import { type ScaffoldPreset, type ScaffoldPresetName } from "./presets.js";
 export type ScaffoldSiteOptions = {
     readonly targetDirectory: string;
     readonly name?: string;
@@ -5,6 +6,7 @@ export type ScaffoldSiteOptions = {
     readonly description?: string;
     readonly baseUrl?: string;
     readonly locale?: string;
+    readonly preset?: ScaffoldPresetName | ScaffoldPreset;
     readonly overwrite?: boolean;
 };
 export type ScaffoldSiteResult = {

package/dist/src/scaffold/localized-content.d.ts

@@ -1,14 +1,13 @@
 import type { SiteTemplateFile, SiteTemplateVariables } from "./templates.js";
-export declare const SCAFFOLD_LANGUAGES: readonly ["en", "ja", "zh-CN", "es", "de", "fr", "ko"];
-export type ScaffoldLanguage = (typeof SCAFFOLD_LANGUAGES)[number];
-export declare function defaultLanguageForLocale(locale: string): string;
+import { type ScaffoldPreset } from "./presets.js";
 /**
- * Generates the localized content pages for the scaffold.
+ * Generates the content pages for a scaffold preset.
  *
- * Naming follows the l10n plugin convention: the default-language page keeps
- * the plain name (`index.md`) while every other language uses the
- * `<base>.<lang>.md` suffix. The l10n plugin derives the translation group
- * from the path, so `content/index.ja.md` and `content/index.md` share a
- * translation while being served under `/` and `/ja/`.
+ * Localized pages (`index`, `framework/plugins`, `framework/themes`) follow the
+ * l10n plugin convention: the default-language page keeps the plain name
+ * (`index.md`) while every other language uses the `<base>.<lang>.md` suffix.
+ * Presets without l10n emit the index in the site's default language only.
+ * Extra pages (`guide`, `examples`, `reference/*`) are English-only and are
+ * suffixed with `.en` when English is not the site's default language.
  */
-export declare function localizedContentFiles(variables: SiteTemplateVariables): readonly SiteTemplateFile[];
+export declare function localizedContentFiles(variables: SiteTemplateVariables, preset: ScaffoldPreset): readonly SiteTemplateFile[];

package/dist/src/scaffold/presets.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Scaffold presets.
+ *
+ * A preset is the declarative description of one starter template. The
+ * scaffolder consumes a preset to decide which files it generates:
+ *
+ * - which plugins are registered in `riebeckite.config.ts`
+ * - which theme is applied
+ * - which content pages are emitted (localized, or English-only extras)
+ * - which `app/` shell files are written
+ *
+ * Presets are cumulative in spirit but defined explicitly so each tier is
+ * self-contained and can be imported and reused on its own:
+ *
+ *    import { full, starter } from "@riebeckite/honox/scaffold";
+ */
+export declare const SCAFFOLD_LANGUAGES: readonly ["en", "ja", "zh-CN", "es", "de", "fr", "ko"];
+export type ScaffoldLanguage = (typeof SCAFFOLD_LANGUAGES)[number];
+export declare function defaultLanguageForLocale(locale: string): string;
+export type ScaffoldPresetName = "empty" | "minimal" | "starter" | "rich" | "full" | "max" | "ultra";
+export declare const SCAFFOLD_PRESET_NAMES: readonly ScaffoldPresetName[];
+export declare function isScaffoldPresetName(value: string): value is ScaffoldPresetName;
+/** How a theme factory is referenced in the generated config file. */
+export type ScaffoldThemeSpec = {
+    /** Npm package, for example `@riebeckite/theme-minimal`. */
+    readonly package: string;
+    /** Factory/import name, for example `minimalTheme`. */
+    readonly factory: string;
+    /** Optional literal source for the factory call arguments, e.g. `{ colorMode: "light" }`. */
+    readonly options?: string;
+};
+/** How a plugin factory is referenced in the generated config file. */
+export type ScaffoldPluginSpec = {
+    /** Npm package, for example `@riebeckite/plugin-seo`. */
+    readonly package: string;
+    /** Factory/import name, for example `seo`. */
+    readonly factory: string;
+    /** Optional literal source for the factory call arguments. */
+    readonly options?: string;
+};
+/** Content pages the scaffold can emit. */
+export type ScaffoldPageKey = "index" | "framework/plugins" | "framework/themes" | "guide" | "examples" | "reference/plugins" | "reference/themes";
+/** `app/` shell files the scaffold can emit. */
+export type ScaffoldAppFileKey = "server" | "client" | "config" | "content" | "paths" | "global" | "style" | "renderer" | "index" | "slug" | "header" | "article";
+/** README verbosity. */
+export type ScaffoldReadmeLevel = "short" | "standard" | "rich";
+export type ScaffoldPreset = {
+    readonly name: ScaffoldPresetName;
+    /** One-line human description, shown by `--list-presets`. */
+    readonly description: string;
+    /** Languages the l10n plugin is configured with. A single entry means no l10n. */
+    readonly languages: readonly ScaffoldLanguage[];
+    readonly theme: ScaffoldThemeSpec | null;
+    readonly plugins: readonly ScaffoldPluginSpec[];
+    readonly contentPages: readonly ScaffoldPageKey[];
+    /**
+     * Order-sensitive; the scaffolder writes `app/` files in this order.
+     * Structural files (`server`, `client`, `config`, `content`, `paths`,
+     * `global`, `style`, `renderer`) are always included.
+     */
+    readonly appFiles: readonly ScaffoldAppFileKey[];
+    readonly readme: ScaffoldReadmeLevel;
+};
+export declare const empty: ScaffoldPreset;
+export declare const minimal: ScaffoldPreset;
+export declare const starter: ScaffoldPreset;
+export declare const rich: ScaffoldPreset;
+export declare const full: ScaffoldPreset;
+export declare const max: ScaffoldPreset;
+export declare const ultra: ScaffoldPreset;
+export declare const scaffoldPresets: Readonly<Record<ScaffoldPresetName, ScaffoldPreset>>;
+export declare const SCAFFOLD_DEFAULT_PRESET: ScaffoldPresetName;
+export declare function resolveScaffoldPreset(value: ScaffoldPresetName | ScaffoldPreset | undefined): ScaffoldPreset;

package/dist/src/scaffold/presets.js

@@ -0,0 +1,374 @@
+// src/scaffold/presets.ts
+var SCAFFOLD_LANGUAGES = [
+  "en",
+  "ja",
+  "zh-CN",
+  "es",
+  "de",
+  "fr",
+  "ko"
+];
+function defaultLanguageForLocale(locale) {
+  const normalized = locale.toLowerCase();
+  if (normalized.startsWith("ja")) return "ja";
+  if (normalized.startsWith("zh")) return "zh-CN";
+  if (normalized.startsWith("es")) return "es";
+  if (normalized.startsWith("de")) return "de";
+  if (normalized.startsWith("fr")) return "fr";
+  if (normalized.startsWith("ko")) return "ko";
+  return "en";
+}
+var SCAFFOLD_PRESET_NAMES = [
+  "empty",
+  "minimal",
+  "starter",
+  "rich",
+  "full",
+  "max",
+  "ultra"
+];
+function isScaffoldPresetName(value) {
+  return SCAFFOLD_PRESET_NAMES.includes(value);
+}
+var np = (package_, factory, options) => ({
+  package: package_,
+  factory,
+  options
+});
+var obsidianMarkdown = np(
+  "@riebeckite/plugin-obsidian-markdown",
+  "obsidianMarkdown"
+);
+var colorMode = np("@riebeckite/plugin-color-mode", "colorModePlugin");
+var l10n = np("@riebeckite/plugin-l10n", "l10n");
+var seo = np("@riebeckite/plugin-seo", "seo");
+var toc = np("@riebeckite/plugin-toc", "tocPlugin");
+var properties = np("@riebeckite/plugin-properties", "properties");
+var alias = np("@riebeckite/plugin-alias", "aliasPlugin");
+var codeEnhance = np("@riebeckite/plugin-code-enhance", "codeEnhance");
+var search = np("@riebeckite/plugin-search", "searchPlugin");
+var backlinks = np("@riebeckite/plugin-backlinks", "backlinksPlugin");
+var relatedPosts = np("@riebeckite/plugin-related-posts", "relatedPosts");
+var recentPosts = np("@riebeckite/plugin-recent-posts", "recentPostsPlugin");
+var attachment = np("@riebeckite/plugin-attachment", "attachment");
+var media = np("@riebeckite/plugin-media", "media");
+var responsiveImage = np(
+  "@riebeckite/plugin-responsive-image",
+  "responsiveImage"
+);
+var lightbox = np("@riebeckite/plugin-lightbox", "lightboxPlugin");
+var highlight = np("@riebeckite/plugin-highlight", "highlight");
+var codeTabs = np("@riebeckite/plugin-code-tabs", "codeTabs");
+var codeAnnotations = np(
+  "@riebeckite/plugin-code-annotations",
+  "codeAnnotations"
+);
+var shortcodes = np("@riebeckite/plugin-shortcodes", "shortcodes");
+var series = np("@riebeckite/plugin-series", "series");
+var autoCardLink = np(
+  "@riebeckite/plugin-autocardlink",
+  "autoCardLinkPlugin"
+);
+var richEmbed = np("@riebeckite/plugin-rich-embed", "richEmbed");
+var mermaid = np("@riebeckite/plugin-mermaid", "mermaid");
+var graphviz = np("@riebeckite/plugin-graphviz", "graphviz");
+var d2 = np("@riebeckite/plugin-d2", "d2");
+var plantuml = np("@riebeckite/plugin-plantuml", "plantuml");
+var chartjs = np("@riebeckite/plugin-chartjs", "chartjs");
+var vegaLite = np("@riebeckite/plugin-vega-lite", "vegaLite");
+var wavedrom = np("@riebeckite/plugin-wavedrom", "wavedrom");
+var markmap = np("@riebeckite/plugin-markmap", "markmap");
+var marp = np("@riebeckite/plugin-marp", "marp");
+var qrCode = np("@riebeckite/plugin-qr-code", "qrCode");
+var discordEmbed = np("@riebeckite/plugin-discord-embed", "discordEmbed");
+var excalidraw = np("@riebeckite/plugin-excalidraw", "excalidraw");
+var excaliBrain = np("@riebeckite/plugin-excalibrain", "excaliBrain");
+var canvas = np("@riebeckite/plugin-canvas", "canvas");
+var bases = np("@riebeckite/plugin-bases", "bases");
+var dataview = np("@riebeckite/plugin-dataview", "dataviewPlugin");
+var flashcards = np("@riebeckite/plugin-flashcards", "flashcardsPlugin");
+var kanban = np("@riebeckite/plugin-kanban", "kanban");
+var query = np("@riebeckite/plugin-query", "queryPlugin");
+var localGraph = np("@riebeckite/plugin-local-graph", "localGraphPlugin");
+var hoverPreview = np(
+  "@riebeckite/plugin-hover-preview",
+  "hoverPreviewPlugin"
+);
+var gardenExplorer = np(
+  "@riebeckite/plugin-garden-explorer",
+  "gardenExplorerPlugin"
+);
+var ux = np("@riebeckite/plugin-ux", "uxPlugin");
+var dailyNotes = np("@riebeckite/plugin-daily-notes", "dailyNotesPlugin");
+var rename = np("@riebeckite/plugin-rename", "renamePlugin");
+var textFragment = np(
+  "@riebeckite/plugin-text-fragment",
+  "textFragmentPlugin"
+);
+var quality = np("@riebeckite/plugin-quality", "qualityPlugin");
+var deploy = np("@riebeckite/plugin-deploy", "deployPlugin");
+var diagnostics = np("@riebeckite/plugin-diagnostics", "diagnostics");
+var defaultTheme = {
+  package: "@riebeckite/theme-default",
+  factory: "defaultTheme"
+};
+var minimalTheme = {
+  package: "@riebeckite/theme-minimal",
+  factory: "minimalTheme"
+};
+var BASE_APP_FILES = [
+  "server",
+  "client",
+  "config",
+  "content",
+  "paths",
+  "global",
+  "style",
+  "renderer"
+];
+var empty = {
+  name: "empty",
+  description: "A blank application shell: no plugins, no theme, no content, no components.",
+  languages: [],
+  theme: null,
+  plugins: [],
+  contentPages: [],
+  appFiles: [...BASE_APP_FILES, "index"],
+  readme: "short"
+};
+var minimal = {
+  name: "minimal",
+  description: "The smallest useful site: Obsidian Markdown, the minimal theme, and one page.",
+  languages: ["en"],
+  theme: minimalTheme,
+  plugins: [obsidianMarkdown],
+  contentPages: ["index"],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "article"],
+  readme: "short"
+};
+var starter = {
+  name: "starter",
+  description: "The default starter: Obsidian Markdown, color mode, seven languages, and a site header.",
+  languages: [...SCAFFOLD_LANGUAGES],
+  theme: defaultTheme,
+  plugins: [obsidianMarkdown, colorMode, l10n],
+  contentPages: ["index"],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "header", "article"],
+  readme: "standard"
+};
+var rich = {
+  name: "rich",
+  description: "A showcasing starter: publishing and reading plugins plus guided ecosystem tour pages in seven languages.",
+  languages: [...SCAFFOLD_LANGUAGES],
+  theme: defaultTheme,
+  plugins: [
+    obsidianMarkdown,
+    colorMode,
+    l10n,
+    seo,
+    toc,
+    properties,
+    alias,
+    codeEnhance
+  ],
+  contentPages: ["index", "framework/plugins", "framework/themes"],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "header", "article"],
+  readme: "rich"
+};
+var full = {
+  name: "full",
+  description: "A ready blog: discovery, media, and reading plugins plus a build guide.",
+  languages: [...SCAFFOLD_LANGUAGES],
+  theme: defaultTheme,
+  plugins: [
+    obsidianMarkdown,
+    colorMode,
+    l10n,
+    seo,
+    toc,
+    properties,
+    alias,
+    codeEnhance,
+    search,
+    backlinks,
+    relatedPosts,
+    recentPosts,
+    attachment,
+    media,
+    responsiveImage,
+    lightbox,
+    highlight,
+    codeTabs,
+    codeAnnotations,
+    shortcodes,
+    series,
+    autoCardLink,
+    richEmbed
+  ],
+  contentPages: ["index", "framework/plugins", "framework/themes", "guide"],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "header", "article"],
+  readme: "rich"
+};
+var max = {
+  name: "max",
+  description: "Diagram and knowledge plugins on top of full, with showcase example pages.",
+  languages: [...SCAFFOLD_LANGUAGES],
+  theme: defaultTheme,
+  plugins: [
+    obsidianMarkdown,
+    colorMode,
+    l10n,
+    seo,
+    toc,
+    properties,
+    alias,
+    codeEnhance,
+    search,
+    backlinks,
+    relatedPosts,
+    recentPosts,
+    attachment,
+    media,
+    responsiveImage,
+    lightbox,
+    highlight,
+    codeTabs,
+    codeAnnotations,
+    shortcodes,
+    series,
+    autoCardLink,
+    richEmbed,
+    mermaid,
+    graphviz,
+    d2,
+    plantuml,
+    chartjs,
+    vegaLite,
+    wavedrom,
+    markmap,
+    marp,
+    qrCode,
+    discordEmbed,
+    excalidraw,
+    excaliBrain,
+    canvas,
+    bases,
+    dataview,
+    flashcards,
+    kanban,
+    query,
+    localGraph,
+    hoverPreview,
+    gardenExplorer,
+    ux
+  ],
+  contentPages: [
+    "index",
+    "framework/plugins",
+    "framework/themes",
+    "guide",
+    "examples"
+  ],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "header", "article"],
+  readme: "rich"
+};
+var ultra = {
+  name: "ultra",
+  description: "The full plugin catalog and theme reference pages — everything the ecosystem offers.",
+  languages: [...SCAFFOLD_LANGUAGES],
+  theme: defaultTheme,
+  plugins: [
+    obsidianMarkdown,
+    colorMode,
+    l10n,
+    seo,
+    toc,
+    properties,
+    alias,
+    codeEnhance,
+    search,
+    backlinks,
+    relatedPosts,
+    recentPosts,
+    attachment,
+    media,
+    responsiveImage,
+    lightbox,
+    highlight,
+    codeTabs,
+    codeAnnotations,
+    shortcodes,
+    series,
+    autoCardLink,
+    richEmbed,
+    mermaid,
+    graphviz,
+    d2,
+    plantuml,
+    chartjs,
+    vegaLite,
+    wavedrom,
+    markmap,
+    marp,
+    qrCode,
+    discordEmbed,
+    excalidraw,
+    excaliBrain,
+    canvas,
+    bases,
+    dataview,
+    flashcards,
+    kanban,
+    query,
+    localGraph,
+    hoverPreview,
+    gardenExplorer,
+    ux,
+    dailyNotes,
+    rename,
+    textFragment,
+    quality,
+    deploy,
+    diagnostics
+  ],
+  contentPages: [
+    "index",
+    "framework/plugins",
+    "framework/themes",
+    "guide",
+    "examples",
+    "reference/plugins",
+    "reference/themes"
+  ],
+  appFiles: [...BASE_APP_FILES, "index", "slug", "header", "article"],
+  readme: "rich"
+};
+var scaffoldPresets = { empty, minimal, starter, rich, full, max, ultra };
+var SCAFFOLD_DEFAULT_PRESET = "starter";
+function resolveScaffoldPreset(value) {
+  if (value === void 0) return scaffoldPresets[SCAFFOLD_DEFAULT_PRESET];
+  if (typeof value === "object") return value;
+  const preset = scaffoldPresets[value];
+  if (!preset) {
+    throw new Error(
+      `Unknown scaffold preset: ${value}. Available presets: ${SCAFFOLD_PRESET_NAMES.join(", ")}.`
+    );
+  }
+  return preset;
+}
+export {
+  SCAFFOLD_DEFAULT_PRESET,
+  SCAFFOLD_LANGUAGES,
+  SCAFFOLD_PRESET_NAMES,
+  defaultLanguageForLocale,
+  empty,
+  full,
+  isScaffoldPresetName,
+  max,
+  minimal,
+  resolveScaffoldPreset,
+  rich,
+  scaffoldPresets,
+  starter,
+  ultra
+};

package/dist/src/scaffold/templates.d.ts

@@ -1,3 +1,4 @@
+import { type ScaffoldPreset } from "./presets.js";
 export type SiteTemplateVariables = {
     readonly name: string;
     readonly title: string;
@@ -9,4 +10,4 @@ export type SiteTemplateFile = {
     readonly path: string;
     readonly content: string;
 };
-export declare function siteTemplateFiles(variables: SiteTemplateVariables): readonly SiteTemplateFile[];
+export declare function siteTemplateFiles(preset: ScaffoldPreset, variables: SiteTemplateVariables): readonly SiteTemplateFile[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/honox",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,6 +12,12 @@
       "source": "./index.ts",
       "default": "./dist/index.js"
     },
+    "./scaffold": {
+      "types": "./dist/src/scaffold/presets.d.ts",
+      "import": "./dist/src/scaffold/presets.js",
+      "source": "./src/scaffold/presets.ts",
+      "default": "./dist/src/scaffold/presets.js"
+    },
     "./server": {
       "types": "./dist/server.d.ts",
       "import": "./dist/server.js",
@@ -30,7 +36,7 @@
     "esbuild": "^0.28.2",
     "hono": "^4.12.25",
     "vite": "^8.0.9",
-    "@riebeckite/core": "0.0.3"
+    "@riebeckite/core": "0.0.5"
   },
   "publishConfig": {
     "access": "public"