Add mergeProps ESLint migration tooling - #8278
Open
joshblack wants to merge 6 commits into
Open
Conversation
|
github-actions
Bot
added
staff
Contributor
|
joshblack
changed the title
joshblack
marked this pull request as ready for review
August 10, 2026 20:10
joshblack
added
the
integration-tests: skipped manually
Contributor
There was a problem hiding this comment.
Pull request overview
Adds internal migration tooling to track component roots that should adopt mergeProps, by introducing a local ESLint rule/package and a scheduled GitHub Actions job that generates a migration-status report.
Changes:
- Introduces a private
@primer/eslint-configpackage that registers theprimer/prefer-merge-propsrule (disabled by default) plus unit tests. - Adds a
script/merge-props-migration-status.mtsreport generator that runs ESLint overpackages/react/srcwith the rule enabled and prints a Markdown summary. - Integrates the report into the scheduled “Migration Status” workflow and registers the local config in the root
eslint.config.mjs.
Show a summary per file
| File | Description |
|---|---|
| script/merge-props-migration-status.mts | Generates a Markdown report by running ESLint with primer/prefer-merge-props enabled and summarizing violations. |
| packages/eslint-config/vitest.config.ts | Configures Vitest for the new ESLint-config workspace package. |
| packages/eslint-config/tsconfig.json | TS config for the new workspace package (including rule/test sources). |
| packages/eslint-config/src/rules/preferMergeProps.ts | Implements the prefer-merge-props ESLint rule logic. |
| packages/eslint-config/src/rules/preferMergeProps.test.ts | Adds RuleTester-based coverage for intended rule boundaries and false-positive avoidance. |
| packages/eslint-config/src/index.ts | Exports the flat config + plugin under the primer namespace and keeps the rule off by default. |
| packages/eslint-config/src/index.test.ts | Verifies package exports and default disabled behavior. |
| packages/eslint-config/package.json | Declares the new private workspace package, deps, and basic scripts. |
| package-lock.json | Links the new workspace package into the lockfile. |
| eslint.config.mjs | Registers the local Primer ESLint config in the root flat config array. |
| .github/workflows/migration-status.yml | Adds a scheduled job to run the mergeProps migration-status script and publish to step summary. |
Review details
Tip
Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 10/11 changed files
- Comments generated: 4
- Review effort level: Lite
Comment on lines
+27
to
+29
| const affectedResults = results.filter(result => { | ||
| return result.messages.some(message => message.ruleId === ruleId) | ||
| }) |
Comment on lines
+11
to
+14
| messages: { | ||
| preferMergeProps: | ||
| 'Spread props on a component root element with mergeProps so component and consumer props are merged intentionally.', | ||
| }, |
Comment on lines
+16
to
+19
| - name: install dependencies | ||
| run: npm ci | ||
| - name: run migration script | ||
| run: node script/merge-props-migration-status.mts >> $GITHUB_STEP_SUMMARY |
Comment on lines
+10
to
+12
| steps: | ||
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 | ||
| - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 |
joshblack
force-pushed
the
migrate/merge-props-eslint-tooling
branch
2 times, most recently
from
August 10, 2026 21:10
24e1307 to
7169487
Compare
joshblack
had a problem deploying
to
github-pages
August 10, 2026 21:14 — with 
GitHub Actions
Failure
GitHub Actions
Failure
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
Ignore pure prop-forwarding wrappers so the adoption report only tracks component roots with props that need intentional merging. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 00bfd295-6ed9-4119-8d63-103a0b3c63e8
joshblack
force-pushed
the
migrate/merge-props-eslint-tooling
branch
from
August 10, 2026 21:19
7169487 to
5e983dc
Compare
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.
Closes #
This PR adds the tooling used to identify and track component roots that should adopt
mergeProps. It introduces a private ESLint package, the migration report script, and the workflow that keeps the report current.Changelog
New
@primer/eslint-configwith theprimer/prefer-merge-propsrule.Changed
Removed
Rollout strategy
This is internal migration tooling and has no public-facing impact.
Testing & Reviewing
Please review the rule boundary and report output. Pure prop-forwarding wrappers should be ignored, while component roots that combine authored and consumer props should remain findings.