feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jamie-Fairweather wants to merge 2 commits into
base:main
Choose a base branch
from
Open

feat: add options for generated header and generation stats #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b991bd
feat: add options for generated header and generation stats
Jamie-Fairweather Apr 11, 2026
24ba837
style: file formatting
Jamie-Fairweather Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
includeRelationships = true
includePolicies = true
includeValidation = true
includeGeneratedHeader = true
includeGenerationStats = true
includeIndexes = true
generateSkill = true
generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down
1 change: 1 addition & 0 deletions src/extractors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
return {
fieldOrder:
options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
includeGeneratedHeader: options.includeGeneratedHeader !== false,
includeIndexes: options.includeIndexes !== false,
includePolicies: options.includePolicies !== false,
includeRelationships: options.includeRelationships !== false,
Expand Down
3 changes: 3 additions & 0 deletions src/generator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
const mdPath = path.join(outputDir, 'relationships.md');
const content = renderRelationshipsPage({
genCtx,
includeGeneratedHeader: options.includeGeneratedHeader,
relations: allRelations,
});
await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
generateErd: raw['generateErd'] === true,
generateSkill: raw['generateSkill'] === true,
includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
includeGenerationStats: raw['includeGenerationStats'] !== false,
includeIndexes: raw['includeIndexes'] !== false,
includeInternalModels: raw['includeInternalModels'] === true,
includePolicies: raw['includePolicies'] !== false,
Expand Down
9 changes: 8 additions & 1 deletion src/renderers/common.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
* Renders the auto-generated header banner with optional source file and generation date.
*/
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
context?: GenerationContext,
includeBanner = true,
): string[] {
if (!includeBanner) {
return [];
}

const metaParts: string[] = [];
if (context?.schemaFile) {
metaParts.push(`Source: ${context.schemaFile}`);
Expand Down
5 changes: 4 additions & 1 deletion src/renderers/enum-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
*/
function renderHeader(props: EnumPageProps): string[] {
return [
...generatedHeader(props.options.genCtx),
...generatedHeader(
props.options.genCtx,
props.options.includeGeneratedHeader,
),
breadcrumbs('Enums', props.enumDecl.name, '../'),
'',
`# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down
17 changes: 14 additions & 3 deletions src/renderers/index-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
hasErdMmd: boolean;
hasErdSvg: boolean;
hasRelationships: boolean;
includeGeneratedHeader: boolean;
includeGenerationStats: boolean;
models: DataModel[];
procedures: Procedure[];
title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
...renderProceduresSection(data),
...renderErdSection(data),
...renderSeeAlso(data),
...renderGenerationStats(data.genCtx),
...renderGenerationStats(data.genCtx, data.includeGenerationStats),
].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
* Renders a collapsible footer with generation stats (files, duration, source, date).
*/
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
genContext: GenerationContext | undefined,
includeStats: boolean,
): string[] {
if (!includeStats) {
return [];
}

if (genContext?.durationMs == null || genContext.filesGenerated == null) {
return [];
}
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
*/
function renderPageHeader(data: IndexData): string[] {
return [
...generatedHeader(data.genCtx),
...generatedHeader(data.genCtx, data.includeGeneratedHeader),
`# ${data.title}`,
'',
'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
hasErdMmd: props.hasErdMmd === true,
hasErdSvg: props.hasErdSvg === true,
hasRelationships,
includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
includeGenerationStats: pluginOptions.includeGenerationStats !== false,
models: allDataModels
.filter((m) => !m.isView)
.sort((a, b) => a.name.localeCompare(b.name)),
Expand Down
5 changes: 4 additions & 1 deletion src/renderers/model-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
}

return [
...generatedHeader(props.options.genCtx),
...generatedHeader(
props.options.genCtx,
props.options.includeGeneratedHeader,
),
breadcrumbs('Models', props.model.name, '../'),
'',
`# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down
5 changes: 4 additions & 1 deletion src/renderers/procedure-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
*/
function renderHeader(props: ProcedurePageProps): string[] {
return [
...generatedHeader(props.options.genCtx),
...generatedHeader(
props.options.genCtx,
props.options.includeGeneratedHeader,
),
breadcrumbs('Procedures', props.proc.name, '../'),
'',
`# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down
2 changes: 1 addition & 1 deletion src/renderers/relationships-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
*/
function renderHeader(props: RelationshipsPageProps): string[] {
return [
...generatedHeader(props.genCtx),
...generatedHeader(props.genCtx, props.includeGeneratedHeader),
'[Index](./index.md) / Relationships',
'',
'# Relationships',
Expand Down
5 changes: 4 additions & 1 deletion src/renderers/type-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
*/
function renderHeader(props: TypePageProps): string[] {
return [
...generatedHeader(props.options.genCtx),
...generatedHeader(
props.options.genCtx,
props.options.includeGeneratedHeader,
),
breadcrumbs('Types', props.typeDef.name, '../'),
'',
`# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down
5 changes: 4 additions & 1 deletion src/renderers/view-page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
: ' <kbd>View</kbd>';

return [
...generatedHeader(props.options.genCtx),
...generatedHeader(
props.options.genCtx,
props.options.includeGeneratedHeader,
),
breadcrumbs('Views', props.view.name, '../'),
'',
`# ${nameDisplay}${badges}`,
Expand Down
4 changes: 4 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
fieldOrder?: 'alphabetical' | 'declaration';
generateErd?: boolean;
generateSkill?: boolean;
includeGeneratedHeader?: boolean;
includeGenerationStats?: boolean;
includeIndexes?: boolean;
includeInternalModels?: boolean;
includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
genCtx?: GenerationContext;
includeGeneratedHeader: boolean;
relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
* Metadata about the current generation run (timestamps, file counts).
*/
genCtx?: GenerationContext;
includeGeneratedHeader: boolean;
includeIndexes: boolean;
includePolicies: boolean;
includeRelationships: boolean;
Expand Down
10 changes: 5 additions & 5 deletions test/generator/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down
25 changes: 25 additions & 0 deletions test/generator/common.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
expect(userDocument).not.toContain('[!CAUTION]');
});

it('omits the generated banner when includeGeneratedHeader is false', async () => {
const noBanner = await generateFromSchema(
`
model User {
id String @id @default(cuid())
posts Post[]
}
model Post {
id String @id @default(cuid())
author User @relation(fields: [authorId], references: [id])
authorId String
}
`,
{ includeGeneratedHeader: false },
);

const headerPattern = /DO NOT MODIFY THIS FILE/u;
expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
expect(readDoc(noBanner, 'index.md')).toMatch(
/^# Schema Documentation\n/u,
);
});

it('entity pages show breadcrumb navigation and type badges', () => {
const userDocument = readDoc(tmpDir, 'models', 'User.md');
expect(userDocument).toContain('[Index](../index.md)');
Expand Down
15 changes: 15 additions & 0 deletions test/generator/index-page.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
});
});

it('omits generation stats on index.md when includeGenerationStats is false', async () => {
const tmpDir = await generateFromSchema(
`
model User {
id String @id @default(cuid())
}
`,
{ includeGenerationStats: false },
);

const indexContent = readDocument(tmpDir, 'index.md');
expect(indexContent).not.toContain('Generation Stats');
expect(indexContent).not.toContain('**Duration**');
});

it('lists views in a separate section from models', async () => {
const tmpDir = await generateFromSchema(`
model User {
Expand Down
1 change: 1 addition & 0 deletions test/generator/snapshot.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
return content
.replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
.replaceAll(
/zenstack-schema-[\da-f-]+\.zmodel/gu,
'zenstack-schema-<UUID>.zmodel',
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: add options for generated header and generation stats#19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Jamie-Fairweather
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: add options for generated header and generation stats
#19
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7b991bd

feat: add options for generated header and generation stats


Jamie-Fairweather Apr 11, 2026
24ba837

style: file formatting


Jamie-Fairweather Apr 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,8 @@ plugin documentation {
 includeRelationships = true
 includePolicies = true
 includeValidation = true
 includeGeneratedHeader = true
 includeGenerationStats = true
 includeIndexes = true
 generateSkill = true
 generateErd = true
Expand All@@ -158,6 +160,8 @@ plugin documentation {
| `includeRelationships` | `boolean` | `true` | Generate relationship sections and `relationships.md` |
| `includePolicies` | `boolean` | `true` | Generate access policy tables |
| `includeValidation` | `boolean` | `true` | Generate validation rule tables |
| `includeGeneratedHeader` | `boolean` | `true` | Show the top-of-file “DO NOT MODIFY” banner (source path and generation date) on every generated page |
| `includeGenerationStats` | `boolean` | `true` | Append the collapsible **Generation Stats** block (files, duration, source, timestamp) to `index.md` |
| `includeIndexes` | `boolean` | `true` | Generate index/constraint tables |
| `generateSkill` | `boolean` | `false` | Generate a `SKILL.md` file for AI agent consumption |
| `generateErd` | `boolean` | `false` | Generate a complete ERD as `.mmd` and `.svg` files |
Expand Down

1 change: 1 addition & 0 deletions
src/extractors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,6 +316,7 @@ export function resolveRenderOptions(options: PluginOptions): RenderOptions {
 return {
 fieldOrder:
 options.fieldOrder === 'alphabetical' ? 'alphabetical' : 'declaration',
 includeGeneratedHeader: options.includeGeneratedHeader !== false,
 includeIndexes: options.includeIndexes !== false,
 includePolicies: options.includePolicies !== false,
 includeRelationships: options.includeRelationships !== false,
Expand Down

3 changes: 3 additions & 0 deletions
src/generator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export async function generate(context: CliGeneratorContext): Promise<void> {
 const mdPath = path.join(outputDir, 'relationships.md');
 const content = renderRelationshipsPage({
 genCtx,
 includeGeneratedHeader: options.includeGeneratedHeader,
 relations: allRelations,
 });
 await writePageWithDiagrams(mdPath, content, diagFmt, diagEmbed, diagTheme);
Expand DownExpand Up@@ -322,6 +323,8 @@ function resolvePluginOptions(raw: Record<string, unknown>): PluginOptions {
 raw['fieldOrder'] === 'alphabetical' ? 'alphabetical' : 'declaration',
 generateErd: raw['generateErd'] === true,
 generateSkill: raw['generateSkill'] === true,
 includeGeneratedHeader: raw['includeGeneratedHeader'] !== false,
 includeGenerationStats: raw['includeGenerationStats'] !== false,
 includeIndexes: raw['includeIndexes'] !== false,
 includeInternalModels: raw['includeInternalModels'] === true,
 includePolicies: raw['includePolicies'] !== false,
Expand Down

9 changes: 8 additions & 1 deletion
src/renderers/common.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,7 +81,14 @@ export function breadcrumbs(
/**
 * Renders the auto-generated header banner with optional source file and generation date.
 */
export function generatedHeader(context?: GenerationContext): string[] {
export function generatedHeader(
 context?: GenerationContext,
 includeBanner = true,
): string[] {
 if (!includeBanner) {
 return [];
 }

 const metaParts: string[] = [];
 if (context?.schemaFile) {
 metaParts.push(`Source: ${context.schemaFile}`);
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/enum-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,10 @@ function collectEnumUsage(enumDecl: Enum, allModels: DataModel[]): EnumUsage[] {
 */
function renderHeader(props: EnumPageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Enums', props.enumDecl.name, '../'),
 '',
 `# ${props.enumDecl.name} <kbd>Enum</kbd>`,
Expand Down

17 changes: 14 additions & 3 deletions
src/renderers/index-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ type IndexData = {
 hasErdMmd: boolean;
 hasErdSvg: boolean;
 hasRelationships: boolean;
 includeGeneratedHeader: boolean;
 includeGenerationStats: boolean;
 models: DataModel[];
 procedures: Procedure[];
 title: string;
Expand All@@ -51,7 +53,7 @@ export function renderIndexPage(props: IndexPageProps): string {
 ...renderProceduresSection(data),
 ...renderErdSection(data),
 ...renderSeeAlso(data),
 ...renderGenerationStats(data.genCtx),
 ...renderGenerationStats(data.genCtx, data.includeGenerationStats),
 ].join('\n');
}

Expand DownExpand Up@@ -132,7 +134,14 @@ function renderErdSection(data: IndexData): string[] {
/**
 * Renders a collapsible footer with generation stats (files, duration, source, date).
 */
function renderGenerationStats(genContext?: GenerationContext): string[] {
function renderGenerationStats(
 genContext: GenerationContext | undefined,
 includeStats: boolean,
): string[] {
 if (!includeStats) {
 return [];
 }

 if (genContext?.durationMs == null || genContext.filesGenerated == null) {
 return [];
 }
Expand DownExpand Up@@ -179,7 +188,7 @@ function renderModelsSection(data: IndexData): string[] {
 */
function renderPageHeader(data: IndexData): string[] {
 return [
 ...generatedHeader(data.genCtx),
 ...generatedHeader(data.genCtx, data.includeGeneratedHeader),
 `# ${data.title}`,
 '',
 'This documentation describes a [ZModel](https://zenstack.dev/docs/reference/zmodel/overview) schema' +
Expand DownExpand Up@@ -368,6 +377,8 @@ function resolveIndexData(props: IndexPageProps): IndexData {
 hasErdMmd: props.hasErdMmd === true,
 hasErdSvg: props.hasErdSvg === true,
 hasRelationships,
 includeGeneratedHeader: pluginOptions.includeGeneratedHeader !== false,
 includeGenerationStats: pluginOptions.includeGenerationStats !== false,
 models: allDataModels
 .filter((m) => !m.isView)
 .sort((a, b) => a.name.localeCompare(b.name)),
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/model-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,10 @@ function renderHeader(props: ModelPageProps): string[] {
 }

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Models', props.model.name, '../'),
 '',
 `# 🗃️ ${nameDisplay} ${badgeParts.join(' ')}`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/procedure-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,10 @@ function renderFlowDiagram(proc: Procedure): string[] {
 */
function renderHeader(props: ProcedurePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Procedures', props.proc.name, '../'),
 '',
 `# ${props.proc.name} <kbd>${props.proc.mutation ? 'Mutation' : 'Query'}</kbd>`,
Expand Down

2 changes: 1 addition & 1 deletion
src/renderers/relationships-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ function renderErDiagram(
 */
function renderHeader(props: RelationshipsPageProps): string[] {
 return [
 ...generatedHeader(props.genCtx),
 ...generatedHeader(props.genCtx, props.includeGeneratedHeader),
 '[Index](./index.md) / Relationships',
 '',
 '# Relationships',
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/type-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,10 @@ function renderClassDiagram(typeDef: TypeDef, usedBy: DataModel[]): string[] {
 */
function renderHeader(props: TypePageProps): string[] {
 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Types', props.typeDef.name, '../'),
 '',
 `# ${props.typeDef.name} <kbd>Type</kbd>`,
Expand Down

5 changes: 4 additions & 1 deletion
src/renderers/view-page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,10 @@ function renderHeader(props: ViewPageProps): string[] {
 : ' <kbd>View</kbd>';

 return [
 ...generatedHeader(props.options.genCtx),
 ...generatedHeader(
 props.options.genCtx,
 props.options.includeGeneratedHeader,
 ),
 breadcrumbs('Views', props.view.name, '../'),
 '',
 `# ${nameDisplay}${badges}`,
Expand Down

4 changes: 4 additions & 0 deletions
src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export type PluginOptions = {
 fieldOrder?: 'alphabetical' | 'declaration';
 generateErd?: boolean;
 generateSkill?: boolean;
 includeGeneratedHeader?: boolean;
 includeGenerationStats?: boolean;
 includeIndexes?: boolean;
 includeInternalModels?: boolean;
 includePolicies?: boolean;
Expand DownExpand Up@@ -114,6 +116,7 @@ export type Relationship = {

export type RelationshipsPageProps = {
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 relations: Relationship[];
};

Expand All@@ -137,6 +140,7 @@ export type RenderOptions = {
 * Metadata about the current generation run (timestamps, file counts).
 */
 genCtx?: GenerationContext;
 includeGeneratedHeader: boolean;
 includeIndexes: boolean;
 includePolicies: boolean;
 includeRelationships: boolean;
Expand Down

10 changes: 5 additions & 5 deletions
test/generator/__snapshots__/snapshot.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -73,7 +73,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -125,7 +125,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -218,7 +218,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand DownExpand Up@@ -349,7 +349,7 @@ exports[`documentation plugin: snapshot > snapshot: full representative schema o
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-03-08 //
// Source: schema.zmodel · Generated: <REDACTED> //
//////////////////////////////////////////////////////////////////////////////////////////////
\`\`\`

Expand Down

25 changes: 25 additions & 0 deletions
test/generator/common.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,31 @@ describe('documentation plugin: common features', () => {
 expect(userDocument).not.toContain('[!CAUTION]');
 });

 it('omits the generated banner when includeGeneratedHeader is false', async () => {
 const noBanner = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 posts Post[]
 }
 model Post {
 id String @id @default(cuid())
 author User @relation(fields: [authorId], references: [id])
 authorId String
 }
 `,
 { includeGeneratedHeader: false },
 );

 const headerPattern = /DO NOT MODIFY THIS FILE/u;
 expect(readDoc(noBanner, 'index.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'models', 'User.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'relationships.md')).not.toMatch(headerPattern);
 expect(readDoc(noBanner, 'index.md')).toMatch(
 /^# Schema Documentation\n/u,
 );
 });

 it('entity pages show breadcrumb navigation and type badges', () => {
 const userDocument = readDoc(tmpDir, 'models', 'User.md');
 expect(userDocument).toContain('[Index](../index.md)');
Expand Down

15 changes: 15 additions & 0 deletions
test/generator/index-page.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,21 @@ describe('documentation plugin: index page', () => {
 });
 });

 it('omits generation stats on index.md when includeGenerationStats is false', async () => {
 const tmpDir = await generateFromSchema(
 `
 model User {
 id String @id @default(cuid())
 }
 `,
 { includeGenerationStats: false },
 );

 const indexContent = readDocument(tmpDir, 'index.md');
 expect(indexContent).not.toContain('Generation Stats');
 expect(indexContent).not.toContain('**Duration**');
 });

 it('lists views in a separate section from models', async () => {
 const tmpDir = await generateFromSchema(`
 model User {
Expand Down

1 change: 1 addition & 0 deletions
test/generator/snapshot.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { describe, expect, it } from 'vitest';

function stabilize(content: string): string {
 return content
 .replaceAll(/(· Generated: )\d{4}-\d{2}-\d{2}/gu, '$1<REDACTED>')
 .replaceAll(
 /zenstack-schema-[\da-f-]+\.zmodel/gu,
 'zenstack-schema-<UUID>.zmodel',
Expand Down