@axerity/cli 0.1.2 → 0.1.4

package/bin/axerity.js

@@ -10,6 +10,7 @@ import {
 	readdirSync,
 	rmSync,
 	symlinkSync,
+	watch,
 	writeFileSync
 } from 'node:fs';
 import { basename, dirname, join, relative, resolve } from 'node:path';
@@ -67,6 +68,11 @@ function mountSpecs(config) {
 	return { ...config, openapi };
 }
 
+function writeConfig() {
+	const config = JSON.parse(readFileSync(join(userRoot, 'axerity.json'), 'utf8'));
+	writeFileSync(ENGINE_CONFIG, JSON.stringify(mountSpecs(config), null, '\t'));
+}
+
 function mount(contentDir) {
 	rmSync(ENGINE_DOCS, { recursive: true, force: true });
 	mkdirSync(ENGINE_DOCS, { recursive: true });
@@ -74,8 +80,7 @@ function mount(contentDir) {
 		symlinkSync(join(contentDir, entry), join(ENGINE_DOCS, entry), symlinkType);
 	}
 
-	const config = JSON.parse(readFileSync(join(userRoot, 'axerity.json'), 'utf8'));
-	writeFileSync(ENGINE_CONFIG, JSON.stringify(mountSpecs(config), null, '\t'));
+	writeConfig();
 
 	rmSync(ASSETS_DIR, { recursive: true, force: true });
 	cpSync(ENGINE_STATIC, ASSETS_DIR, { recursive: true });
@@ -102,7 +107,9 @@ const strip = (s) => s.replace(/\x1b\[[0-9;]*m/g, '');
 const banner = (sub) => process.stdout.write(`\n  ${mark} ${bold('axerity')} ${dim(sub)}\n\n`);
 
 const NOISE =
-	/^\s*(VITE v|➜|press h|ready in|Local:|Network:|\[vite\].*(optimiz|dependencies)|\[optimizer\]|Forced re-opt|watching for file changes|use --host)/i;
+	/^\s*(VITE v|➜|press h|ready in|Local:|Network:|use --host|watching for file changes)/i;
+const VITE_CHATTER =
+	/\[optimizer\]|\[vite\].*(re-?optimiz|optimized dependencies|new dependencies|page reload|hmr update|dependencies because)/i;
 
 function streamServer(child) {
 	let shown = false;
@@ -120,7 +127,7 @@ function streamServer(child) {
 				process.stdout.write(`  ${dim('Ctrl+C to stop')}\n\n`);
 				continue;
 			}
-			if (!clean.trim() || NOISE.test(clean.trim())) continue;
+			if (!clean.trim() || NOISE.test(clean.trim()) || VITE_CHATTER.test(clean)) continue;
 			process.stdout.write(`  ${line}\n`);
 		}
 	};
@@ -163,10 +170,27 @@ function runEngine(sub, extra, { mounted, onSuccess }) {
 	banner(sub);
 	const build = sub === 'build' ? streamBuild(child) : (streamServer(child), null);
 
+	let configWatcher = null;
+	if (mounted && sub === 'dev') {
+		let timer = null;
+		configWatcher = watch(userRoot, (_event, filename) => {
+			if (filename !== 'axerity.json') return;
+			clearTimeout(timer);
+			timer = setTimeout(() => {
+				try {
+					writeConfig();
+				} catch {
+					return;
+				}
+			}, 80);
+		});
+	}
+
 	let cleaned = false;
 	const cleanup = () => {
 		if (cleaned || !mounted) return;
 		cleaned = true;
+		configWatcher?.close();
 		tidy();
 	};
 
@@ -233,7 +257,7 @@ function init() {
 	const files = {
 		'axerity.json': `${JSON.stringify(
 			{
-				$schema: 'https://axerity.com/axerity.schema.json',
+				$schema: 'https://unpkg.com/@axerity/cli/axerity.schema.json',
 				name: 'My Docs',
 				description: 'Documentation built with Axerity.',
 				theme: 'neutral',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axerity/cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A documentation site generator built with Svelte.",
   "type": "module",
   "license": "MIT",
@@ -59,6 +59,7 @@
     "@tailwindcss/forms": "^0.5.11",
     "@tailwindcss/typography": "^0.5.19",
     "@tailwindcss/vite": "^4.3.0",
+    "lucide": "^1.17.0",
     "mdsvex": "^0.12.7",
     "mermaid": "^11.15.0",
     "rehype-slug": "^6.0.0",

package/src/content/demo/configuration/cli.md

@@ -18,8 +18,8 @@ axerity build        # build the static site
 axerity preview      # preview the production build
 ```
 
-Run them with `npx axerity <command>`, or install globally with
-`npm install -g axerity` and call `axerity` directly.
+Run them with `pnpm dlx @axerity/cli <command>` (or `npx @axerity/cli <command>`),
+or add `@axerity/cli` as a dev dependency and call `axerity` through your scripts.
 
 ## init
 
@@ -35,12 +35,14 @@ example `axerity dev --port 4000`.
 
 ## build
 
-`axerity build` produces a static site. Every page is prerendered to HTML, and
-the search index, `llms.txt`, sitemap, RSS feed, and OpenGraph images are all
-written out, ready to host anywhere.
+`axerity build` produces a static site in `build/`. Every page is prerendered to
+HTML, and the search index, `llms.txt`, sitemap, RSS feed, and OpenGraph images
+are all written out, ready to host anywhere.
 
 ## How it works
 
-The CLI never touches your content. It assembles a hidden `.axerity` workspace
-that pairs the packaged engine with your `docs/` folder and `axerity.json`, then
-runs Vite there. Add `.axerity` to your `.gitignore`; `init` does this for you.
+The engine runs from its own install, not from your repo. When you run a command,
+Axerity reads your `docs/` and `axerity.json` and renders against them, then
+writes the result to `build/` in your project. Your content is the source of
+truth and nothing else in your folder is touched, so there is no workspace to
+gitignore beyond `build/`.

package/src/content/demo/configuration/deployment.md

@@ -40,7 +40,7 @@ Settings and set the Framework Preset to **Other**.
 
 In the Pages project settings:
 
-- **Build command:** `npx axerity build`
+- **Build command:** `npx @axerity/cli build`
 - **Build output directory:** `build`
 - **Framework preset:** None
 
@@ -50,7 +50,7 @@ Cloudflare serves clean URLs automatically.
 
 ```toml title="netlify.toml"
 [build]
-  command = "npx axerity build"
+  command = "npx @axerity/cli build"
   publish = "build"
 ```
 
@@ -59,7 +59,7 @@ Netlify serves clean URLs (pretty URLs) by default.
 ## GitHub Pages
 
 Build, then publish the `build/` folder (for example with a GitHub Action that
-runs `npx axerity build` and uploads `build/` as the Pages artifact).
+runs `npx @axerity/cli build` and uploads `build/` as the Pages artifact).
 
 Project sites are served from `https://<user>.github.io/<repo>/`, a sub-path, so
 set the base in `axerity.json`:

package/src/content/demo/installation.md

@@ -6,35 +6,52 @@ icon: download
 
 # Installation
 
-Axerity is a CLI. You do not clone or fork anything. Install it, scaffold a site,
-and start writing Markdown.
+Axerity is a CLI. You do not clone or fork anything. Run it, scaffold a site, and
+start writing Markdown.
 
 ## Requirements
 
-- Node.js 20 or newer
+- Node.js 24 or newer
 
 ## Create a site
 
 Scaffold a new site with `init`, then start the dev server:
 
 ```bash
-npx axerity init my-docs
+pnpm dlx @axerity/cli init my-docs
 cd my-docs
-npx axerity dev
+pnpm dlx @axerity/cli dev
 ```
 
-Your site is running at `http://localhost:5173`. Or install it globally and drop
-the `npx`:
+Your site is running at `http://localhost:5173`. `pnpm dlx` runs the CLI without
+installing it. `npx @axerity/cli <command>` works the same way.
+
+## Install it
+
+For a project you build often, add it as a dev dependency so the version is
+pinned:
 
 ```bash
-npm install -g axerity
-axerity init my-docs
+pnpm add -D @axerity/cli
+```
+
+Then wire up scripts in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "dev": "axerity dev",
+    "build": "axerity build",
+    "preview": "axerity preview"
+  }
+}
 ```
 
+Now `pnpm dev` and `pnpm build` just work, no global install or PATH setup.
+
 ## Project layout
 
-A site is just your content and one config file. Everything else lives in the
-package:
+A site is your content and one config file:
 
 ```
 my-docs/
@@ -44,6 +61,6 @@ my-docs/
 ```
 
 Write Markdown in `docs/`, order pages with `meta.json`, and configure the site
-in [`axerity.json`](/configuration). The CLI builds a hidden `.axerity`
-workspace to run the engine against your content, so add `.axerity` to your
-`.gitignore` (the scaffold does this for you).
+in [`axerity.json`](/configuration). The engine runs from its own install, so the
+only thing Axerity ever creates in your project is the `build/` folder. The
+scaffold adds it to your `.gitignore` for you.

package/src/lib/components/DynamicIcon.svelte

@@ -1,8 +1,8 @@
 <script lang="ts" module>
-	import type { Component } from 'svelte';
-	import * as icons from '@lucide/svelte';
+	import { icons } from 'lucide';
 
-	const registry = icons as unknown as Record<string, Component>;
+	type IconNode = [string, Record<string, string | number>][];
+	const registry = icons as unknown as Record<string, IconNode>;
 
 	const pascal = (name: string) =>
 		name
@@ -18,9 +18,24 @@
 		class: className = ''
 	}: { name?: string; size?: number; class?: string } = $props();
 
-	const Icon = $derived(name ? registry[pascal(name)] : undefined);
+	const node = $derived(name ? registry[pascal(name)] : undefined);
 </script>
 
-{#if Icon}
-	<Icon {size} class={className} />
+{#if node}
+	<svg
+		xmlns="http://www.w3.org/2000/svg"
+		width={size}
+		height={size}
+		viewBox="0 0 24 24"
+		fill="none"
+		stroke="currentColor"
+		stroke-width="2"
+		stroke-linecap="round"
+		stroke-linejoin="round"
+		class={`lucide ${className}`}
+	>
+		{#each node as [tag, attrs], i (i)}
+			<svelte:element this={tag} {...attrs} />
+		{/each}
+	</svg>
 {/if}

package/vite.config.ts

@@ -1,11 +1,11 @@
-import { readFileSync } from 'node:fs';
+import { existsSync, readFileSync, watch } from 'node:fs';
 import { resolve } from 'node:path';
 import tailwindcss from '@tailwindcss/vite';
 import { sveltekit } from '@sveltejs/kit/vite';
 import { defineConfig } from 'vite';
 import { generateApiDocs } from './src/lib/openapi/generate';
 
-const allow = process.env.AXERITY_FS_ALLOW;
+const mounted = !!process.env.AXERITY_FS_ALLOW;
 
 function openapi() {
 	const localSpecs: string[] = [];
@@ -40,7 +40,28 @@ function openapi() {
 	};
 }
 
+function configReload() {
+	const file = resolve('axerity.json');
+	let watcher: ReturnType<typeof watch> | null = null;
+	return {
+		name: 'axerity:config-reload',
+		configureServer(server: import('vite').ViteDevServer) {
+			if (!existsSync(file)) return;
+			let timer: ReturnType<typeof setTimeout> | null = null;
+			watcher = watch(file, () => {
+				if (timer) clearTimeout(timer);
+				timer = setTimeout(() => server.watcher.emit('change', file), 50);
+			});
+		},
+		closeBundle() {
+			watcher?.close();
+			watcher = null;
+		}
+	};
+}
+
 export default defineConfig({
-	plugins: [openapi(), tailwindcss(), sveltekit()],
-	server: allow ? { fs: { strict: false } } : undefined
+	plugins: [openapi(), ...(mounted ? [configReload()] : []), tailwindcss(), sveltekit()],
+	server: mounted ? { fs: { strict: false } } : undefined,
+	optimizeDeps: mounted ? { noDiscovery: true, include: ['@orama/orama', 'mermaid'] } : undefined
 });