sindresorhus/eslint-plugin-unicorn

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

Closed

#2,488 opened on Oct 25, 2024

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees)JavaScript (468 forks)user submission
docsenhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Examine the current implementation of the `prefer global this` rule, identify how TypeScript files are handled, and consider implementing one or more of the suggested improvements: disabling auto fix in TS files, extending the error message, or adding documentation examples.
Tech stack
typescriptjavascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55