fix: ignore generated docs in eslint#860
Merged
EdwardMoyse merged 1 commit intoApr 1, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR prevents release commits from failing during lint-staged by excluding the root generated docs/ output (including Compodoc artifacts) from ESLint’s file matching.
Changes:
- Add
docs/**to the ESLint flat config ignore list so generated documentation TypeScript files are skipped.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes the release failure caused by ESLint running on generated Compodoc files in the root
docs/directory.During
lerna publish, theversionscript generates docs and stages them withgit add .. The pre-commit hook then runslint-staged, which applieseslint --fixto staged*.tsfiles. That includes generated Compodoc files underdocs/api-docs/template-playground/, wheretemplate-playground.component.tscontains an intentional self-assignment that violates theno-self-assignrule.This change excludes the generated
docs/**tree from ESLint so release commits do not fail on generated artifacts.Change
docs/**to the ESLint ignore listTesting
yarn workspace phoenix-event-display docsyarn lint-stagedno-self-assignfailure no longer occurs