sindresorhus/eslint-plugin-unicorn

Improve DX around `prefer-global-this` in TypeScript files

Open

#2,488 创建于 2024年10月25日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)JavaScript (5,022 star) (468 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Knowledge of ESLint plugin structureFamiliarity with the prefer global this rule
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
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.