eslint 9.22.0 → 9.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (415) hide show
  1. package/README.md +47 -45
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +828 -808
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +541 -457
  21. package/lib/config/config-loader.js +648 -618
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +65 -68
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +709 -679
  30. package/lib/eslint/eslint.js +944 -886
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +576 -532
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2402 -2044
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +35 -35
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +375 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1307 -1045
  73. package/lib/rules/accessor-pairs.js +297 -262
  74. package/lib/rules/array-bracket-newline.js +249 -237
  75. package/lib/rules/array-bracket-spacing.js +262 -223
  76. package/lib/rules/array-callback-return.js +401 -355
  77. package/lib/rules/array-element-newline.js +357 -312
  78. package/lib/rules/arrow-body-style.js +399 -280
  79. package/lib/rules/arrow-parens.js +205 -172
  80. package/lib/rules/arrow-spacing.js +168 -162
  81. package/lib/rules/block-scoped-var.js +124 -122
  82. package/lib/rules/block-spacing.js +185 -175
  83. package/lib/rules/brace-style.js +261 -198
  84. package/lib/rules/callback-return.js +202 -189
  85. package/lib/rules/camelcase.js +402 -391
  86. package/lib/rules/capitalized-comments.js +252 -231
  87. package/lib/rules/class-methods-use-this.js +179 -171
  88. package/lib/rules/comma-dangle.js +378 -345
  89. package/lib/rules/comma-spacing.js +192 -194
  90. package/lib/rules/comma-style.js +374 -315
  91. package/lib/rules/complexity.js +172 -168
  92. package/lib/rules/computed-property-spacing.js +235 -210
  93. package/lib/rules/consistent-return.js +180 -169
  94. package/lib/rules/consistent-this.js +166 -146
  95. package/lib/rules/constructor-super.js +411 -403
  96. package/lib/rules/curly.js +406 -331
  97. package/lib/rules/default-case-last.js +37 -30
  98. package/lib/rules/default-case.js +88 -84
  99. package/lib/rules/default-param-last.js +68 -53
  100. package/lib/rules/dot-location.js +121 -109
  101. package/lib/rules/dot-notation.js +191 -155
  102. package/lib/rules/eol-last.js +121 -119
  103. package/lib/rules/eqeqeq.js +167 -154
  104. package/lib/rules/for-direction.js +145 -120
  105. package/lib/rules/func-call-spacing.js +260 -230
  106. package/lib/rules/func-name-matching.js +292 -208
  107. package/lib/rules/func-names.js +164 -163
  108. package/lib/rules/func-style.js +158 -126
  109. package/lib/rules/function-call-argument-newline.js +151 -128
  110. package/lib/rules/function-paren-newline.js +348 -290
  111. package/lib/rules/generator-star-spacing.js +228 -209
  112. package/lib/rules/getter-return.js +207 -171
  113. package/lib/rules/global-require.js +84 -73
  114. package/lib/rules/grouped-accessor-pairs.js +169 -149
  115. package/lib/rules/guard-for-in.js +71 -62
  116. package/lib/rules/handle-callback-err.js +107 -102
  117. package/lib/rules/id-blacklist.js +181 -198
  118. package/lib/rules/id-denylist.js +167 -186
  119. package/lib/rules/id-length.js +196 -170
  120. package/lib/rules/id-match.js +343 -288
  121. package/lib/rules/implicit-arrow-linebreak.js +101 -78
  122. package/lib/rules/indent-legacy.js +1343 -1117
  123. package/lib/rules/indent.js +2271 -1758
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +115 -106
  126. package/lib/rules/jsx-quotes.js +93 -81
  127. package/lib/rules/key-spacing.js +749 -632
  128. package/lib/rules/keyword-spacing.js +647 -604
  129. package/lib/rules/line-comment-position.js +141 -127
  130. package/lib/rules/linebreak-style.js +106 -105
  131. package/lib/rules/lines-around-comment.js +539 -447
  132. package/lib/rules/lines-around-directive.js +232 -202
  133. package/lib/rules/lines-between-class-members.js +304 -233
  134. package/lib/rules/logical-assignment-operators.js +581 -398
  135. package/lib/rules/max-classes-per-file.js +68 -67
  136. package/lib/rules/max-depth.js +145 -142
  137. package/lib/rules/max-len.js +472 -433
  138. package/lib/rules/max-lines-per-function.js +200 -175
  139. package/lib/rules/max-lines.js +157 -161
  140. package/lib/rules/max-nested-callbacks.js +101 -103
  141. package/lib/rules/max-params.js +77 -75
  142. package/lib/rules/max-statements-per-line.js +204 -197
  143. package/lib/rules/max-statements.js +167 -163
  144. package/lib/rules/multiline-comment-style.js +636 -478
  145. package/lib/rules/multiline-ternary.js +240 -175
  146. package/lib/rules/new-cap.js +232 -212
  147. package/lib/rules/new-parens.js +87 -78
  148. package/lib/rules/newline-after-var.js +286 -249
  149. package/lib/rules/newline-before-return.js +228 -221
  150. package/lib/rules/newline-per-chained-call.js +141 -126
  151. package/lib/rules/no-alert.js +89 -78
  152. package/lib/rules/no-array-constructor.js +121 -112
  153. package/lib/rules/no-async-promise-executor.js +29 -23
  154. package/lib/rules/no-await-in-loop.js +68 -70
  155. package/lib/rules/no-bitwise.js +123 -99
  156. package/lib/rules/no-buffer-constructor.js +54 -46
  157. package/lib/rules/no-caller.js +38 -32
  158. package/lib/rules/no-case-declarations.js +60 -56
  159. package/lib/rules/no-catch-shadow.js +75 -72
  160. package/lib/rules/no-class-assign.js +50 -47
  161. package/lib/rules/no-compare-neg-zero.js +61 -47
  162. package/lib/rules/no-cond-assign.js +147 -131
  163. package/lib/rules/no-confusing-arrow.js +97 -80
  164. package/lib/rules/no-console.js +201 -198
  165. package/lib/rules/no-const-assign.js +46 -40
  166. package/lib/rules/no-constant-binary-expression.js +499 -404
  167. package/lib/rules/no-constant-condition.js +157 -142
  168. package/lib/rules/no-constructor-return.js +48 -48
  169. package/lib/rules/no-continue.js +24 -26
  170. package/lib/rules/no-control-regex.js +124 -120
  171. package/lib/rules/no-debugger.js +27 -29
  172. package/lib/rules/no-delete-var.js +28 -28
  173. package/lib/rules/no-div-regex.js +46 -40
  174. package/lib/rules/no-dupe-args.js +67 -68
  175. package/lib/rules/no-dupe-class-members.js +92 -88
  176. package/lib/rules/no-dupe-else-if.js +99 -76
  177. package/lib/rules/no-dupe-keys.js +132 -109
  178. package/lib/rules/no-duplicate-case.js +49 -42
  179. package/lib/rules/no-duplicate-imports.js +178 -175
  180. package/lib/rules/no-else-return.js +429 -384
  181. package/lib/rules/no-empty-character-class.js +56 -49
  182. package/lib/rules/no-empty-function.js +126 -127
  183. package/lib/rules/no-empty-pattern.js +62 -57
  184. package/lib/rules/no-empty-static-block.js +36 -34
  185. package/lib/rules/no-empty.js +97 -85
  186. package/lib/rules/no-eq-null.js +36 -31
  187. package/lib/rules/no-eval.js +255 -249
  188. package/lib/rules/no-ex-assign.js +41 -38
  189. package/lib/rules/no-extend-native.js +160 -158
  190. package/lib/rules/no-extra-bind.js +200 -189
  191. package/lib/rules/no-extra-boolean-cast.js +397 -347
  192. package/lib/rules/no-extra-label.js +149 -130
  193. package/lib/rules/no-extra-parens.js +1653 -1324
  194. package/lib/rules/no-extra-semi.js +145 -143
  195. package/lib/rules/no-fallthrough.js +198 -156
  196. package/lib/rules/no-floating-decimal.js +73 -65
  197. package/lib/rules/no-func-assign.js +53 -54
  198. package/lib/rules/no-global-assign.js +77 -72
  199. package/lib/rules/no-implicit-coercion.js +348 -292
  200. package/lib/rules/no-implicit-globals.js +157 -134
  201. package/lib/rules/no-implied-eval.js +139 -111
  202. package/lib/rules/no-import-assign.js +144 -158
  203. package/lib/rules/no-inline-comments.js +100 -94
  204. package/lib/rules/no-inner-declarations.js +114 -100
  205. package/lib/rules/no-invalid-regexp.js +221 -189
  206. package/lib/rules/no-invalid-this.js +122 -116
  207. package/lib/rules/no-irregular-whitespace.js +265 -251
  208. package/lib/rules/no-iterator.js +28 -32
  209. package/lib/rules/no-label-var.js +58 -61
  210. package/lib/rules/no-labels.js +137 -132
  211. package/lib/rules/no-lone-blocks.js +126 -122
  212. package/lib/rules/no-lonely-if.js +107 -76
  213. package/lib/rules/no-loop-func.js +233 -212
  214. package/lib/rules/no-loss-of-precision.js +215 -200
  215. package/lib/rules/no-magic-numbers.js +245 -217
  216. package/lib/rules/no-misleading-character-class.js +498 -445
  217. package/lib/rules/no-mixed-operators.js +187 -181
  218. package/lib/rules/no-mixed-requires.js +252 -239
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +133 -120
  220. package/lib/rules/no-multi-assign.js +45 -43
  221. package/lib/rules/no-multi-spaces.js +162 -142
  222. package/lib/rules/no-multi-str.js +41 -40
  223. package/lib/rules/no-multiple-empty-lines.js +195 -157
  224. package/lib/rules/no-native-reassign.js +89 -84
  225. package/lib/rules/no-negated-condition.js +78 -74
  226. package/lib/rules/no-negated-in-lhs.js +44 -42
  227. package/lib/rules/no-nested-ternary.js +32 -31
  228. package/lib/rules/no-new-func.js +70 -61
  229. package/lib/rules/no-new-native-nonconstructor.js +42 -38
  230. package/lib/rules/no-new-object.js +47 -47
  231. package/lib/rules/no-new-require.js +47 -46
  232. package/lib/rules/no-new-symbol.js +51 -49
  233. package/lib/rules/no-new-wrappers.js +42 -40
  234. package/lib/rules/no-new.js +27 -28
  235. package/lib/rules/no-nonoctal-decimal-escape.js +140 -120
  236. package/lib/rules/no-obj-calls.js +65 -52
  237. package/lib/rules/no-object-constructor.js +103 -96
  238. package/lib/rules/no-octal-escape.js +39 -42
  239. package/lib/rules/no-octal.js +31 -31
  240. package/lib/rules/no-param-reassign.js +234 -216
  241. package/lib/rules/no-path-concat.js +65 -66
  242. package/lib/rules/no-plusplus.js +59 -60
  243. package/lib/rules/no-process-env.js +48 -47
  244. package/lib/rules/no-process-exit.js +53 -49
  245. package/lib/rules/no-promise-executor-return.js +213 -181
  246. package/lib/rules/no-proto.js +25 -28
  247. package/lib/rules/no-prototype-builtins.js +145 -123
  248. package/lib/rules/no-redeclare.js +153 -151
  249. package/lib/rules/no-regex-spaces.js +182 -160
  250. package/lib/rules/no-restricted-exports.js +207 -184
  251. package/lib/rules/no-restricted-globals.js +110 -111
  252. package/lib/rules/no-restricted-imports.js +656 -536
  253. package/lib/rules/no-restricted-modules.js +221 -201
  254. package/lib/rules/no-restricted-properties.js +180 -152
  255. package/lib/rules/no-restricted-syntax.js +55 -51
  256. package/lib/rules/no-return-assign.js +54 -49
  257. package/lib/rules/no-return-await.js +147 -123
  258. package/lib/rules/no-script-url.js +51 -44
  259. package/lib/rules/no-self-assign.js +147 -145
  260. package/lib/rules/no-self-compare.js +62 -45
  261. package/lib/rules/no-sequences.js +134 -115
  262. package/lib/rules/no-setter-return.js +184 -151
  263. package/lib/rules/no-shadow-restricted-names.js +60 -45
  264. package/lib/rules/no-shadow.js +341 -315
  265. package/lib/rules/no-spaced-func.js +81 -76
  266. package/lib/rules/no-sparse-arrays.js +53 -58
  267. package/lib/rules/no-sync.js +60 -59
  268. package/lib/rules/no-tabs.js +82 -71
  269. package/lib/rules/no-template-curly-in-string.js +32 -31
  270. package/lib/rules/no-ternary.js +24 -28
  271. package/lib/rules/no-this-before-super.js +320 -318
  272. package/lib/rules/no-throw-literal.js +30 -35
  273. package/lib/rules/no-trailing-spaces.js +198 -190
  274. package/lib/rules/no-undef-init.js +75 -60
  275. package/lib/rules/no-undef.js +50 -47
  276. package/lib/rules/no-undefined.js +72 -74
  277. package/lib/rules/no-underscore-dangle.js +369 -326
  278. package/lib/rules/no-unexpected-multiline.js +111 -101
  279. package/lib/rules/no-unmodified-loop-condition.js +253 -253
  280. package/lib/rules/no-unneeded-ternary.js +211 -146
  281. package/lib/rules/no-unreachable-loop.js +144 -141
  282. package/lib/rules/no-unreachable.js +254 -247
  283. package/lib/rules/no-unsafe-finally.js +92 -84
  284. package/lib/rules/no-unsafe-negation.js +104 -82
  285. package/lib/rules/no-unsafe-optional-chaining.js +191 -177
  286. package/lib/rules/no-unused-expressions.js +177 -161
  287. package/lib/rules/no-unused-labels.js +138 -123
  288. package/lib/rules/no-unused-private-class-members.js +205 -181
  289. package/lib/rules/no-unused-vars.js +1668 -1448
  290. package/lib/rules/no-use-before-define.js +228 -230
  291. package/lib/rules/no-useless-assignment.js +589 -510
  292. package/lib/rules/no-useless-backreference.js +211 -192
  293. package/lib/rules/no-useless-call.js +57 -52
  294. package/lib/rules/no-useless-catch.js +39 -39
  295. package/lib/rules/no-useless-computed-key.js +143 -114
  296. package/lib/rules/no-useless-concat.js +64 -59
  297. package/lib/rules/no-useless-constructor.js +157 -110
  298. package/lib/rules/no-useless-escape.js +341 -290
  299. package/lib/rules/no-useless-rename.js +182 -155
  300. package/lib/rules/no-useless-return.js +343 -311
  301. package/lib/rules/no-var.js +232 -211
  302. package/lib/rules/no-void.js +49 -47
  303. package/lib/rules/no-warning-comments.js +190 -185
  304. package/lib/rules/no-whitespace-before-property.js +130 -114
  305. package/lib/rules/no-with.js +23 -25
  306. package/lib/rules/nonblock-statement-body-position.js +148 -129
  307. package/lib/rules/object-curly-newline.js +305 -264
  308. package/lib/rules/object-curly-spacing.js +359 -313
  309. package/lib/rules/object-property-newline.js +136 -105
  310. package/lib/rules/object-shorthand.js +606 -501
  311. package/lib/rules/one-var-declaration-per-line.js +103 -99
  312. package/lib/rules/one-var.js +652 -536
  313. package/lib/rules/operator-assignment.js +218 -160
  314. package/lib/rules/operator-linebreak.js +294 -250
  315. package/lib/rules/padded-blocks.js +345 -307
  316. package/lib/rules/padding-line-between-statements.js +442 -438
  317. package/lib/rules/prefer-arrow-callback.js +361 -312
  318. package/lib/rules/prefer-const.js +417 -376
  319. package/lib/rules/prefer-destructuring.js +300 -278
  320. package/lib/rules/prefer-exponentiation-operator.js +175 -132
  321. package/lib/rules/prefer-named-capture-group.js +152 -139
  322. package/lib/rules/prefer-numeric-literals.js +120 -112
  323. package/lib/rules/prefer-object-has-own.js +115 -81
  324. package/lib/rules/prefer-object-spread.js +212 -192
  325. package/lib/rules/prefer-promise-reject-errors.js +139 -121
  326. package/lib/rules/prefer-reflect.js +126 -106
  327. package/lib/rules/prefer-regex-literals.js +577 -465
  328. package/lib/rules/prefer-rest-params.js +78 -79
  329. package/lib/rules/prefer-spread.js +46 -43
  330. package/lib/rules/prefer-template.js +265 -194
  331. package/lib/rules/quote-props.js +372 -306
  332. package/lib/rules/quotes.js +373 -325
  333. package/lib/rules/radix.js +151 -135
  334. package/lib/rules/require-atomic-updates.js +315 -284
  335. package/lib/rules/require-await.js +143 -115
  336. package/lib/rules/require-unicode-regexp.js +281 -176
  337. package/lib/rules/require-yield.js +52 -53
  338. package/lib/rules/rest-spread-spacing.js +127 -115
  339. package/lib/rules/semi-spacing.js +280 -249
  340. package/lib/rules/semi-style.js +175 -133
  341. package/lib/rules/semi.js +455 -435
  342. package/lib/rules/sort-imports.js +305 -232
  343. package/lib/rules/sort-keys.js +218 -187
  344. package/lib/rules/sort-vars.js +126 -92
  345. package/lib/rules/space-before-blocks.js +198 -188
  346. package/lib/rules/space-before-function-paren.js +185 -165
  347. package/lib/rules/space-in-parens.js +358 -287
  348. package/lib/rules/space-infix-ops.js +236 -200
  349. package/lib/rules/space-unary-ops.js +355 -297
  350. package/lib/rules/spaced-comment.js +362 -318
  351. package/lib/rules/strict.js +264 -229
  352. package/lib/rules/switch-colon-spacing.js +129 -121
  353. package/lib/rules/symbol-description.js +44 -47
  354. package/lib/rules/template-curly-spacing.js +147 -141
  355. package/lib/rules/template-tag-spacing.js +97 -87
  356. package/lib/rules/unicode-bom.js +53 -55
  357. package/lib/rules/use-isnan.js +236 -205
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +152 -110
  370. package/lib/rules/vars-on-top.js +151 -144
  371. package/lib/rules/wrap-iife.js +203 -190
  372. package/lib/rules/wrap-regex.js +69 -57
  373. package/lib/rules/yield-star-spacing.js +144 -133
  374. package/lib/rules/yoda.js +282 -271
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/shared/ajv.js +14 -14
  378. package/lib/shared/assert.js +3 -4
  379. package/lib/shared/ast-utils.js +7 -6
  380. package/lib/shared/deep-merge-arrays.js +24 -22
  381. package/lib/shared/directives.js +3 -2
  382. package/lib/shared/flags.js +46 -17
  383. package/lib/shared/logging.js +24 -25
  384. package/lib/shared/option-utils.js +43 -36
  385. package/lib/shared/runtime-info.js +136 -127
  386. package/lib/shared/serialization.js +27 -27
  387. package/lib/shared/severity.js +22 -22
  388. package/lib/shared/stats.js +5 -5
  389. package/lib/shared/string-utils.js +16 -16
  390. package/lib/shared/text-table.js +28 -27
  391. package/lib/shared/traverser.js +153 -146
  392. package/lib/types/index.d.ts +2010 -1559
  393. package/lib/types/rules.d.ts +5253 -5140
  394. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  395. package/lib/unsupported-api.js +5 -5
  396. package/messages/all-files-ignored.js +3 -3
  397. package/messages/all-matched-files-ignored.js +3 -3
  398. package/messages/config-file-missing.js +2 -2
  399. package/messages/config-plugin-missing.js +3 -3
  400. package/messages/config-serialize-function.js +9 -7
  401. package/messages/eslintrc-incompat.js +13 -15
  402. package/messages/eslintrc-plugins.js +3 -4
  403. package/messages/extend-config-missing.js +3 -3
  404. package/messages/failed-to-read-json.js +3 -3
  405. package/messages/file-not-found.js +3 -3
  406. package/messages/invalid-rule-options.js +2 -2
  407. package/messages/invalid-rule-severity.js +2 -2
  408. package/messages/no-config-found.js +3 -3
  409. package/messages/plugin-conflict.js +8 -8
  410. package/messages/plugin-invalid.js +3 -3
  411. package/messages/plugin-missing.js +3 -3
  412. package/messages/print-config-with-directory-path.js +2 -2
  413. package/messages/shared.js +6 -1
  414. package/messages/whitespace-found.js +3 -3
  415. package/package.json +11 -17
@@ -17,547 +17,667 @@ const astUtils = require("./utils/ast-utils");
17
17
  const ignore = require("ignore");
18
18
 
19
19
  const arrayOfStringsOrObjects = {
20
- type: "array",
21
- items: {
22
- anyOf: [
23
- { type: "string" },
24
- {
25
- type: "object",
26
- properties: {
27
- name: { type: "string" },
28
- message: {
29
- type: "string",
30
- minLength: 1
31
- },
32
- importNames: {
33
- type: "array",
34
- items: {
35
- type: "string"
36
- }
37
- },
38
- allowImportNames: {
39
- type: "array",
40
- items: {
41
- type: "string"
42
- }
43
- }
44
- },
45
- additionalProperties: false,
46
- required: ["name"],
47
- not: { required: ["importNames", "allowImportNames"] }
48
- }
49
- ]
50
- },
51
- uniqueItems: true
20
+ type: "array",
21
+ items: {
22
+ anyOf: [
23
+ { type: "string" },
24
+ {
25
+ type: "object",
26
+ properties: {
27
+ name: { type: "string" },
28
+ message: {
29
+ type: "string",
30
+ minLength: 1,
31
+ },
32
+ importNames: {
33
+ type: "array",
34
+ items: {
35
+ type: "string",
36
+ },
37
+ },
38
+ allowImportNames: {
39
+ type: "array",
40
+ items: {
41
+ type: "string",
42
+ },
43
+ },
44
+ },
45
+ additionalProperties: false,
46
+ required: ["name"],
47
+ not: { required: ["importNames", "allowImportNames"] },
48
+ },
49
+ ],
50
+ },
51
+ uniqueItems: true,
52
52
  };
53
53
 
54
54
  const arrayOfStringsOrObjectPatterns = {
55
- anyOf: [
56
- {
57
- type: "array",
58
- items: {
59
- type: "string"
60
- },
61
- uniqueItems: true
62
- },
63
- {
64
- type: "array",
65
- items: {
66
- type: "object",
67
- properties: {
68
- importNames: {
69
- type: "array",
70
- items: {
71
- type: "string"
72
- },
73
- minItems: 1,
74
- uniqueItems: true
75
- },
76
- allowImportNames: {
77
- type: "array",
78
- items: {
79
- type: "string"
80
- },
81
- minItems: 1,
82
- uniqueItems: true
83
- },
84
- group: {
85
- type: "array",
86
- items: {
87
- type: "string"
88
- },
89
- minItems: 1,
90
- uniqueItems: true
91
- },
92
- regex: {
93
- type: "string"
94
- },
95
- importNamePattern: {
96
- type: "string"
97
- },
98
- allowImportNamePattern: {
99
- type: "string"
100
- },
101
- message: {
102
- type: "string",
103
- minLength: 1
104
- },
105
- caseSensitive: {
106
- type: "boolean"
107
- }
108
- },
109
- additionalProperties: false,
110
- not: {
111
- anyOf: [
112
- { required: ["importNames", "allowImportNames"] },
113
- { required: ["importNamePattern", "allowImportNamePattern"] },
114
- { required: ["importNames", "allowImportNamePattern"] },
115
- { required: ["importNamePattern", "allowImportNames"] },
116
- { required: ["allowImportNames", "allowImportNamePattern"] }
117
- ]
118
- },
119
- oneOf: [
120
- { required: ["group"] },
121
- { required: ["regex"] }
122
- ]
123
- },
124
- uniqueItems: true
125
- }
126
- ]
55
+ anyOf: [
56
+ {
57
+ type: "array",
58
+ items: {
59
+ type: "string",
60
+ },
61
+ uniqueItems: true,
62
+ },
63
+ {
64
+ type: "array",
65
+ items: {
66
+ type: "object",
67
+ properties: {
68
+ importNames: {
69
+ type: "array",
70
+ items: {
71
+ type: "string",
72
+ },
73
+ minItems: 1,
74
+ uniqueItems: true,
75
+ },
76
+ allowImportNames: {
77
+ type: "array",
78
+ items: {
79
+ type: "string",
80
+ },
81
+ minItems: 1,
82
+ uniqueItems: true,
83
+ },
84
+ group: {
85
+ type: "array",
86
+ items: {
87
+ type: "string",
88
+ },
89
+ minItems: 1,
90
+ uniqueItems: true,
91
+ },
92
+ regex: {
93
+ type: "string",
94
+ },
95
+ importNamePattern: {
96
+ type: "string",
97
+ },
98
+ allowImportNamePattern: {
99
+ type: "string",
100
+ },
101
+ message: {
102
+ type: "string",
103
+ minLength: 1,
104
+ },
105
+ caseSensitive: {
106
+ type: "boolean",
107
+ },
108
+ },
109
+ additionalProperties: false,
110
+ not: {
111
+ anyOf: [
112
+ { required: ["importNames", "allowImportNames"] },
113
+ {
114
+ required: [
115
+ "importNamePattern",
116
+ "allowImportNamePattern",
117
+ ],
118
+ },
119
+ { required: ["importNames", "allowImportNamePattern"] },
120
+ { required: ["importNamePattern", "allowImportNames"] },
121
+ {
122
+ required: [
123
+ "allowImportNames",
124
+ "allowImportNamePattern",
125
+ ],
126
+ },
127
+ ],
128
+ },
129
+ oneOf: [{ required: ["group"] }, { required: ["regex"] }],
130
+ },
131
+ uniqueItems: true,
132
+ },
133
+ ],
127
134
  };
128
135
 
129
136
  /** @type {import('../shared/types').Rule} */
130
137
  module.exports = {
131
- meta: {
132
- type: "suggestion",
133
-
134
- docs: {
135
- description: "Disallow specified modules when loaded by `import`",
136
- recommended: false,
137
- url: "https://eslint.org/docs/latest/rules/no-restricted-imports"
138
- },
139
-
140
- messages: {
141
- path: "'{{importSource}}' import is restricted from being used.",
142
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
143
- pathWithCustomMessage: "'{{importSource}}' import is restricted from being used. {{customMessage}}",
144
-
145
- patterns: "'{{importSource}}' import is restricted from being used by a pattern.",
146
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
147
- patternWithCustomMessage: "'{{importSource}}' import is restricted from being used by a pattern. {{customMessage}}",
148
-
149
- patternAndImportName: "'{{importName}}' import from '{{importSource}}' is restricted from being used by a pattern.",
150
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
151
- patternAndImportNameWithCustomMessage: "'{{importName}}' import from '{{importSource}}' is restricted from being used by a pattern. {{customMessage}}",
152
-
153
- patternAndEverything: "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted from being used by a pattern.",
154
-
155
- patternAndEverythingWithRegexImportName: "* import is invalid because import name matching '{{importNames}}' pattern from '{{importSource}}' is restricted from being used.",
156
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
157
- patternAndEverythingWithCustomMessage: "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted from being used by a pattern. {{customMessage}}",
158
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
159
- patternAndEverythingWithRegexImportNameAndCustomMessage: "* import is invalid because import name matching '{{importNames}}' pattern from '{{importSource}}' is restricted from being used. {{customMessage}}",
160
-
161
- everything: "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted.",
162
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
163
- everythingWithCustomMessage: "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted. {{customMessage}}",
164
-
165
- importName: "'{{importName}}' import from '{{importSource}}' is restricted.",
166
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
167
- importNameWithCustomMessage: "'{{importName}}' import from '{{importSource}}' is restricted. {{customMessage}}",
168
-
169
- allowedImportName: "'{{importName}}' import from '{{importSource}}' is restricted because only '{{allowedImportNames}}' import(s) is/are allowed.",
170
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
171
- allowedImportNameWithCustomMessage: "'{{importName}}' import from '{{importSource}}' is restricted because only '{{allowedImportNames}}' import(s) is/are allowed. {{customMessage}}",
172
-
173
- everythingWithAllowImportNames: "* import is invalid because only '{{allowedImportNames}}' from '{{importSource}}' is/are allowed.",
174
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
175
- everythingWithAllowImportNamesAndCustomMessage: "* import is invalid because only '{{allowedImportNames}}' from '{{importSource}}' is/are allowed. {{customMessage}}",
176
-
177
- allowedImportNamePattern: "'{{importName}}' import from '{{importSource}}' is restricted because only imports that match the pattern '{{allowedImportNamePattern}}' are allowed from '{{importSource}}'.",
178
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
179
- allowedImportNamePatternWithCustomMessage: "'{{importName}}' import from '{{importSource}}' is restricted because only imports that match the pattern '{{allowedImportNamePattern}}' are allowed from '{{importSource}}'. {{customMessage}}",
180
-
181
- everythingWithAllowedImportNamePattern: "* import is invalid because only imports that match the pattern '{{allowedImportNamePattern}}' from '{{importSource}}' are allowed.",
182
- // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
183
- everythingWithAllowedImportNamePatternWithCustomMessage: "* import is invalid because only imports that match the pattern '{{allowedImportNamePattern}}' from '{{importSource}}' are allowed. {{customMessage}}"
184
- },
185
-
186
- schema: {
187
- anyOf: [
188
- arrayOfStringsOrObjects,
189
- {
190
- type: "array",
191
- items: [{
192
- type: "object",
193
- properties: {
194
- paths: arrayOfStringsOrObjects,
195
- patterns: arrayOfStringsOrObjectPatterns
196
- },
197
- additionalProperties: false
198
- }],
199
- additionalItems: false
200
- }
201
- ]
202
- }
203
- },
204
-
205
- create(context) {
206
- const sourceCode = context.sourceCode;
207
- const options = Array.isArray(context.options) ? context.options : [];
208
- const isPathAndPatternsObject =
209
- typeof options[0] === "object" &&
210
- (Object.hasOwn(options[0], "paths") || Object.hasOwn(options[0], "patterns"));
211
-
212
- const restrictedPaths = (isPathAndPatternsObject ? options[0].paths : context.options) || [];
213
- const groupedRestrictedPaths = restrictedPaths.reduce((memo, importSource) => {
214
- const path = typeof importSource === "string"
215
- ? importSource
216
- : importSource.name;
217
-
218
- if (!memo[path]) {
219
- memo[path] = [];
220
- }
221
-
222
- if (typeof importSource === "string") {
223
- memo[path].push({});
224
- } else {
225
- memo[path].push({
226
- message: importSource.message,
227
- importNames: importSource.importNames,
228
- allowImportNames: importSource.allowImportNames
229
- });
230
- }
231
- return memo;
232
- }, Object.create(null));
233
-
234
- // Handle patterns too, either as strings or groups
235
- let restrictedPatterns = (isPathAndPatternsObject ? options[0].patterns : []) || [];
236
-
237
- // standardize to array of objects if we have an array of strings
238
- if (restrictedPatterns.length > 0 && typeof restrictedPatterns[0] === "string") {
239
- restrictedPatterns = [{ group: restrictedPatterns }];
240
- }
241
-
242
- // relative paths are supported for this rule
243
- const restrictedPatternGroups = restrictedPatterns.map(
244
- ({ group, regex, message, caseSensitive, importNames, importNamePattern, allowImportNames, allowImportNamePattern }) => (
245
- {
246
- ...(group ? { matcher: ignore({ allowRelativePaths: true, ignorecase: !caseSensitive }).add(group) } : {}),
247
- ...(typeof regex === "string" ? { regexMatcher: new RegExp(regex, caseSensitive ? "u" : "iu") } : {}),
248
- customMessage: message,
249
- importNames,
250
- importNamePattern,
251
- allowImportNames,
252
- allowImportNamePattern
253
- }
254
- )
255
- );
256
-
257
- // if no imports are restricted we don't need to check
258
- if (Object.keys(restrictedPaths).length === 0 && restrictedPatternGroups.length === 0) {
259
- return {};
260
- }
261
-
262
- /**
263
- * Report a restricted path.
264
- * @param {string} importSource path of the import
265
- * @param {Map<string,Object[]>} importNames Map of import names that are being imported
266
- * @param {node} node representing the restricted path reference
267
- * @returns {void}
268
- * @private
269
- */
270
- function checkRestrictedPathAndReport(importSource, importNames, node) {
271
- if (!Object.hasOwn(groupedRestrictedPaths, importSource)) {
272
- return;
273
- }
274
-
275
- groupedRestrictedPaths[importSource].forEach(restrictedPathEntry => {
276
- const customMessage = restrictedPathEntry.message;
277
- const restrictedImportNames = restrictedPathEntry.importNames;
278
- const allowedImportNames = restrictedPathEntry.allowImportNames;
279
-
280
- if (!restrictedImportNames && !allowedImportNames) {
281
- context.report({
282
- node,
283
- messageId: customMessage ? "pathWithCustomMessage" : "path",
284
- data: {
285
- importSource,
286
- customMessage
287
- }
288
- });
289
-
290
- return;
291
- }
292
-
293
- importNames.forEach((specifiers, importName) => {
294
- if (importName === "*") {
295
- const [specifier] = specifiers;
296
-
297
- if (restrictedImportNames) {
298
- context.report({
299
- node,
300
- messageId: customMessage ? "everythingWithCustomMessage" : "everything",
301
- loc: specifier.loc,
302
- data: {
303
- importSource,
304
- importNames: restrictedImportNames,
305
- customMessage
306
- }
307
- });
308
- } else if (allowedImportNames) {
309
- context.report({
310
- node,
311
- messageId: customMessage ? "everythingWithAllowImportNamesAndCustomMessage" : "everythingWithAllowImportNames",
312
- loc: specifier.loc,
313
- data: {
314
- importSource,
315
- allowedImportNames,
316
- customMessage
317
- }
318
- });
319
- }
320
-
321
- return;
322
- }
323
-
324
- if (restrictedImportNames && restrictedImportNames.includes(importName)) {
325
- specifiers.forEach(specifier => {
326
- context.report({
327
- node,
328
- messageId: customMessage ? "importNameWithCustomMessage" : "importName",
329
- loc: specifier.loc,
330
- data: {
331
- importSource,
332
- customMessage,
333
- importName
334
- }
335
- });
336
- });
337
- }
338
-
339
- if (allowedImportNames && !allowedImportNames.includes(importName)) {
340
- specifiers.forEach(specifier => {
341
- context.report({
342
- node,
343
- loc: specifier.loc,
344
- messageId: customMessage ? "allowedImportNameWithCustomMessage" : "allowedImportName",
345
- data: {
346
- importSource,
347
- customMessage,
348
- importName,
349
- allowedImportNames
350
- }
351
- });
352
- });
353
- }
354
- });
355
- });
356
- }
357
-
358
- /**
359
- * Report a restricted path specifically for patterns.
360
- * @param {node} node representing the restricted path reference
361
- * @param {Object} group contains an Ignore instance for paths, the customMessage to show on failure,
362
- * and any restricted import names that have been specified in the config
363
- * @param {Map<string,Object[]>} importNames Map of import names that are being imported
364
- * @returns {void}
365
- * @private
366
- */
367
- function reportPathForPatterns(node, group, importNames) {
368
- const importSource = node.source.value.trim();
369
-
370
- const customMessage = group.customMessage;
371
- const restrictedImportNames = group.importNames;
372
- const restrictedImportNamePattern = group.importNamePattern ? new RegExp(group.importNamePattern, "u") : null;
373
- const allowedImportNames = group.allowImportNames;
374
- const allowedImportNamePattern = group.allowImportNamePattern ? new RegExp(group.allowImportNamePattern, "u") : null;
375
-
376
- /**
377
- * If we are not restricting to any specific import names and just the pattern itself,
378
- * report the error and move on
379
- */
380
- if (!restrictedImportNames && !allowedImportNames && !restrictedImportNamePattern && !allowedImportNamePattern) {
381
- context.report({
382
- node,
383
- messageId: customMessage ? "patternWithCustomMessage" : "patterns",
384
- data: {
385
- importSource,
386
- customMessage
387
- }
388
- });
389
- return;
390
- }
391
-
392
- importNames.forEach((specifiers, importName) => {
393
- if (importName === "*") {
394
- const [specifier] = specifiers;
395
-
396
- if (restrictedImportNames) {
397
- context.report({
398
- node,
399
- messageId: customMessage ? "patternAndEverythingWithCustomMessage" : "patternAndEverything",
400
- loc: specifier.loc,
401
- data: {
402
- importSource,
403
- importNames: restrictedImportNames,
404
- customMessage
405
- }
406
- });
407
- } else if (allowedImportNames) {
408
- context.report({
409
- node,
410
- messageId: customMessage ? "everythingWithAllowImportNamesAndCustomMessage" : "everythingWithAllowImportNames",
411
- loc: specifier.loc,
412
- data: {
413
- importSource,
414
- allowedImportNames,
415
- customMessage
416
- }
417
- });
418
- } else if (allowedImportNamePattern) {
419
- context.report({
420
- node,
421
- messageId: customMessage ? "everythingWithAllowedImportNamePatternWithCustomMessage" : "everythingWithAllowedImportNamePattern",
422
- loc: specifier.loc,
423
- data: {
424
- importSource,
425
- allowedImportNamePattern,
426
- customMessage
427
- }
428
- });
429
- } else {
430
- context.report({
431
- node,
432
- messageId: customMessage ? "patternAndEverythingWithRegexImportNameAndCustomMessage" : "patternAndEverythingWithRegexImportName",
433
- loc: specifier.loc,
434
- data: {
435
- importSource,
436
- importNames: restrictedImportNamePattern,
437
- customMessage
438
- }
439
- });
440
- }
441
-
442
- return;
443
- }
444
-
445
- if (
446
- (restrictedImportNames && restrictedImportNames.includes(importName)) ||
447
- (restrictedImportNamePattern && restrictedImportNamePattern.test(importName))
448
- ) {
449
- specifiers.forEach(specifier => {
450
- context.report({
451
- node,
452
- messageId: customMessage ? "patternAndImportNameWithCustomMessage" : "patternAndImportName",
453
- loc: specifier.loc,
454
- data: {
455
- importSource,
456
- customMessage,
457
- importName
458
- }
459
- });
460
- });
461
- }
462
-
463
- if (allowedImportNames && !allowedImportNames.includes(importName)) {
464
- specifiers.forEach(specifier => {
465
- context.report({
466
- node,
467
- messageId: customMessage ? "allowedImportNameWithCustomMessage" : "allowedImportName",
468
- loc: specifier.loc,
469
- data: {
470
- importSource,
471
- customMessage,
472
- importName,
473
- allowedImportNames
474
- }
475
- });
476
- });
477
- } else if (allowedImportNamePattern && !allowedImportNamePattern.test(importName)) {
478
- specifiers.forEach(specifier => {
479
- context.report({
480
- node,
481
- messageId: customMessage ? "allowedImportNamePatternWithCustomMessage" : "allowedImportNamePattern",
482
- loc: specifier.loc,
483
- data: {
484
- importSource,
485
- customMessage,
486
- importName,
487
- allowedImportNamePattern
488
- }
489
- });
490
- });
491
- }
492
- });
493
- }
494
-
495
- /**
496
- * Check if the given importSource is restricted by a pattern.
497
- * @param {string} importSource path of the import
498
- * @param {Object} group contains a Ignore instance for paths, and the customMessage to show if it fails
499
- * @returns {boolean} whether the variable is a restricted pattern or not
500
- * @private
501
- */
502
- function isRestrictedPattern(importSource, group) {
503
- return group.regexMatcher ? group.regexMatcher.test(importSource) : group.matcher.ignores(importSource);
504
- }
505
-
506
- /**
507
- * Checks a node to see if any problems should be reported.
508
- * @param {ASTNode} node The node to check.
509
- * @returns {void}
510
- * @private
511
- */
512
- function checkNode(node) {
513
- const importSource = node.source.value.trim();
514
- const importNames = new Map();
515
-
516
- if (node.type === "ExportAllDeclaration") {
517
- const starToken = sourceCode.getFirstToken(node, 1);
518
-
519
- importNames.set("*", [{ loc: starToken.loc }]);
520
- } else if (node.specifiers) {
521
- for (const specifier of node.specifiers) {
522
- let name;
523
- const specifierData = { loc: specifier.loc };
524
-
525
- if (specifier.type === "ImportDefaultSpecifier") {
526
- name = "default";
527
- } else if (specifier.type === "ImportNamespaceSpecifier") {
528
- name = "*";
529
- } else if (specifier.imported) {
530
- name = astUtils.getModuleExportName(specifier.imported);
531
- } else if (specifier.local) {
532
- name = astUtils.getModuleExportName(specifier.local);
533
- }
534
-
535
- if (typeof name === "string") {
536
- if (importNames.has(name)) {
537
- importNames.get(name).push(specifierData);
538
- } else {
539
- importNames.set(name, [specifierData]);
540
- }
541
- }
542
- }
543
- }
544
-
545
- checkRestrictedPathAndReport(importSource, importNames, node);
546
- restrictedPatternGroups.forEach(group => {
547
- if (isRestrictedPattern(importSource, group)) {
548
- reportPathForPatterns(node, group, importNames);
549
- }
550
- });
551
- }
552
-
553
- return {
554
- ImportDeclaration: checkNode,
555
- ExportNamedDeclaration(node) {
556
- if (node.source) {
557
- checkNode(node);
558
- }
559
- },
560
- ExportAllDeclaration: checkNode
561
- };
562
- }
138
+ meta: {
139
+ type: "suggestion",
140
+
141
+ docs: {
142
+ description: "Disallow specified modules when loaded by `import`",
143
+ recommended: false,
144
+ url: "https://eslint.org/docs/latest/rules/no-restricted-imports",
145
+ },
146
+
147
+ messages: {
148
+ path: "'{{importSource}}' import is restricted from being used.",
149
+ pathWithCustomMessage:
150
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
151
+ "'{{importSource}}' import is restricted from being used. {{customMessage}}",
152
+
153
+ patterns:
154
+ "'{{importSource}}' import is restricted from being used by a pattern.",
155
+ patternWithCustomMessage:
156
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
157
+ "'{{importSource}}' import is restricted from being used by a pattern. {{customMessage}}",
158
+
159
+ patternAndImportName:
160
+ "'{{importName}}' import from '{{importSource}}' is restricted from being used by a pattern.",
161
+ patternAndImportNameWithCustomMessage:
162
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
163
+ "'{{importName}}' import from '{{importSource}}' is restricted from being used by a pattern. {{customMessage}}",
164
+
165
+ patternAndEverything:
166
+ "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted from being used by a pattern.",
167
+
168
+ patternAndEverythingWithRegexImportName:
169
+ "* import is invalid because import name matching '{{importNames}}' pattern from '{{importSource}}' is restricted from being used.",
170
+ patternAndEverythingWithCustomMessage:
171
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
172
+ "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted from being used by a pattern. {{customMessage}}",
173
+ patternAndEverythingWithRegexImportNameAndCustomMessage:
174
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
175
+ "* import is invalid because import name matching '{{importNames}}' pattern from '{{importSource}}' is restricted from being used. {{customMessage}}",
176
+
177
+ everything:
178
+ "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted.",
179
+ everythingWithCustomMessage:
180
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
181
+ "* import is invalid because '{{importNames}}' from '{{importSource}}' is restricted. {{customMessage}}",
182
+
183
+ importName:
184
+ "'{{importName}}' import from '{{importSource}}' is restricted.",
185
+ importNameWithCustomMessage:
186
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
187
+ "'{{importName}}' import from '{{importSource}}' is restricted. {{customMessage}}",
188
+
189
+ allowedImportName:
190
+ "'{{importName}}' import from '{{importSource}}' is restricted because only '{{allowedImportNames}}' import(s) is/are allowed.",
191
+ allowedImportNameWithCustomMessage:
192
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
193
+ "'{{importName}}' import from '{{importSource}}' is restricted because only '{{allowedImportNames}}' import(s) is/are allowed. {{customMessage}}",
194
+
195
+ everythingWithAllowImportNames:
196
+ "* import is invalid because only '{{allowedImportNames}}' from '{{importSource}}' is/are allowed.",
197
+ everythingWithAllowImportNamesAndCustomMessage:
198
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
199
+ "* import is invalid because only '{{allowedImportNames}}' from '{{importSource}}' is/are allowed. {{customMessage}}",
200
+
201
+ allowedImportNamePattern:
202
+ "'{{importName}}' import from '{{importSource}}' is restricted because only imports that match the pattern '{{allowedImportNamePattern}}' are allowed from '{{importSource}}'.",
203
+ allowedImportNamePatternWithCustomMessage:
204
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
205
+ "'{{importName}}' import from '{{importSource}}' is restricted because only imports that match the pattern '{{allowedImportNamePattern}}' are allowed from '{{importSource}}'. {{customMessage}}",
206
+
207
+ everythingWithAllowedImportNamePattern:
208
+ "* import is invalid because only imports that match the pattern '{{allowedImportNamePattern}}' from '{{importSource}}' are allowed.",
209
+ everythingWithAllowedImportNamePatternWithCustomMessage:
210
+ // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period
211
+ "* import is invalid because only imports that match the pattern '{{allowedImportNamePattern}}' from '{{importSource}}' are allowed. {{customMessage}}",
212
+ },
213
+
214
+ schema: {
215
+ anyOf: [
216
+ arrayOfStringsOrObjects,
217
+ {
218
+ type: "array",
219
+ items: [
220
+ {
221
+ type: "object",
222
+ properties: {
223
+ paths: arrayOfStringsOrObjects,
224
+ patterns: arrayOfStringsOrObjectPatterns,
225
+ },
226
+ additionalProperties: false,
227
+ },
228
+ ],
229
+ additionalItems: false,
230
+ },
231
+ ],
232
+ },
233
+ },
234
+
235
+ create(context) {
236
+ const sourceCode = context.sourceCode;
237
+ const options = Array.isArray(context.options) ? context.options : [];
238
+ const isPathAndPatternsObject =
239
+ typeof options[0] === "object" &&
240
+ (Object.hasOwn(options[0], "paths") ||
241
+ Object.hasOwn(options[0], "patterns"));
242
+
243
+ const restrictedPaths =
244
+ (isPathAndPatternsObject ? options[0].paths : context.options) ||
245
+ [];
246
+ const groupedRestrictedPaths = restrictedPaths.reduce(
247
+ (memo, importSource) => {
248
+ const path =
249
+ typeof importSource === "string"
250
+ ? importSource
251
+ : importSource.name;
252
+
253
+ if (!memo[path]) {
254
+ memo[path] = [];
255
+ }
256
+
257
+ if (typeof importSource === "string") {
258
+ memo[path].push({});
259
+ } else {
260
+ memo[path].push({
261
+ message: importSource.message,
262
+ importNames: importSource.importNames,
263
+ allowImportNames: importSource.allowImportNames,
264
+ });
265
+ }
266
+ return memo;
267
+ },
268
+ Object.create(null),
269
+ );
270
+
271
+ // Handle patterns too, either as strings or groups
272
+ let restrictedPatterns =
273
+ (isPathAndPatternsObject ? options[0].patterns : []) || [];
274
+
275
+ // standardize to array of objects if we have an array of strings
276
+ if (
277
+ restrictedPatterns.length > 0 &&
278
+ typeof restrictedPatterns[0] === "string"
279
+ ) {
280
+ restrictedPatterns = [{ group: restrictedPatterns }];
281
+ }
282
+
283
+ // relative paths are supported for this rule
284
+ const restrictedPatternGroups = restrictedPatterns.map(
285
+ ({
286
+ group,
287
+ regex,
288
+ message,
289
+ caseSensitive,
290
+ importNames,
291
+ importNamePattern,
292
+ allowImportNames,
293
+ allowImportNamePattern,
294
+ }) => ({
295
+ ...(group
296
+ ? {
297
+ matcher: ignore({
298
+ allowRelativePaths: true,
299
+ ignorecase: !caseSensitive,
300
+ }).add(group),
301
+ }
302
+ : {}),
303
+ ...(typeof regex === "string"
304
+ ? {
305
+ regexMatcher: new RegExp(
306
+ regex,
307
+ caseSensitive ? "u" : "iu",
308
+ ),
309
+ }
310
+ : {}),
311
+ customMessage: message,
312
+ importNames,
313
+ importNamePattern,
314
+ allowImportNames,
315
+ allowImportNamePattern,
316
+ }),
317
+ );
318
+
319
+ // if no imports are restricted we don't need to check
320
+ if (
321
+ Object.keys(restrictedPaths).length === 0 &&
322
+ restrictedPatternGroups.length === 0
323
+ ) {
324
+ return {};
325
+ }
326
+
327
+ /**
328
+ * Report a restricted path.
329
+ * @param {string} importSource path of the import
330
+ * @param {Map<string,Object[]>} importNames Map of import names that are being imported
331
+ * @param {node} node representing the restricted path reference
332
+ * @returns {void}
333
+ * @private
334
+ */
335
+ function checkRestrictedPathAndReport(importSource, importNames, node) {
336
+ if (!Object.hasOwn(groupedRestrictedPaths, importSource)) {
337
+ return;
338
+ }
339
+
340
+ groupedRestrictedPaths[importSource].forEach(
341
+ restrictedPathEntry => {
342
+ const customMessage = restrictedPathEntry.message;
343
+ const restrictedImportNames =
344
+ restrictedPathEntry.importNames;
345
+ const allowedImportNames =
346
+ restrictedPathEntry.allowImportNames;
347
+
348
+ if (!restrictedImportNames && !allowedImportNames) {
349
+ context.report({
350
+ node,
351
+ messageId: customMessage
352
+ ? "pathWithCustomMessage"
353
+ : "path",
354
+ data: {
355
+ importSource,
356
+ customMessage,
357
+ },
358
+ });
359
+
360
+ return;
361
+ }
362
+
363
+ importNames.forEach((specifiers, importName) => {
364
+ if (importName === "*") {
365
+ const [specifier] = specifiers;
366
+
367
+ if (restrictedImportNames) {
368
+ context.report({
369
+ node,
370
+ messageId: customMessage
371
+ ? "everythingWithCustomMessage"
372
+ : "everything",
373
+ loc: specifier.loc,
374
+ data: {
375
+ importSource,
376
+ importNames: restrictedImportNames,
377
+ customMessage,
378
+ },
379
+ });
380
+ } else if (allowedImportNames) {
381
+ context.report({
382
+ node,
383
+ messageId: customMessage
384
+ ? "everythingWithAllowImportNamesAndCustomMessage"
385
+ : "everythingWithAllowImportNames",
386
+ loc: specifier.loc,
387
+ data: {
388
+ importSource,
389
+ allowedImportNames,
390
+ customMessage,
391
+ },
392
+ });
393
+ }
394
+
395
+ return;
396
+ }
397
+
398
+ if (
399
+ restrictedImportNames &&
400
+ restrictedImportNames.includes(importName)
401
+ ) {
402
+ specifiers.forEach(specifier => {
403
+ context.report({
404
+ node,
405
+ messageId: customMessage
406
+ ? "importNameWithCustomMessage"
407
+ : "importName",
408
+ loc: specifier.loc,
409
+ data: {
410
+ importSource,
411
+ customMessage,
412
+ importName,
413
+ },
414
+ });
415
+ });
416
+ }
417
+
418
+ if (
419
+ allowedImportNames &&
420
+ !allowedImportNames.includes(importName)
421
+ ) {
422
+ specifiers.forEach(specifier => {
423
+ context.report({
424
+ node,
425
+ loc: specifier.loc,
426
+ messageId: customMessage
427
+ ? "allowedImportNameWithCustomMessage"
428
+ : "allowedImportName",
429
+ data: {
430
+ importSource,
431
+ customMessage,
432
+ importName,
433
+ allowedImportNames,
434
+ },
435
+ });
436
+ });
437
+ }
438
+ });
439
+ },
440
+ );
441
+ }
442
+
443
+ /**
444
+ * Report a restricted path specifically for patterns.
445
+ * @param {node} node representing the restricted path reference
446
+ * @param {Object} group contains an Ignore instance for paths, the customMessage to show on failure,
447
+ * and any restricted import names that have been specified in the config
448
+ * @param {Map<string,Object[]>} importNames Map of import names that are being imported
449
+ * @returns {void}
450
+ * @private
451
+ */
452
+ function reportPathForPatterns(node, group, importNames) {
453
+ const importSource = node.source.value.trim();
454
+
455
+ const customMessage = group.customMessage;
456
+ const restrictedImportNames = group.importNames;
457
+ const restrictedImportNamePattern = group.importNamePattern
458
+ ? new RegExp(group.importNamePattern, "u")
459
+ : null;
460
+ const allowedImportNames = group.allowImportNames;
461
+ const allowedImportNamePattern = group.allowImportNamePattern
462
+ ? new RegExp(group.allowImportNamePattern, "u")
463
+ : null;
464
+
465
+ /**
466
+ * If we are not restricting to any specific import names and just the pattern itself,
467
+ * report the error and move on
468
+ */
469
+ if (
470
+ !restrictedImportNames &&
471
+ !allowedImportNames &&
472
+ !restrictedImportNamePattern &&
473
+ !allowedImportNamePattern
474
+ ) {
475
+ context.report({
476
+ node,
477
+ messageId: customMessage
478
+ ? "patternWithCustomMessage"
479
+ : "patterns",
480
+ data: {
481
+ importSource,
482
+ customMessage,
483
+ },
484
+ });
485
+ return;
486
+ }
487
+
488
+ importNames.forEach((specifiers, importName) => {
489
+ if (importName === "*") {
490
+ const [specifier] = specifiers;
491
+
492
+ if (restrictedImportNames) {
493
+ context.report({
494
+ node,
495
+ messageId: customMessage
496
+ ? "patternAndEverythingWithCustomMessage"
497
+ : "patternAndEverything",
498
+ loc: specifier.loc,
499
+ data: {
500
+ importSource,
501
+ importNames: restrictedImportNames,
502
+ customMessage,
503
+ },
504
+ });
505
+ } else if (allowedImportNames) {
506
+ context.report({
507
+ node,
508
+ messageId: customMessage
509
+ ? "everythingWithAllowImportNamesAndCustomMessage"
510
+ : "everythingWithAllowImportNames",
511
+ loc: specifier.loc,
512
+ data: {
513
+ importSource,
514
+ allowedImportNames,
515
+ customMessage,
516
+ },
517
+ });
518
+ } else if (allowedImportNamePattern) {
519
+ context.report({
520
+ node,
521
+ messageId: customMessage
522
+ ? "everythingWithAllowedImportNamePatternWithCustomMessage"
523
+ : "everythingWithAllowedImportNamePattern",
524
+ loc: specifier.loc,
525
+ data: {
526
+ importSource,
527
+ allowedImportNamePattern,
528
+ customMessage,
529
+ },
530
+ });
531
+ } else {
532
+ context.report({
533
+ node,
534
+ messageId: customMessage
535
+ ? "patternAndEverythingWithRegexImportNameAndCustomMessage"
536
+ : "patternAndEverythingWithRegexImportName",
537
+ loc: specifier.loc,
538
+ data: {
539
+ importSource,
540
+ importNames: restrictedImportNamePattern,
541
+ customMessage,
542
+ },
543
+ });
544
+ }
545
+
546
+ return;
547
+ }
548
+
549
+ if (
550
+ (restrictedImportNames &&
551
+ restrictedImportNames.includes(importName)) ||
552
+ (restrictedImportNamePattern &&
553
+ restrictedImportNamePattern.test(importName))
554
+ ) {
555
+ specifiers.forEach(specifier => {
556
+ context.report({
557
+ node,
558
+ messageId: customMessage
559
+ ? "patternAndImportNameWithCustomMessage"
560
+ : "patternAndImportName",
561
+ loc: specifier.loc,
562
+ data: {
563
+ importSource,
564
+ customMessage,
565
+ importName,
566
+ },
567
+ });
568
+ });
569
+ }
570
+
571
+ if (
572
+ allowedImportNames &&
573
+ !allowedImportNames.includes(importName)
574
+ ) {
575
+ specifiers.forEach(specifier => {
576
+ context.report({
577
+ node,
578
+ messageId: customMessage
579
+ ? "allowedImportNameWithCustomMessage"
580
+ : "allowedImportName",
581
+ loc: specifier.loc,
582
+ data: {
583
+ importSource,
584
+ customMessage,
585
+ importName,
586
+ allowedImportNames,
587
+ },
588
+ });
589
+ });
590
+ } else if (
591
+ allowedImportNamePattern &&
592
+ !allowedImportNamePattern.test(importName)
593
+ ) {
594
+ specifiers.forEach(specifier => {
595
+ context.report({
596
+ node,
597
+ messageId: customMessage
598
+ ? "allowedImportNamePatternWithCustomMessage"
599
+ : "allowedImportNamePattern",
600
+ loc: specifier.loc,
601
+ data: {
602
+ importSource,
603
+ customMessage,
604
+ importName,
605
+ allowedImportNamePattern,
606
+ },
607
+ });
608
+ });
609
+ }
610
+ });
611
+ }
612
+
613
+ /**
614
+ * Check if the given importSource is restricted by a pattern.
615
+ * @param {string} importSource path of the import
616
+ * @param {Object} group contains a Ignore instance for paths, and the customMessage to show if it fails
617
+ * @returns {boolean} whether the variable is a restricted pattern or not
618
+ * @private
619
+ */
620
+ function isRestrictedPattern(importSource, group) {
621
+ return group.regexMatcher
622
+ ? group.regexMatcher.test(importSource)
623
+ : group.matcher.ignores(importSource);
624
+ }
625
+
626
+ /**
627
+ * Checks a node to see if any problems should be reported.
628
+ * @param {ASTNode} node The node to check.
629
+ * @returns {void}
630
+ * @private
631
+ */
632
+ function checkNode(node) {
633
+ const importSource = node.source.value.trim();
634
+ const importNames = new Map();
635
+
636
+ if (node.type === "ExportAllDeclaration") {
637
+ const starToken = sourceCode.getFirstToken(node, 1);
638
+
639
+ importNames.set("*", [{ loc: starToken.loc }]);
640
+ } else if (node.specifiers) {
641
+ for (const specifier of node.specifiers) {
642
+ let name;
643
+ const specifierData = { loc: specifier.loc };
644
+
645
+ if (specifier.type === "ImportDefaultSpecifier") {
646
+ name = "default";
647
+ } else if (specifier.type === "ImportNamespaceSpecifier") {
648
+ name = "*";
649
+ } else if (specifier.imported) {
650
+ name = astUtils.getModuleExportName(specifier.imported);
651
+ } else if (specifier.local) {
652
+ name = astUtils.getModuleExportName(specifier.local);
653
+ }
654
+
655
+ if (typeof name === "string") {
656
+ if (importNames.has(name)) {
657
+ importNames.get(name).push(specifierData);
658
+ } else {
659
+ importNames.set(name, [specifierData]);
660
+ }
661
+ }
662
+ }
663
+ }
664
+
665
+ checkRestrictedPathAndReport(importSource, importNames, node);
666
+ restrictedPatternGroups.forEach(group => {
667
+ if (isRestrictedPattern(importSource, group)) {
668
+ reportPathForPatterns(node, group, importNames);
669
+ }
670
+ });
671
+ }
672
+
673
+ return {
674
+ ImportDeclaration: checkNode,
675
+ ExportNamedDeclaration(node) {
676
+ if (node.source) {
677
+ checkNode(node);
678
+ }
679
+ },
680
+ ExportAllDeclaration: checkNode,
681
+ };
682
+ },
563
683
  };