Commit d1b61a7
authored
chore: Selectively disable
## Explanation
The ESLint rule `jsdoc/check-tag-names` mangles a lot of comment blocks
we have for types. The types are currently written in a way that doesn't
comply with the TSDoc spec, and we should fix them, but leaving the rule
enabled (even with error suppression!) prevents us from using `--fix`.
The rule has been selectively disabled in each file that has malformed
doc blocks impacted by this problem. We can remove these files
one-by-one as we fix the inline docs.
## References
Relates to #6790
These changes were extracted from the draft PR #7148
## 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
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Disables `jsdoc/check-tag-names` for specific files via ESLint
overrides and updates warning thresholds accordingly.
>
> - **ESLint Configuration**:
> - Remove global `jsdoc/check-tag-names` warning from TypeScript rules.
> - Add targeted override disabling `jsdoc/check-tag-names` for specific
files (e.g., various controllers, message-manager files, tests).
> - **Warning Thresholds**:
> - Update `eslint-warning-thresholds.json` to drop
`jsdoc/check-tag-names` entries for affected files.
> - Minor cleanup to reflect current active rules (e.g.,
`TokensController.ts`, `siwe.ts`, `tests/fake-provider.ts`).
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
bc83018. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->jsodc/check-tag-names ESLint rule (#7152)1 parent d324207 commit d1b61a7
2 files changed
+29
-43
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | 34 | | |
38 | 35 | | |
39 | 36 | | |
| |||
49 | 46 | | |
50 | 47 | | |
51 | 48 | | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | 49 | | |
56 | 50 | | |
57 | 51 | | |
58 | 52 | | |
59 | | - | |
60 | | - | |
| 53 | + | |
61 | 54 | | |
62 | 55 | | |
63 | 56 | | |
| |||
74 | 67 | | |
75 | 68 | | |
76 | 69 | | |
77 | | - | |
78 | | - | |
| 70 | + | |
79 | 71 | | |
80 | 72 | | |
81 | 73 | | |
| |||
90 | 82 | | |
91 | 83 | | |
92 | 84 | | |
93 | | - | |
94 | | - | |
95 | | - | |
96 | 85 | | |
97 | 86 | | |
98 | 87 | | |
| |||
114 | 103 | | |
115 | 104 | | |
116 | 105 | | |
117 | | - | |
118 | | - | |
119 | | - | |
120 | 106 | | |
121 | 107 | | |
122 | 108 | | |
| |||
133 | 119 | | |
134 | 120 | | |
135 | 121 | | |
136 | | - | |
137 | | - | |
138 | | - | |
139 | | - | |
140 | | - | |
141 | | - | |
142 | | - | |
143 | | - | |
144 | | - | |
145 | | - | |
146 | | - | |
147 | | - | |
148 | 122 | | |
149 | 123 | | |
150 | 124 | | |
| |||
157 | 131 | | |
158 | 132 | | |
159 | 133 | | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
165 | | - | |
166 | 134 | | |
167 | 135 | | |
168 | 136 | | |
169 | | - | |
170 | | - | |
171 | | - | |
172 | 137 | | |
173 | 138 | | |
174 | 139 | | |
| |||
202 | 167 | | |
203 | 168 | | |
204 | 169 | | |
205 | | - | |
206 | | - | |
207 | | - | |
208 | | - | |
209 | | - | |
| 170 | + | |
210 | 171 | | |
211 | 172 | | |
212 | 173 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
169 | 169 | | |
170 | 170 | | |
171 | 171 | | |
172 | | - | |
173 | 172 | | |
174 | 173 | | |
175 | 174 | | |
| |||
249 | 248 | | |
250 | 249 | | |
251 | 250 | | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
252 | 277 | | |
253 | 278 | | |
254 | 279 | | |
0 commit comments