:sparkles: section generate predefined anchor link by edno · Pull Request #2733 · graphql-markdown/graphql-markdown

edno · 2026-03-02T15:38:31Z

Description

This PR add supporrt for custom section header IDs, eg ### InputParam \{#input-param\} to support #2713.
The notation is supported by default by Docusaurus (not documented), and it should be compatible with any Remark based Markdown parser using https://github.com/playfulprogramming/rehype-slug-custom-id.

To allow backward compatiblity, a new docOptions config flag has been created sectionHeaderId and set to true by default (custom ID generated by default). When set to false, it disable the generation of custom id, and it can also be disabled using CLI flag --noSectionId.

Checklist

My changes follow the contributing guidelines of this project.
I have performed a self-review of my code.
I have made corresponding changes to the documentation.
I have added tests that prove my fix is effective or that my changes work.
New and existing unit tests pass locally with my changes.

…link

Copilot

Pull request overview

This PR adds support for generating stable, in-page anchor permalinks for legacy printer section headers by emitting custom header IDs (e.g. ### Title {#title}), and wires a new docOptions.sectionHeaderId / --noSectionId toggle through core, CLI, and integrations.

Changes:

Generate section header custom IDs and use them to build non-broken #<id> links in printer-legacy.
Add sectionHeaderId option to types/config plumbing and propagate it from docOptions into printer options.
Add/adjust unit tests and update documentation for the new option and CLI flag.

Reviewed changes

Copilot reviewed 21 out of 23 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/types/src/printer.d.ts	Adds `sectionHeaderId` to printer/type options and optional `id` on `TypeLink`.
packages/types/src/core.d.ts	Adds `docOptions.sectionHeaderId` and CLI `noSectionId` typings.
packages/printer-legacy/src/section.ts	Appends `{#id}` to section headers (when enabled) and uses generated link IDs.
packages/printer-legacy/src/printer.ts	Introduces `sectionHeaderId` init/config propagation into `Printer.options`.
packages/printer-legacy/src/link.ts	Adds fallback `id` generation and prints `#<id>` hash links when enabled.
packages/printer-legacy/src/const/options.ts	Enables `sectionHeaderId: true` by default in legacy printer defaults.
packages/core/src/generator.ts	Passes `docOptions.sectionHeaderId` into printer init options.
packages/core/src/config.ts	Adds `sectionHeaderId` resolution from config/CLI/defaults (but currently mis-handles `noSectionId`).
packages/cli/src/index.ts	Adds `--noSectionId` CLI option.
docs/settings.md	Documents `docOptions.sectionHeaderId` and the `--noSectionId` flag.
packages/printer-legacy/tests/unit/section.test.ts	Updates snapshots to include generated hash links and `{#id}` markers.
packages/printer-legacy/tests/unit/printer.test.ts	Updates expected default options to include `sectionHeaderId: true`.
packages/printer-legacy/tests/unit/link.test.ts	Adds coverage for disabling section IDs and updates link expectations to use `#<id>`.
packages/printer-legacy/tests/unit/graphql/operation.test.ts	Updates snapshots for argument links and `{#id}` markers.
packages/printer-legacy/tests/unit/graphql/object.test.ts	Updates snapshots for field links and `{#id}` markers.
packages/printer-legacy/tests/unit/graphql/interface.test.ts	Updates snapshots for field links and `{#id}` markers.
packages/printer-legacy/tests/unit/graphql/input.test.ts	Updates snapshots for field links and `{#id}` markers.
packages/printer-legacy/tests/unit/graphql/enum.test.ts	Updates snapshots for enum value links and `{#id}` markers.
packages/printer-legacy/tests/unit/graphql/directive.test.ts	Updates snapshots for directive argument links and `{#id}` markers.
packages/docusaurus/tests/unit/index.test.ts	Ensures `docOptions.sectionHeaderId` is forwarded through the Docusaurus plugin.
packages/core/tests/unit/generator.test.ts	Ensures `docOptions.sectionHeaderId` reaches printer options in generator flow.
packages/core/tests/unit/config.test.ts	Updates config expectations to include `sectionHeaderId`.
packages/cli/tests/unit/index.test.ts	Adds CLI option expectations for `--noSectionId` and forwarding coverage.

packages/core/src/config.ts

docs/settings.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated 2 comments.

packages/printer-legacy/src/link.ts

docs/settings.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated 2 comments.

packages/printer-legacy/src/section.ts

docs/settings.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated 3 comments.

packages/printer-legacy/src/link.ts

packages/core/src/config.ts

packages/printer-legacy/src/link.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

sonarqubecloud · 2026-03-03T11:14:32Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:34Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:34Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:36Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:36Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:37Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
98.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-03-03T11:14:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated no new comments.

edno added 3 commits March 2, 2026 15:42

add custom header id for better permalink support

20c8108

support config parameter sectionHeaderId (default true)

f6fc306

update docs settings docOptions

7e53f3d

edno linked an issue Mar 2, 2026 that may be closed by this pull request

Fields all generate a broken anchor link #2713

Closed

edno changed the title ~~Feat/2713 fields generate predefined anchor link~~ ✨ section generate predefined anchor link Mar 2, 2026

edno added 2 commits March 2, 2026 16:44

Merge branch 'main' into feat/2713-fields-generate-predefined-anchor-…

5dd231c

…link

improve tests for sectionHeaderId flag

302ecd6

edno marked this pull request as ready for review March 2, 2026 15:58

Copilot AI review requested due to automatic review settings March 2, 2026 15:58

Copilot started reviewing on behalf of edno March 2, 2026 15:58 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

packages/core/src/config.ts Outdated Show resolved Hide resolved

docs/settings.md Outdated Show resolved Hide resolved

edno and others added 2 commits March 2, 2026 17:04

Update docs/settings.md

d6e1e8d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

invert cli flag resolution logic (fix)

c8de574

edno requested a review from Copilot March 2, 2026 16:08

Copilot started reviewing on behalf of edno March 2, 2026 16:09 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

packages/printer-legacy/src/link.ts Outdated Show resolved Hide resolved

docs/settings.md Outdated Show resolved Hide resolved

edno and others added 4 commits March 2, 2026 17:16

Update docs/settings.md

9f2f88c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

Update packages/printer-legacy/src/link.ts

75789ac

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

refactor code

bb75a98

fix duplicate declaration of hasStringProperty

598978c

edno requested a review from Copilot March 2, 2026 19:02

Copilot started reviewing on behalf of edno March 2, 2026 19:02 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

packages/printer-legacy/src/section.ts Show resolved Hide resolved

docs/settings.md Outdated Show resolved Hide resolved

edno and others added 2 commits March 3, 2026 11:19

Update docs/settings.md

0819c69

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

use parent type for anchor id to reduce id collision risk

d1607f1

edno requested a review from Copilot March 3, 2026 10:43

Copilot started reviewing on behalf of edno March 3, 2026 10:43 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

packages/printer-legacy/src/link.ts Outdated Show resolved Hide resolved

packages/core/src/config.ts Outdated Show resolved Hide resolved

packages/printer-legacy/src/link.ts Outdated Show resolved Hide resolved

edno and others added 2 commits March 3, 2026 11:52

clean up unused async/await tests for printer-legacy

a4e41f8

Update packages/core/src/config.ts

e4f5b35

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Grégory Heitz <324670+edno@users.noreply.github.com>

remove "id" test on link name

59d74f8

edno requested a review from Copilot March 3, 2026 11:13

Copilot started reviewing on behalf of edno March 3, 2026 11:14 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

edno enabled auto-merge (squash) March 3, 2026 11:26

edno disabled auto-merge March 3, 2026 11:26

edno merged commit 413226a into main Mar 3, 2026
37 checks passed

edno deleted the feat/2713-fields-generate-predefined-anchor-link branch March 3, 2026 11:30

edno mentioned this pull request Mar 3, 2026

Fields all generate a broken anchor link #2713

Closed

Uh oh!

Conversation

edno commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Mar 3, 2026

Quality Gate passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

edno commented Mar 2, 2026 •

edited

Loading