Skip to content

Commit 5f9f5a4

Browse files
committed
feat: initial release of zenstack-docs-plugin
ZenStack v3 plugin that generates rich, browsable Markdown documentation from ZModel schemas. Includes per-entity pages with fields, relationships, access policies, validation rules, Mermaid ER diagrams, cross-links, and optional AI agent skill file (SKILL.md) generation. Key capabilities: - Full-schema ERD with SVG export via beautiful-mermaid - Correct cardinality detection (1:1, 1:1?, 1:M, M:1, M:1?, M:M) - Per-page SVG diagrams (diagramFormat: svg | both | mermaid) - Multi-file schema support with source file tracking - 149 tests (unit + integration) - eslint-config-canonical for strict code conventions - CI/CD via GitHub Actions with pnpm
0 parents  commit 5f9f5a4

188 files changed

Lines changed: 32752 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [20, 22]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Install pnpm
20+
uses: pnpm/action-setup@v4
21+
22+
- name: Use Node.js ${{ matrix.node-version }}
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: ${{ matrix.node-version }}
26+
cache: pnpm
27+
28+
- name: Install dependencies
29+
run: pnpm install --frozen-lockfile
30+
31+
- name: Type check
32+
run: pnpm run typecheck
33+
34+
- name: Lint
35+
run: pnpm run lint
36+
37+
- name: Build
38+
run: pnpm run build
39+
40+
- name: Test
41+
run: pnpm test

.github/workflows/publish.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish to npm
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
id-token: write
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Install pnpm
18+
uses: pnpm/action-setup@v4
19+
20+
- name: Use Node.js 22
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 22
24+
registry-url: https://registry.npmjs.org
25+
cache: pnpm
26+
27+
- name: Install dependencies
28+
run: pnpm install --frozen-lockfile
29+
30+
- name: Build
31+
run: pnpm run build
32+
33+
- name: Test
34+
run: pnpm test
35+
36+
- name: Publish
37+
run: pnpm publish --provenance --access public --no-git-checks
38+
env:
39+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
dist/
3+
*.tsbuildinfo
4+
package-lock.json
5+
.env
6+
*.local

0 commit comments

Comments
 (0)