Skip to content

fix: use HTML comments for @generated markers in markdown, rename "Generated SDK" #746

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

Merged
pyramation merged 2 commits into from
Feb 26, 2026
Merged

fix: use HTML comments for @generated markers in markdown, rename "Generated SDK" #746

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
6c48e89
fix: use HTML comments for @generated markers in markdown, rename 'Ge…
pyramation Feb 26, 2026
e0bbbeb
chore: update generated sdk/ files with new markdown comments and naming
pyramation Feb 26, 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
62 changes: 31 additions & 31 deletions graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
exports[`cli docs generator generates CLI AGENTS.md 1`] = `
"# myapp CLI - Agent Reference

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->
> This document is structured for LLM/agent consumption.

## OVERVIEW
Expand Down Expand Up @@ -218,7 +218,7 @@ exports[`cli docs generator generates CLI README 1`] = `
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## Setup

Expand Down Expand Up @@ -364,7 +364,7 @@ No developer or entity involved in creating this software will be liable for any
exports[`cli docs generator generates CLI skill files 1`] = `
"# myapp-context

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Manage API endpoint contexts for myapp

Expand Down Expand Up @@ -398,7 +398,7 @@ myapp context list
exports[`cli docs generator generates CLI skill files 2`] = `
"# myapp-auth

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Manage authentication tokens for myapp

Expand Down Expand Up @@ -429,7 +429,7 @@ myapp auth status
exports[`cli docs generator generates CLI skill files 3`] = `
"# myapp-car

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

CRUD operations for Car records via myapp CLI

Expand Down Expand Up @@ -480,7 +480,7 @@ myapp car delete --id <value>
exports[`cli docs generator generates CLI skill files 4`] = `
"# myapp-driver

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

CRUD operations for Driver records via myapp CLI

Expand Down Expand Up @@ -531,7 +531,7 @@ myapp driver delete --id <value>
exports[`cli docs generator generates CLI skill files 5`] = `
"# myapp-current-user

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Get the currently authenticated user

Expand All @@ -554,7 +554,7 @@ myapp current-user
exports[`cli docs generator generates CLI skill files 6`] = `
"# myapp-login

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Authenticate a user

Expand Down Expand Up @@ -1455,7 +1455,7 @@ export function getClient(contextName?: string) {
exports[`hooks docs generator generates hooks AGENTS.md 1`] = `
"# React Query Hooks - Agent Reference

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->
> This document is structured for LLM/agent consumption.

## OVERVIEW
Expand Down Expand Up @@ -1662,7 +1662,7 @@ exports[`hooks docs generator generates hooks README 1`] = `
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## Setup

Expand Down Expand Up @@ -1783,7 +1783,7 @@ No developer or entity involved in creating this software will be liable for any
exports[`hooks docs generator generates hooks skill files 1`] = `
"# hooks-car

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

React Query hooks for Car data operations

Expand Down Expand Up @@ -1821,7 +1821,7 @@ mutate({ make: '<value>', model: '<value>', year: '<value>', isElectric: '<value
exports[`hooks docs generator generates hooks skill files 2`] = `
"# hooks-driver

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

React Query hooks for Driver data operations

Expand Down Expand Up @@ -1859,7 +1859,7 @@ mutate({ name: '<value>', licenseNumber: '<value>' });
exports[`hooks docs generator generates hooks skill files 3`] = `
"# hooks-currentUser

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Get the currently authenticated user

Expand All @@ -1882,7 +1882,7 @@ const { data, isLoading } = useCurrentUserQuery();
exports[`hooks docs generator generates hooks skill files 4`] = `
"# hooks-login

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Authenticate a user

Expand All @@ -1906,7 +1906,7 @@ mutate({ email: '<value>', password: '<value>' });
exports[`multi-target cli docs generates multi-target AGENTS.md 1`] = `
"# myapp CLI - Agent Reference

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->
> This document is structured for LLM/agent consumption.

## OVERVIEW
Expand Down Expand Up @@ -2680,7 +2680,7 @@ exports[`multi-target cli docs generates multi-target README 1`] = `
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## Setup

Expand Down Expand Up @@ -2907,7 +2907,7 @@ exports[`multi-target cli docs generates multi-target skills 1`] = `
{
"content": "# myapp-context

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Manage API endpoint contexts for myapp (multi-target: auth, members, app)

Expand Down Expand Up @@ -2949,7 +2949,7 @@ myapp context use staging
{
"content": "# myapp-credentials

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Manage authentication tokens for myapp (shared across all targets)

Expand Down Expand Up @@ -2980,7 +2980,7 @@ myapp credentials status
{
"content": "# myapp-auth:user

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

CRUD operations for User records via myapp CLI (auth target)

Expand Down Expand Up @@ -3019,7 +3019,7 @@ myapp auth:user get --id <value>
{
"content": "# myapp-auth:current-user

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Get the currently authenticated user (auth target)

Expand All @@ -3042,7 +3042,7 @@ myapp auth:current-user
{
"content": "# myapp-auth:login

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Authenticate a user (auth target)

Expand All @@ -3066,7 +3066,7 @@ myapp auth:login --email <value> --password <value>
{
"content": "# myapp-members:member

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

CRUD operations for Member records via myapp CLI (members target)

Expand Down Expand Up @@ -3105,7 +3105,7 @@ myapp members:member get --id <value>
{
"content": "# myapp-app:car

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

CRUD operations for Car records via myapp CLI (app target)

Expand Down Expand Up @@ -4235,7 +4235,7 @@ async function handleDelete(argv: Partial<Record<string, unknown>>, prompter: In
exports[`orm docs generator generates ORM AGENTS.md 1`] = `
"# ORM Client - Agent Reference

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->
> This document is structured for LLM/agent consumption.

## OVERVIEW
Expand Down Expand Up @@ -4373,7 +4373,7 @@ exports[`orm docs generator generates ORM README 1`] = `
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## Setup

Expand Down Expand Up @@ -4504,7 +4504,7 @@ No developer or entity involved in creating this software will be liable for any
exports[`orm docs generator generates ORM skill files 1`] = `
"# orm-car

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for Car records

Expand Down Expand Up @@ -4542,7 +4542,7 @@ const item = await db.car.create({
exports[`orm docs generator generates ORM skill files 2`] = `
"# orm-driver

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for Driver records

Expand Down Expand Up @@ -4580,7 +4580,7 @@ const item = await db.driver.create({
exports[`orm docs generator generates ORM skill files 3`] = `
"# orm-currentUser

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Get the currently authenticated user

Expand All @@ -4603,7 +4603,7 @@ const result = await db.query.currentUser().execute();
exports[`orm docs generator generates ORM skill files 4`] = `
"# orm-login

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Authenticate a user

Expand Down Expand Up @@ -5334,7 +5334,7 @@ exports[`target docs generator generates per-target README 1`] = `
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## Overview

Expand Down Expand Up @@ -5398,7 +5398,7 @@ exports[`target docs generator generates root-root README for multi-target 1`] =
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## APIs

Expand Down
6 changes: 3 additions & 3 deletions graphql/codegen/src/__tests__/codegen/__snapshots__/react-query-hooks.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export * from "./useSearchUsersQuery";"

exports[`Barrel File Generators generateMainBarrel generates main barrel with all options enabled 1`] = `
"/**
* Auto-generated GraphQL SDK
* GraphQL SDK
* @generated by @constructive-io/graphql-codegen
*
* Tables: User, Post
Expand Down Expand Up @@ -70,7 +70,7 @@ export * from "./mutations";"

exports[`Barrel File Generators generateMainBarrel generates main barrel without custom operations 1`] = `
"/**
* Auto-generated GraphQL SDK
* GraphQL SDK
* @generated by @constructive-io/graphql-codegen
*
* Tables: User
Expand Down Expand Up @@ -109,7 +109,7 @@ export * from "./mutations";"

exports[`Barrel File Generators generateMainBarrel generates main barrel without mutations 1`] = `
"/**
* Auto-generated GraphQL SDK
* GraphQL SDK
* @generated by @constructive-io/graphql-codegen
*
* Tables: User, Post
Expand Down
4 changes: 2 additions & 2 deletions graphql/codegen/src/core/codegen/barrel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export function generateMainBarrel(
// Add file header as leading comment on first statement
if (statements.length > 0) {
addJSDocComment(statements[0], [
'Auto-generated GraphQL SDK',
'GraphQL SDK',
'@generated by @constructive-io/graphql-codegen',
'',
`Tables: ${tableNames}`,
Expand Down Expand Up @@ -222,7 +222,7 @@ export function generateRootBarrel(options: RootBarrelOptions = {}): string {
// Add file headeras leading comment on first statement
if (statements.length > 0) {
addJSDocComment(statements[0], [
'Generated SDK - auto-generated, do not edit',
'GraphQL SDK - auto-generated, do not edit',
'@generated by @constructive-io/graphql-codegen',
]);
}
Expand Down
4 changes: 2 additions & 2 deletions graphql/codegen/src/core/codegen/cli/docs-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export function generateAgentsDocs(

lines.push(`# ${toolName} CLI - Agent Reference`);
lines.push('');
lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
lines.push('<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->');
lines.push('> This document is structured for LLM/agent consumption.');
lines.push('');

Expand Down Expand Up @@ -950,7 +950,7 @@ export function generateMultiTargetAgentsDocs(

lines.push(`# ${toolName} CLI - Agent Reference`);
lines.push('');
lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
lines.push('<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->');
lines.push('> This document is structured for LLM/agent consumption.');
lines.push('');

Expand Down
4 changes: 2 additions & 2 deletions graphql/codegen/src/core/codegen/docs-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function getReadmeHeader(title: string): string[] {
` <img height="120" src="${CONSTRUCTIVE_LOGO_URL}" />`,
'</p>',
'',
`> @generated by @constructive-io/graphql-codegen - DO NOT EDIT`,
`<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->`,
'',
];
}
Expand Down Expand Up @@ -125,7 +125,7 @@ export function buildSkillFile(skill: SkillDefinition): string {

lines.push(`# ${skill.name}`);
lines.push('');
lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
lines.push('<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->');
lines.push('');
lines.push(skill.description);
lines.push('');
Expand Down
2 changes: 1 addition & 1 deletion graphql/codegen/src/core/codegen/hooks-docs-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ export function generateHooksAgentsDocs(

lines.push('# React Query Hooks - Agent Reference');
lines.push('');
lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
lines.push('<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->');
lines.push('> This document is structured for LLM/agent consumption.');
lines.push('');

Expand Down
2 changes: 1 addition & 1 deletion graphql/codegen/src/core/codegen/orm/docs-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ export function generateOrmAgentsDocs(

lines.push('# ORM Client - Agent Reference');
lines.push('');
lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
lines.push('<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->');
lines.push('> This document is structured for LLM/agent consumption.');
lines.push('');

Expand Down
2 changes: 1 addition & 1 deletion graphql/codegen/src/core/codegen/shared/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ function generateSharedBarrel(hasSchemaTypes: boolean): string {
// Add file header as leading comment on first statement
if (statements.length > 0) {
addJSDocComment(statements[0], [
'Shared types - auto-generated, do not edit',
'Shared types - do not edit',
'@generated by @constructive-io/graphql-codegen',
]);
}
Expand Down
2 changes: 1 addition & 1 deletion sdk/constructive-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img height="120" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
</p>

> @generated by @constructive-io/graphql-codegen - DO NOT EDIT
<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

## APIs

Expand Down
Loading
Loading