vite-plugin-norg 0.1.0 → 1.0.0

package/README.md

@@ -1,26 +1,178 @@
 # vite-plugin-norg
 
-A Vite plugin that enables importing and processing `.norg` files (Neorg markup format) in your Vite projects with support for HTML, Svelte, and React output targets.
+[![npm version](https://img.shields.io/npm/v/vite-plugin-norg.svg)](https://www.npmjs.com/package/vite-plugin-norg)
+[![build status](https://img.shields.io/github/actions/workflow/status/bottd/vite-plugin-norg/ci.yml?branch=main)](https://github.com/bottd/vite-plugin-norg/actions)
+[![typescript](https://img.shields.io/badge/TypeScript-blue.svg)](https://www.typescriptlang.org/)
+[![license](https://img.shields.io/npm/l/vite-plugin-norg.svg)](LICENSE)
 
-- Built on top of the [rust-norg](https://github.com/nvim-neorg/rust-norg) parser
+**Neorg processor for Vite** - Transform `.norg` files into HTML, React, or Svelte with full TypeScript support.
+
+> **Built for [Neorg](https://github.com/nvim-neorg/neorg) users, powered by [rust-norg](https://github.com/nvim-neorg/rust-norg)**
 
 ## Installation
 
 ```bash
-npm install vite-plugin-norg
+npm install -D vite-plugin-norg
 ```
 
-## Usage
-
-### Basic Setup
+## Quick Setup
 
-Add the plugin to your `vite.config.js`:
+### HTML Output
 
-```js
+```javascript
 import { norgPlugin } from 'vite-plugin-norg';
 import { defineConfig } from 'vite';
 
 export default defineConfig({
-  plugins: [norgPlugin({ mode: 'html', include: ['/**/*.norg'] })],
+  plugins: [
+    norgPlugin({
+      mode: 'html',
+      include: ['**/*.norg'],
+    }),
+  ],
+});
+```
+
+```javascript
+import { metadata, html } from './document.norg';
+console.log(metadata.title); // "My Document"
+document.body.innerHTML = html;
+```
+
+### React Components
+
+```javascript
+export default defineConfig({
+  plugins: [
+    norgPlugin({
+      mode: 'react',
+      include: ['**/*.norg'],
+    }),
+  ],
+});
+```
+
+```jsx
+import { metadata, Component } from './document.norg';
+
+export default function App() {
+  return (
+    <div>
+      <h1>{metadata.title}</h1>
+      <Component />
+    </div>
+  );
+}
+```
+
+### Svelte Components
+
+```javascript
+export default defineConfig({
+  plugins: [
+    norgPlugin({
+      mode: 'svelte',
+      include: ['**/*.norg'],
+    }),
+  ],
 });
 ```
+
+```svelte
+<script>
+  import Document, { metadata } from './document.norg';
+</script>
+
+<h1>{metadata.title}</h1>
+<Document />
+```
+
+## Architecture
+
+```mermaid
+graph LR
+    A(📝 .norg files) ==> B(⚡ Rust Parser)
+    B ==> C(🔧 WASM Module)
+    C ==> D(🚀 Vite Plugin)
+    D ==> E{🎨 Generator}
+    E ==> F(📄 HTML)
+    E ==> G(⚛️ React)
+    E ==> H(🔥 Svelte)
+    F ==> I(💎 TypeScript Module)
+
+    linkStyle default stroke-width:3px
+```
+
+Built with:
+
+- **[rust-norg](https://github.com/nvim-neorg/rust-norg)** compiled to WASM for robust parsing
+- **[vite-plugin-wasm](https://github.com/Menci/vite-plugin-wasm)** to load Rust HTML transformer
+- **TypeScript** for the sanity of all involved
+- **Vite integration** with HMR support
+
+## Plugin API Reference
+
+```typescript
+import type { FilterPattern } from 'vite';
+
+interface NorgPluginOptions {
+  mode: 'html' | 'react' | 'svelte';
+  include?: FilterPattern;
+  exclude?: FilterPattern;
+}
+```
+
+**Requirements:**
+
+- Vite 7.0+
+- Node.js 20+
+
+## Development
+
+This project uses Nix flakes and direnv for reproducible development environments.
+
+### Setup
+
+```bash
+# Install direnv (if not already installed)
+curl -sfL https://direnv.net/install.sh | bash
+
+# Enable direnv for this project
+direnv allow
+
+# Build the project
+npm run build
+```
+
+### Development Workflow
+
+```bash
+npm run build
+
+# Run tests
+npm test
+
+# Lint code
+npm run lint
+
+# Format code
+nix fmt
+```
+
+### Nix Flake
+
+The `flake.nix` provides:
+
+- Rust toolchain with [wasm-pack](https://github.com/rustwasm/wasm-pack)
+- Node.js and npm
+- Development tools and dependencies
+
+To enter the development shell if not using direnv:
+
+```bash
+nix develop
+```
+
+## Contributing
+
+PRs and issues welcome! To open a PR please fork and ensure tests and linters pass.

package/dist/plugin/index.d.ts

@@ -1,5 +1,7 @@
 import { norgPlugin } from './plugin';
 import { NorgMetadata } from './wasm';
+import { SvelteComponent } from 'svelte';
+import { FC } from 'react';
 export { norgPlugin } from './plugin';
 export type { NorgMetadata, NorgParseResult, TocEntry } from './wasm';
 export default norgPlugin;
@@ -15,18 +17,12 @@ export interface HtmlModule {
  */
 export interface ReactModule {
     metadata: NorgMetadata;
-    Component: () => unknown;
+    Component: FC;
 }
 /**
  * Module type for .norg files processed by the Svelte generator
  */
 export interface SvelteModule {
     metadata: NorgMetadata;
-    default: new (options: {
-        target: unknown;
-        props?: Record<string, unknown>;
-    }) => {
-        $destroy(): void;
-        $set(props: Record<string, unknown>): void;
-    };
+    default: typeof SvelteComponent;
 }