Initial implementation of @quartz-community/runtime package

.eslintrc.json

@@ -1,26 +0,0 @@
-{
-  "root": true,
-  "env": {
-    "es2022": true,
-    "node": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "sourceType": "module",
-    "ecmaVersion": "latest",
-    "project": "./tsconfig.json"
-  },
-  "plugins": ["@typescript-eslint"],
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
-  "ignorePatterns": ["dist", "node_modules"],
-  "rules": {
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      {
-        "argsIgnorePattern": "^_",
-        "varsIgnorePattern": "^_",
-        "caughtErrorsIgnorePattern": "^_"
-      }
-    ]
-  }
-}

.github/workflows/ci.yml

@@ -1,55 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["main"]
-    tags: ["v*"]
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22"
-          cache: "npm"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run checks
-        run: npm run check
-
-      - name: Build
-        run: npm run build
-
-  publish:
-    if: startsWith(github.ref, 'refs/tags/v')
-    runs-on: ubuntu-latest
-    needs: [test]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22"
-          cache: "npm"
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build
-        run: npm run build
-
-      - name: Publish
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.prettierrc

@@ -1,7 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": false,
-  "printWidth": 100,
-  "trailingComma": "all",
-  "arrowParens": "always"
-}

CHANGELOG.md

@@ -1,12 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-### Added
-
-- Initial Quartz community plugin template.

package.json

@@ -1,43 +1,31 @@
 {
-  "name": "@quartz-community/plugin-template",
+  "name": "@quartz-community/runtime",
   "version": "0.1.0",
-  "description": "Template repository for Quartz community plugins.",
+  "description": "Browser runtime utilities for Quartz community plugins",
   "type": "module",
   "license": "MIT",
   "author": "Quartz Community",
   "homepage": "https://quartz.jzhao.xyz",
   "repository": {
     "type": "git",
-    "url": "https://github.com/quartz-community/plugin-template"
+    "url": "https://github.com/quartz-community/runtime"
   },
   "keywords": [
     "quartz",
     "quartz-plugin",
-    "plugin-template",
-    "remark",
-    "rehype",
-    "mdast",
-    "hast"
+    "runtime",
+    "browser"
   ],
   "files": [
     "dist",
     "README.md",
-    "LICENSE",
-    "CHANGELOG.md"
+    "LICENSE"
   ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./types": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/types.js"
-    },
-    "./components": {
-      "types": "./dist/components/index.d.ts",
-      "import": "./dist/components/index.js"
-    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
@@ -47,47 +35,11 @@
     "build": "tsup",
     "prepare": "npm run build",
     "dev": "tsup --watch",
-    "lint": "eslint . --max-warnings=0",
-    "format": "prettier . --check",
-    "test": "vitest run",
-    "typecheck": "tsc --noEmit",
-    "check": "npm run typecheck && npm run lint && npm run format && npm run test"
-  },
-  "peerDependencies": {
-    "@jackyzha0/quartz": "^4.5.2",
-    "preact": "^10.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@jackyzha0/quartz": {
-      "optional": true
-    },
-    "preact": {
-      "optional": false
-    }
-  },
-  "dependencies": {
-    "mdast-util-find-and-replace": "^3.0.1",
-    "rehype-slug": "^6.0.0",
-    "remark-gfm": "^4.0.1",
-    "remark-parse": "^11.0.0",
-    "remark-stringify": "^11.0.0",
-    "unified": "^11.0.5",
-    "unist-util-visit": "^5.0.0",
-    "vfile": "^6.0.3"
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@types/hast": "^3.0.4",
-    "@types/mdast": "^4.0.4",
-    "@types/node": "^24.10.0",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "preact": "^10.28.2",
-    "prettier": "^3.6.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.3",
-    "vitest": "^2.1.9"
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=22",

src/components/ExampleComponent.tsx

@@ -1,59 +0,0 @@
-import type { VNode, JSX } from "preact";
-
-export interface ExampleComponentOptions {
-  prefix?: string;
-  suffix?: string;
-  className?: string;
-}
-
-export type QuartzComponentProps = {
-  ctx: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  externalResources: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  fileData: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  cfg: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  children: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  tree: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  allFiles: any[]; // eslint-disable-line @typescript-eslint/no-explicit-any
-  displayClass?: "mobile-only" | "desktop-only";
-} & JSX.IntrinsicAttributes & {
-    [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
-  };
-
-export interface QuartzComponent {
-  (props: QuartzComponentProps): VNode;
-  css?: string;
-  beforeDOMLoaded?: string;
-  afterDOMLoaded?: string;
-}
-
-export const ExampleComponent = (opts?: ExampleComponentOptions) => {
-  const { prefix = "", suffix = "", className = "example-component" } = opts ?? {};
-
-  const Component: QuartzComponent = (props: QuartzComponentProps) => {
-    const title = props.fileData?.frontmatter?.title ?? "Untitled";
-    const fullText = `${prefix}${title}${suffix}`;
-
-    return <div class={className}>{fullText}</div>;
-  };
-
-  Component.css = `
-    .example-component {
-      padding: 8px 16px;
-      background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
-      color: white;
-      border-radius: 4px;
-      font-weight: 600;
-      display: inline-block;
-    }
-  `;
-
-  Component.afterDOMLoaded = `
-    document.addEventListener('nav', () => {
-      console.log('ExampleComponent: page navigation occurred');
-    });
-  `;
-
-  return Component;
-};
-
-export default ExampleComponent;

src/components/index.ts

@@ -1 +0,0 @@
-export { ExampleComponent, type ExampleComponentOptions } from "./ExampleComponent";

src/emitter.ts

@@ -1,88 +0,0 @@
-import path from "node:path";
-import fs from "node:fs/promises";
-import type { QuartzEmitterPlugin } from "@jackyzha0/quartz/plugins/types";
-import type { ProcessedContent } from "@jackyzha0/quartz/plugins/vfile";
-import type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-import type { FilePath, FullSlug } from "@jackyzha0/quartz/util/path";
-import type { ExampleEmitterOptions } from "./types";
-
-const defaultOptions: ExampleEmitterOptions = {
-  manifestSlug: "plugin-manifest",
-  includeFrontmatter: true,
-  metadata: {
-    generator: "Quartz Plugin Template",
-  },
-};
-
-const joinSegments = (...segments: string[]) =>
-  segments
-    .filter((segment) => segment.length > 0)
-    .join("/")
-    .replace(/\/+/g, "/") as FilePath;
-
-const writeFile = async (
-  outputDir: string,
-  slug: FullSlug,
-  ext: `.${string}` | "",
-  content: string,
-) => {
-  const outputPath = joinSegments(outputDir, `${slug}${ext}`) as FilePath;
-  await fs.mkdir(path.dirname(outputPath), { recursive: true });
-  await fs.writeFile(outputPath, content);
-  return outputPath;
-};
-
-/**
- * Example emitter that writes a JSON manifest of content metadata.
- */
-export const ExampleEmitter: QuartzEmitterPlugin<Partial<ExampleEmitterOptions>> = (
-  userOptions?: Partial<ExampleEmitterOptions>,
-) => {
-  const options = { ...defaultOptions, ...userOptions };
-  const emitManifest = async (ctx: BuildCtx, content: ProcessedContent[]) => {
-    const manifest = {
-      ...options.metadata,
-      generatedAt: new Date().toISOString(),
-      pages: content.map(([_tree, vfile]) => {
-        const frontmatter = (vfile.data?.frontmatter ?? {}) as {
-          title?: string;
-          tags?: string[];
-          [key: string]: unknown;
-        };
-        return {
-          slug: vfile.data?.slug ?? null,
-          title: frontmatter.title ?? null,
-          tags: frontmatter.tags ?? null,
-          filePath: vfile.data?.filePath ?? null,
-          frontmatter: options.includeFrontmatter ? frontmatter : undefined,
-        };
-      }),
-    };
-
-    let json = `${JSON.stringify(manifest, null, 2)}\n`;
-    if (options.transformManifest) {
-      json = options.transformManifest(json);
-    }
-
-    const output = await writeFile(
-      ctx.argv.output,
-      options.manifestSlug as FullSlug,
-      ".json",
-      json,
-    );
-    return [output];
-  };
-
-  return {
-    name: "ExampleEmitter",
-    async emit(ctx, content, _resources) {
-      return emitManifest(ctx, content);
-    },
-    async *partialEmit(ctx, content, _resources, _changeEvents) {
-      const outputPaths = await emitManifest(ctx, content);
-      for (const outputPath of outputPaths) {
-        yield outputPath;
-      }
-    },
-  };
-};

src/filter.ts

@@ -1,55 +0,0 @@
-import type { QuartzFilterPlugin } from "@jackyzha0/quartz/plugins/types";
-import type { ProcessedContent } from "@jackyzha0/quartz/plugins/vfile";
-import type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-import type { ExampleFilterOptions } from "./types";
-
-const defaultOptions: ExampleFilterOptions = {
-  allowDrafts: false,
-  excludeTags: ["private"],
-  excludePathPrefixes: ["_drafts/", "_private/"],
-};
-
-const normalizeTag = (tag: unknown) => (typeof tag === "string" ? tag.trim().toLowerCase() : "");
-
-const includesTag = (tags: unknown, excludedTags: string[]) => {
-  if (!Array.isArray(tags)) {
-    return false;
-  }
-
-  const normalizedExcluded = excludedTags.map((tag) => tag.toLowerCase());
-  return tags.some((tag) => normalizedExcluded.includes(normalizeTag(tag)));
-};
-
-/**
- * Example filter that removes drafts, tagged pages, and excluded path prefixes.
- */
-export const ExampleFilter: QuartzFilterPlugin<Partial<ExampleFilterOptions>> = (
-  userOptions?: Partial<ExampleFilterOptions>,
-) => {
-  const options = { ...defaultOptions, ...userOptions };
-  return {
-    name: "ExampleFilter",
-    shouldPublish(_ctx: BuildCtx, [_tree, vfile]: ProcessedContent) {
-      const frontmatter = (vfile.data?.frontmatter ?? {}) as {
-        draft?: boolean | string;
-        tags?: string[];
-      };
-      const isDraft = frontmatter.draft === true || frontmatter.draft === "true";
-      if (isDraft && !options.allowDrafts) {
-        return false;
-      }
-
-      if (includesTag(frontmatter.tags, options.excludeTags)) {
-        return false;
-      }
-
-      const filePath = typeof vfile.data?.filePath === "string" ? vfile.data.filePath : "";
-      const normalizedPath = filePath.replace(/\\/g, "/");
-      if (options.excludePathPrefixes.some((prefix) => normalizedPath.startsWith(prefix))) {
-        return false;
-      }
-
-      return true;
-    },
-  };
-};

src/index.ts

@@ -1,11 +1,209 @@
-export { ExampleTransformer } from "./transformer";
-export { ExampleFilter } from "./filter";
-export { ExampleEmitter } from "./emitter";
-export { ExampleComponent } from "./components/ExampleComponent";
+/**
+ * Browser runtime utilities for Quartz community plugins
+ * These utilities run in the browser to support community plugins
+ */
 
-export type {
-  ExampleTransformerOptions,
-  ExampleFilterOptions,
-  ExampleEmitterOptions,
-  ExampleComponentOptions,
-} from "./types";
+// ============================================================================
+// Script Loading
+// ============================================================================
+
+interface ScriptCache {
+  [url: string]: Promise<void> | void;
+}
+
+const scriptCache: ScriptCache = {};
+
+/**
+ * Loads a script from CDN once, caches the result
+ */
+export function loadScript(src: string): Promise<void> {
+  if (scriptCache[src]) {
+    return Promise.resolve(scriptCache[src]);
+  }
+
+  const promise = new Promise<void>((resolve, reject) => {
+    // Check if already loaded in DOM
+    if (document.querySelector(`script[src="${src}"]`)) {
+      resolve();
+      return;
+    }
+
+    const script = document.createElement("script");
+    script.src = src;
+    script.async = true;
+    script.onload = () => resolve();
+    script.onerror = () => reject(new Error(`Failed to load ${src}`));
+    document.head.appendChild(script);
+  });
+
+  scriptCache[src] = promise;
+  return promise;
+}
+
+/**
+ * Loads multiple scripts in parallel
+ */
+export function loadScripts(sources: string[]): Promise<void[]> {
+  return Promise.all(sources.map(loadScript));
+}
+
+// ============================================================================
+// Data Fetching
+// ============================================================================
+
+/**
+ * Fetches and parses contentIndex.json
+ */
+export async function fetchContentIndex(): Promise<Record<string, any>> {
+  const response = await fetch("/static/contentIndex.json");
+  const data = await response.json();
+  return data.content || data;
+}
+
+// ============================================================================
+// Event Handling
+// ============================================================================
+
+/**
+ * Register cleanup handlers for SPA navigation
+ */
+export function onNav(callback: (e: Event) => void): () => void {
+  document.addEventListener("nav", callback);
+
+  const cleanup = () => document.removeEventListener("nav", callback);
+
+  // Register with window.addCleanup if available (Quartz integration)
+  if (typeof window !== "undefined" && (window as any).addCleanup) {
+    (window as any).addCleanup(cleanup);
+  }
+
+  return cleanup;
+}
+
+/**
+ * Register pre-navigation handler
+ */
+export function onPreNav(callback: () => void): () => void {
+  document.addEventListener("prenav", callback);
+  return () => document.removeEventListener("prenav", callback);
+}
+
+// ============================================================================
+// DOM Utilities
+// ============================================================================
+
+/**
+ * Remove all children from a DOM element
+ */
+export function removeAllChildren(element: HTMLElement): void {
+  while (element.firstChild) {
+    element.removeChild(element.firstChild);
+  }
+}
+
+/**
+ * Debounce function calls
+ */
+export function debounce<T extends (...args: any[]) => any>(
+  fn: T,
+  delay: number,
+): (...args: Parameters<T>) => void {
+  let timeoutId: ReturnType<typeof setTimeout> | null = null;
+  return (...args: Parameters<T>) => {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    timeoutId = setTimeout(() => fn(...args), delay);
+  };
+}
+
+/**
+ * Escape HTML special characters
+ */
+export function escapeHtml(text: string): string {
+  const div = document.createElement("div");
+  div.textContent = text;
+  return div.innerHTML;
+}
+
+// ============================================================================
+// Navigation Utilities
+// ============================================================================
+
+/**
+ * Check if running in development mode
+ */
+export function isDevMode(): boolean {
+  return typeof window !== "undefined" && (window as any).DEV_MODE === true;
+}
+
+/**
+ * Get current page slug from URL
+ */
+export function getCurrentSlug(): string {
+  const path = window.location.pathname;
+  let slug = path;
+
+  // Remove trailing slash
+  if (slug.endsWith("/")) {
+    slug = slug.slice(0, -1);
+  }
+
+  // Remove leading slash
+  if (slug.startsWith("/")) {
+    slug = slug.slice(1);
+  }
+
+  return slug || "index";
+}
+
+/**
+ * Navigate to a slug
+ */
+export function navigateTo(slug: string): void {
+  window.location.href = "/" + slug;
+}
+
+// ============================================================================
+// Storage Utilities
+// ============================================================================
+
+const STORAGE_PREFIX = "quartz-";
+
+/**
+ * Save state to localStorage with prefix
+ */
+export function saveState(key: string, value: any): void {
+  try {
+    localStorage.setItem(`${STORAGE_PREFIX}${key}`, JSON.stringify(value));
+  } catch (e) {
+    console.warn("[Quartz] Failed to save state:", e);
+  }
+}
+
+/**
+ * Load state from localStorage
+ */
+export function loadState(key: string, defaultValue: any = null): any {
+  try {
+    const item = localStorage.getItem(`${STORAGE_PREFIX}${key}`);
+    return item ? JSON.parse(item) : defaultValue;
+  } catch (e) {
+    console.warn("[Quartz] Failed to load state:", e);
+    return defaultValue;
+  }
+}
+
+// ============================================================================
+// CDN URLs
+// ============================================================================
+
+/**
+ * Common CDN URLs for libraries used by Quartz plugins
+ */
+export const CDN_URLS = {
+  d3: "https://cdn.jsdelivr.net/npm/d3@7/dist/d3.min.js",
+  pixijs: "https://cdn.jsdelivr.net/npm/pixi.js@8/dist/pixi.min.js",
+  flexsearch:
+    "https://cdn.jsdelivr.net/npm/flexsearch@0.7.31/dist/flexsearch.bundle.min.js",
+} as const;

src/transformer.ts

@@ -1,104 +0,0 @@
-import type { PluggableList, Plugin } from "unified";
-import type { Root as MdastRoot } from "mdast";
-import type { Root as HastRoot, Element } from "hast";
-import type { VFile } from "vfile";
-import remarkGfm from "remark-gfm";
-import rehypeSlug from "rehype-slug";
-import { findAndReplace } from "mdast-util-find-and-replace";
-import { visit } from "unist-util-visit";
-import type { QuartzTransformerPlugin } from "@jackyzha0/quartz/plugins/types";
-import type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-import type { ExampleTransformerOptions } from "./types";
-
-const defaultOptions: ExampleTransformerOptions = {
-  highlightToken: "==",
-  headingClass: "example-plugin-heading",
-  enableGfm: true,
-  addHeadingSlugs: true,
-};
-
-const escapeRegExp = (value: string) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-
-const remarkHighlightToken = (token: string): Plugin<[], MdastRoot> => {
-  const escapedToken = escapeRegExp(token);
-  const pattern = new RegExp(`${escapedToken}([^\n]+?)${escapedToken}`, "g");
-  return () => (tree: MdastRoot, _file: VFile) => {
-    findAndReplace(tree, [
-      [
-        pattern,
-        (_match: string, value: string) => ({
-          type: "strong",
-          children: [{ type: "text", value }],
-        }),
-      ],
-    ]);
-  };
-};
-
-const rehypeHeadingClass = (className: string): Plugin<[], HastRoot> => {
-  return () => (tree: HastRoot, _file: VFile) => {
-    visit(tree, "element", (node: Element) => {
-      if (!/^h[1-6]$/.test(node.tagName)) {
-        return;
-      }
-
-      const existing = node.properties?.className;
-      const classes: string[] = Array.isArray(existing)
-        ? existing.filter((value): value is string => typeof value === "string")
-        : typeof existing === "string"
-          ? [existing]
-          : [];
-      node.properties = {
-        ...node.properties,
-        className: [...classes, className],
-      };
-    });
-  };
-};
-
-/**
- * Example transformer showing remark/rehype usage and resource injection.
- */
-export const ExampleTransformer: QuartzTransformerPlugin<Partial<ExampleTransformerOptions>> = (
-  userOptions?: Partial<ExampleTransformerOptions>,
-) => {
-  const options = { ...defaultOptions, ...userOptions };
-  return {
-    name: "ExampleTransformer",
-    textTransform(_ctx: BuildCtx, src: string) {
-      return src.endsWith("\n") ? src : `${src}\n`;
-    },
-    markdownPlugins(): PluggableList {
-      const plugins: PluggableList = [remarkHighlightToken(options.highlightToken)];
-      if (options.enableGfm) {
-        plugins.unshift(remarkGfm);
-      }
-      return plugins;
-    },
-    htmlPlugins(): PluggableList {
-      const plugins: PluggableList = [rehypeHeadingClass(options.headingClass)];
-      if (options.addHeadingSlugs) {
-        plugins.unshift(rehypeSlug);
-      }
-      return plugins;
-    },
-    externalResources() {
-      return {
-        css: [
-          {
-            content: `.${options.headingClass} { letter-spacing: 0.02em; }`,
-            inline: true,
-          },
-        ],
-        js: [
-          {
-            contentType: "inline",
-            loadTime: "afterDOMReady",
-            script: "document.documentElement.dataset.exampleTransformer = 'true'",
-          },
-        ],
-        additionalHead: [],
-      };
-    },
-  };
-};

src/types.ts

@@ -1,54 +0,0 @@
-export type {
-  ChangeEvent,
-  QuartzEmitterPlugin,
-  QuartzEmitterPluginInstance,
-  QuartzFilterPlugin,
-  QuartzFilterPluginInstance,
-  QuartzTransformerPlugin,
-  QuartzTransformerPluginInstance,
-} from "@jackyzha0/quartz/plugins/types";
-export type { ProcessedContent, QuartzPluginData } from "@jackyzha0/quartz/plugins/vfile";
-export type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-export type { CSSResource, JSResource, StaticResources } from "@jackyzha0/quartz/util/resources";
-
-export interface ExampleTransformerOptions {
-  /** Token used to highlight text, defaults to ==highlight== */
-  highlightToken: string;
-  /** Add a CSS class to all headings in the rendered HTML. */
-  headingClass: string;
-  /** Enable remark-gfm for tables/task lists. */
-  enableGfm: boolean;
-  /** Enable adding slug IDs to headings. */
-  addHeadingSlugs: boolean;
-}
-
-export interface ExampleFilterOptions {
-  /** Allow pages marked draft: true to publish. */
-  allowDrafts: boolean;
-  /** Exclude pages that contain any of these frontmatter tags. */
-  excludeTags: string[];
-  /** Exclude paths that start with any of these prefixes (relative to content root). */
-  excludePathPrefixes: string[];
-}
-
-export interface ExampleEmitterOptions {
-  /** Filename to emit at the site root. */
-  manifestSlug: string;
-  /** Whether to include the frontmatter block in the manifest. */
-  includeFrontmatter: boolean;
-  /** Extra metadata to write at the top level of the manifest. */
-  metadata: Record<string, unknown>;
-  /** Optional hook to transform the emitted manifest JSON string. */
-  transformManifest?: (json: string) => string;
-  /** Add a custom class to the emitted manifest <script> tag if used in HTML. */
-  manifestScriptClass?: string;
-}
-
-export interface ExampleComponentOptions {
-  /** Text to prefix before the title */
-  prefix?: string;
-  /** Text to suffix after the title */
-  suffix?: string;
-  /** CSS class name to apply */
-  className?: string;
-}

test/emitter.test.ts

@@ -1,45 +0,0 @@
-import { describe, expect, it } from "vitest";
-import path from "node:path";
-import fs from "node:fs/promises";
-import { tmpdir } from "node:os";
-import { ExampleEmitter } from "../src/emitter";
-import { createCtx, createProcessedContent } from "./helpers";
-
-describe("ExampleEmitter", () => {
-  it("writes a manifest to the output directory", async () => {
-    const outputDir = await fs.mkdtemp(path.join(tmpdir(), "quartz-plugin-"));
-    const ctx = createCtx({ argv: { output: outputDir } });
-    const emitter = ExampleEmitter({ manifestSlug: "manifest" });
-
-    const content = [
-      createProcessedContent({
-        slug: "hello-world",
-        filePath: "notes/hello-world.md",
-        frontmatter: { title: "Hello", tags: ["docs"] },
-      }),
-    ];
-
-    const result = await emitter.emit(ctx, content, {
-      css: [],
-      js: [],
-      additionalHead: [],
-    });
-    const outputPaths = Array.isArray(result) ? result : await collectAsync(result);
-    const outputPath = outputPaths[0];
-    if (!outputPath) {
-      throw new Error("Expected emitter to return an output path");
-    }
-    const manifest = JSON.parse(await fs.readFile(outputPath, "utf8"));
-
-    expect(outputPath).toContain("manifest.json");
-    expect(manifest.pages[0].slug).toBe("hello-world");
-  });
-});
-
-const collectAsync = async <T>(iterable: AsyncIterable<T>): Promise<T[]> => {
-  const results: T[] = [];
-  for await (const item of iterable) {
-    results.push(item);
-  }
-  return results;
-};

test/filter.test.ts

@@ -1,21 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { ExampleFilter } from "../src/filter";
-import { createCtx, createProcessedContent } from "./helpers";
-
-describe("ExampleFilter", () => {
-  it("filters drafts by default", () => {
-    const ctx = createCtx();
-    const filter = ExampleFilter();
-    const content = createProcessedContent({ frontmatter: { draft: true } });
-
-    expect(filter.shouldPublish(ctx, content)).toBe(false);
-  });
-
-  it("allows drafts when configured", () => {
-    const ctx = createCtx();
-    const filter = ExampleFilter({ allowDrafts: true });
-    const content = createProcessedContent({ frontmatter: { draft: true } });
-
-    expect(filter.shouldPublish(ctx, content)).toBe(true);
-  });
-});

test/helpers.ts

@@ -1,38 +0,0 @@
-import type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-import type { QuartzConfig } from "@jackyzha0/quartz/cfg";
-import type { ProcessedContent, QuartzPluginData } from "@jackyzha0/quartz/plugins/vfile";
-import { VFile } from "vfile";
-
-type BuildCtxOverrides = Omit<Partial<BuildCtx>, "argv"> & {
-  argv?: Partial<BuildCtx["argv"]>;
-};
-
-export const createCtx = (overrides: BuildCtxOverrides = {}): BuildCtx => {
-  const { argv: argvOverrides, ...rest } = overrides;
-  const argv: BuildCtx["argv"] = {
-    directory: "content",
-    verbose: false,
-    output: "dist",
-    serve: false,
-    watch: false,
-    port: 0,
-    wsPort: 0,
-    ...argvOverrides,
-  };
-
-  return {
-    buildId: "test-build",
-    argv,
-    cfg: {} as QuartzConfig,
-    allSlugs: [],
-    allFiles: [],
-    incremental: false,
-    ...rest,
-  };
-};
-
-export const createProcessedContent = (data: Partial<QuartzPluginData> = {}): ProcessedContent => {
-  const vfile = new VFile("");
-  vfile.data = data;
-  return [{ type: "root", children: [] }, vfile];
-};

test/transformer.test.ts

@@ -1,22 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { unified } from "unified";
-import remarkParse from "remark-parse";
-import remarkStringify from "remark-stringify";
-import { ExampleTransformer } from "../src/transformer";
-import { createCtx } from "./helpers";
-
-describe("ExampleTransformer", () => {
-  it("highlights text wrapped in the token", async () => {
-    const ctx = createCtx();
-    const transformer = ExampleTransformer({ highlightToken: "==" });
-    const plugins = transformer.markdownPlugins?.(ctx) ?? [];
-
-    const file = await unified()
-      .use(remarkParse)
-      .use(plugins)
-      .use(remarkStringify)
-      .process("Hello ==Quartz==");
-
-    expect(String(file)).toContain("**Quartz**");
-  });
-});

tsconfig.json

@@ -2,25 +2,18 @@
   "compilerOptions": {
     "target": "ES2022",
     "module": "ESNext",
-    "moduleResolution": "Bundler",
     "lib": ["ES2022", "DOM"],
-    "rootDir": ".",
-    "outDir": "dist",
+    "moduleResolution": "Bundler",
+    "rootDir": "./src",
+    "outDir": "./dist",
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,
     "noEmit": true,
     "strict": true,
-    "noImplicitOverride": true,
-    "noUncheckedIndexedAccess": true,
-    "noFallthroughCasesInSwitch": true,
     "skipLibCheck": true,
-    "resolveJsonModule": true,
-    "types": ["vitest/globals", "node"],
-    "verbatimModuleSyntax": true,
-    "jsx": "react-jsx",
-    "jsxImportSource": "preact"
+    "esModuleInterop": true
   },
-  "include": ["src", "test", "types", "tsup.config.ts", "vitest.config.ts"],
+  "include": ["src/**/*"],
   "exclude": ["dist", "node_modules"]
 }

tsup.config.ts

@@ -3,19 +3,11 @@ import { defineConfig } from "tsup";
 export default defineConfig({
   entry: {
     index: "src/index.ts",
-    types: "src/types.ts",
-    "components/index": "src/components/index.ts",
   },
   format: ["esm"],
   dts: true,
   sourcemap: true,
   clean: true,
-  treeshake: true,
   target: "es2022",
-  splitting: false,
   outDir: "dist",
-  esbuildOptions(options) {
-    options.jsx = "automatic";
-    options.jsxImportSource = "preact";
-  },
 });

types/quartz-compat.d.ts

@@ -1,150 +0,0 @@
-declare module "@jackyzha0/quartz/components/types" {
-  export type QuartzComponent = unknown;
-}
-
-declare module "@jackyzha0/quartz/util/path" {
-  export type FilePath = string & { _brand: "FilePath" };
-  export type FullSlug = string & { _brand: "FullSlug" };
-  export function joinSegments(...segments: string[]): FilePath;
-}
-
-declare module "@jackyzha0/quartz/util/resources" {
-  export type JSResource =
-    | {
-        loadTime: "beforeDOMReady" | "afterDOMReady";
-        moduleType?: "module";
-        spaPreserve?: boolean;
-        src: string;
-        contentType: "external";
-      }
-    | {
-        loadTime: "beforeDOMReady" | "afterDOMReady";
-        moduleType?: "module";
-        spaPreserve?: boolean;
-        script: string;
-        contentType: "inline";
-      };
-
-  export type CSSResource = {
-    content: string;
-    inline?: boolean;
-    spaPreserve?: boolean;
-  };
-
-  export interface StaticResources {
-    css: CSSResource[];
-    js: JSResource[];
-    additionalHead: unknown[];
-  }
-}
-
-declare module "@jackyzha0/quartz/util/ctx" {
-  import type { QuartzConfig } from "@jackyzha0/quartz/cfg";
-  import type { FilePath, FullSlug } from "@jackyzha0/quartz/util/path";
-
-  export interface Argv {
-    directory: string;
-    verbose: boolean;
-    output: string;
-    serve: boolean;
-    watch: boolean;
-    port: number;
-    wsPort: number;
-    remoteDevHost?: string;
-    concurrency?: number;
-  }
-
-  export interface BuildCtx {
-    buildId: string;
-    argv: Argv;
-    cfg: QuartzConfig;
-    allSlugs: FullSlug[];
-    allFiles: FilePath[];
-    incremental: boolean;
-  }
-}
-
-declare module "@jackyzha0/quartz/cfg" {
-  export interface QuartzConfig {
-    configuration: {
-      baseUrl?: string;
-    };
-  }
-}
-
-declare module "@jackyzha0/quartz/plugins/vfile" {
-  import type { Root as HtmlRoot } from "hast";
-  import type { Root as MdRoot } from "mdast";
-  import type { Data, VFile } from "vfile";
-
-  export type QuartzPluginData = Data;
-  export type MarkdownContent = [MdRoot, VFile];
-  export type ProcessedContent = [HtmlRoot, VFile];
-}
-
-declare module "@jackyzha0/quartz/plugins/types" {
-  import type { PluggableList } from "unified";
-  import type { StaticResources } from "@jackyzha0/quartz/util/resources";
-  import type { ProcessedContent } from "@jackyzha0/quartz/plugins/vfile";
-  import type { QuartzComponent } from "@jackyzha0/quartz/components/types";
-  import type { FilePath } from "@jackyzha0/quartz/util/path";
-  import type { BuildCtx } from "@jackyzha0/quartz/util/ctx";
-  import type { VFile } from "vfile";
-
-  export interface PluginTypes {
-    transformers: QuartzTransformerPluginInstance[];
-    filters: QuartzFilterPluginInstance[];
-    emitters: QuartzEmitterPluginInstance[];
-  }
-
-  type OptionType = object | undefined;
-  type ExternalResourcesFn = (ctx: BuildCtx) => Partial<StaticResources> | undefined;
-
-  export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (
-    opts?: Options,
-  ) => QuartzTransformerPluginInstance;
-
-  export type QuartzTransformerPluginInstance = {
-    name: string;
-    textTransform?: (ctx: BuildCtx, src: string) => string;
-    markdownPlugins?: (ctx: BuildCtx) => PluggableList;
-    htmlPlugins?: (ctx: BuildCtx) => PluggableList;
-    externalResources?: ExternalResourcesFn;
-  };
-
-  export type QuartzFilterPlugin<Options extends OptionType = undefined> = (
-    opts?: Options,
-  ) => QuartzFilterPluginInstance;
-
-  export type QuartzFilterPluginInstance = {
-    name: string;
-    shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean;
-  };
-
-  export type ChangeEvent = {
-    type: "add" | "change" | "delete";
-    path: FilePath;
-    file?: VFile;
-  };
-
-  export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
-    opts?: Options,
-  ) => QuartzEmitterPluginInstance;
-
-  export type QuartzEmitterPluginInstance = {
-    name: string;
-    emit: (
-      ctx: BuildCtx,
-      content: ProcessedContent[],
-      resources: StaticResources,
-    ) => Promise<FilePath[]> | AsyncGenerator<FilePath>;
-    partialEmit?: (
-      ctx: BuildCtx,
-      content: ProcessedContent[],
-      resources: StaticResources,
-      changeEvents: ChangeEvent[],
-    ) => Promise<FilePath[]> | AsyncGenerator<FilePath> | null;
-    getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[];
-    externalResources?: ExternalResourcesFn;
-  };
-}

vitest.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    environment: "node",
-    include: ["test/**/*.test.ts"],
-    reporters: ["default"],
-  },
-});