Skip to content

fix: ignore generated docs in eslint#860

Merged
EdwardMoyse merged 1 commit into
HSF:mainfrom
GaneshPatil7517:fix/851-eslint-ignores-docs-folder
Apr 1, 2026
Merged

fix: ignore generated docs in eslint#860
EdwardMoyse merged 1 commit into
HSF:mainfrom
GaneshPatil7517:fix/851-eslint-ignores-docs-folder

Conversation

@GaneshPatil7517
Copy link
Copy Markdown
Collaborator

This fixes the release failure caused by ESLint running on generated Compodoc files in the root docs/ directory.

During lerna publish, the version script generates docs and stages them with git add .. The pre-commit hook then runs lint-staged, which applies eslint --fix to staged *.ts files. That includes generated Compodoc files under docs/api-docs/template-playground/, where template-playground.component.ts contains an intentional self-assignment that violates the no-self-assign rule.

This change excludes the generated docs/** tree from ESLint so release commits do not fail on generated artifacts.

Change

  • add docs/** to the ESLint ignore list

Testing

  • ran yarn workspace phoenix-event-display docs
  • staged the generated docs locally
  • ran yarn lint-staged
  • confirmed the previous no-self-assign failure no longer occurs

Copilot AI review requested due to automatic review settings March 27, 2026 05:42
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@EdwardMoyse EdwardMoyse merged commit 52f6d87 into HSF:main Apr 1, 2026
6 checks passed
@EdwardMoyse
Copy link
Copy Markdown
Member

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants