Improve DX around `prefer-global-this` in TypeScript files · sindresorhus/eslint-plugin-unicorn#2488

(0 comments) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission

docsenhancementhelp wanted

説明

A lot of types in the wild are either only set on Window or differ between window.* and globalThis.*. These types are wrong, but they do come up when this rule is applied.

There are a few ways that this rule can help with the migration:

disable the rule's auto-fix in TS files
extend the message to specify how to specify the type
suggest solutions in the rule's readme

Examples:

Originally posted by @fregante in https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2482#issuecomment-2424797467

コントリビューターガイド

技術スタック: typescriptjavascript
領域: developer experiencetooling
Issue 種別: feature
難度: 3
推定時間: 1-3 hours
活動状況: fresh
明確さ: mostly clear
前提条件: Knowledge of ESLint plugin structureFamiliarity with the prefer global this rule
初心者向け度: 60
調査方針: The issue suggests three approaches: disabling auto fix in TS files, extending the message to specify how to fix types, or adding documentation. A good first step is to examine the current rule code at rules/prefer global this.js and its tests. Check whether there is an option to disable auto fix conditionally. Then, implement one of the suggested solutions, such as disallowing auto fix for TypeScript files by detecting file extension or parsing type annotations. Alternatively, improve the error message to guide users on type issues. Update the rule's documentation and README accordingly. The maintainer's comment in the original issue (linked) may provide additional context.