Skip to content

Expand generators.yml schema tip to clarify editor support (VS Code, In… #6819

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
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Expand generators.yml schema tip to clarify editor support (VS Code, In… #6819

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 fern/products/sdks/reference/generators-yml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ The `generators.yml` file serves two purposes: it declares your API definition (

<Tip>
To enable intelligent YAML validation and autocompletion in your editor, add a schema directive to the top of your `generators.yml` file.

The `# yaml-language-server: $schema=...` comment is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)) and other editors that embed the YAML Language Server.

**IntelliJ IDEA** does not use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file.

@github-actions github-actions Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'IDEA' has no definition.

@github-actions github-actions Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'doesn't' instead of 'does not'.

Suggested change
**IntelliJ IDEA** does not use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file.
**IntelliJ IDEA** doesn't use the YAML Language Server comment directive. To get schema validation in IntelliJ, open **Preferences → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings**, add a new mapping, set the schema URL to `https://schema.buildwithfern.dev/generators-yml.json`, and map it to your `generators.yml` file.

</Tip>

```yaml title="generators.yml" maxLines=10
Expand Down
Loading