chore: simplify auto-generated file header comment#8279
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
7bbac4d to
472e809
Compare
NicolasMassart
left a comment
There was a problem hiding this comment.
I liked the info of script path, it was very useful for me when looking at the file, because otherwise you know it is generated, but have no idea how, and you have to read all the doc. I do not endorse this change as is.
I do not see any issue that this fixes also. What was this blocking/breaking?
I do not see any performance improvement or clarity improvement removing the script path.
Change my mind.
Description updated with context. |
I don't want to block this if everyone agrees it's useful
## Explanation The auto-generated method action type files previously referenced the generator script path in their header comment (`This file is auto generated by scripts/generate-method-action-types.ts`). This simplifies it to just `This file is auto generated.`. For context why we are making this change #8264 (comment) ## References N/A ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md) - [ ] I've introduced [breaking changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md) in this PR and have prepared draft pull requests for clients and consumer packages to resolve them <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Only changes a comment string in generated `*-method-action-types.ts` files and the generator script; no runtime logic or types are modified beyond file header text. > > **Overview** > **Simplifies the header comment** across all auto-generated `*-method-action-types.ts` files by removing the explicit generator script path reference and leaving `This file is auto generated.` plus `Do not edit manually.` > > Updates `scripts/generate-method-action-types.ts` so future generations produce the new header format. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 472e809. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->

Explanation
The auto-generated method action type files previously referenced the generator script path in their header comment (
This file is auto generated by scripts/generate-method-action-types.ts). This simplifies it to justThis file is auto generated..For context why we are making this change #8264 (comment)
References
N/A
Checklist
Note
Low Risk
Only changes a comment string in generated
*-method-action-types.tsfiles and the generator script; no runtime logic or types are modified beyond file header text.Overview
Simplifies the header comment across all auto-generated
*-method-action-types.tsfiles by removing the explicit generator script path reference and leavingThis file is auto generated.plusDo not edit manually.Updates
scripts/generate-method-action-types.tsso future generations produce the new header format.Written by Cursor Bugbot for commit 472e809. This will update automatically on new commits. Configure here.