Skip to content

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

Updates release process to use ESLint class instead of the old CLIEngine class when generating formatters docs.

What changes did you make? (Give an overview)

Extracted generating formatters docs into a separate file to be able to run it synchronously and updated it to use the ESLint class. This ensures correctness of formatter examples in ESLint v9 (when using the default flat config mode) and is something we'd need to do sooner or later since the CLIEngine will be removed in ESLint v10.

Is there anything you'd like reviewers to focus on?

@mdjermanovic mdjermanovic requested a review from a team as a code owner July 26, 2025 22:01
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Jul 26, 2025
@eslint-github-bot eslint-github-bot bot added the build This change relates to ESLint's build process label Jul 26, 2025
Copy link

netlify bot commented Jul 26, 2025

Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit 962ade2
🔍 Latest deploy log https://app.netlify.com/projects/docs-eslint/deploys/68860839466c030008753e22

Comment on lines +24 to +25
// Run from Makefile.js
"tools/generate-formatter-examples.js",
Copy link
Member Author

Choose a reason for hiding this comment

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

Knip didn't see this as used so I had to add it to ignore ,

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks.

@nzakas nzakas merged commit 27fa865 into main Jul 28, 2025
30 checks passed
@nzakas nzakas deleted the docs-formatters-flat branch July 28, 2025 15:13
@github-project-automation github-project-automation bot moved this from Needs Triage to Complete in Triage Jul 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build This change relates to ESLint's build process
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

2 participants