microsoft / microsoft/DefinitelyTyped-tools

Move from internal expect rule to eslint-plugin-expect-type

Open
#858 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
423
Forks
237
Avg merge
18h 18m
Merged PRs (30d)
11

Description

#843 migrated the old TSLint Expect rule to an ESLint rule (🥳!). Great!

There exists a community plugin for roughly the same area of functionality already: https://github.com/JoshuaKGoldberg/eslint-plugin-expect-type [^1]. It would be great if we could use the standard plugin instead. That way bugfixes + features from DT usage can help other community members, and vice versa.

Proposal:

  1. For each bug or feature that is better in this repo, we can file a corresponding issue on eslint-plugin-expect-type
  2. Once those are all fixed up, move to using the external plugin

Per later comments, tracking issues in eslint-plugin-expect-type for missing features:

[^1]: I do feel a bit weird promoting a package with my name on it. If it helps, I didn't create it - just took over maintenance when the previous maintainer didn't have time. If there's a better alternative to eslint-plugin-expect-type that'd be great too!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current internal Expect rule and ESLint setup, then check the three linked eslint-plugin-expect-type tracking issues (#107–#109). Done means those missing features are resolved and this repository uses the external plugin instead.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.