github / github/eslint-plugin-github

Request: Add typescript support

Open
#406 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
336
Forks
67
Avg merge
1d 9h
Merged PRs (30d)
6

Description

I'm working on an addition to [insights-web](https://github.com/github/insights-web) ([PR](https://github.com/github/insights-web/pull/123)) that requires an upgrade to Chart.js 4. Chart.js 4 added typescript `.d.ts` definitions for various exported types. This breaks the GitHub eslint rules because the linter isn't able to resolve the imported types, despite everything compiling correctly. I was able to fix the linting by adding and configuring [eslint-import-resolver-typescript](https://www.npmjs.com/package/eslint-import-resolver-typescript) to the project. I wanted to submit this issue here though because this seems like a better addition to `estlint-plugin-github`, that way we have org-wide TS linting support. There's also an alternative [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) package that claims to be faster than `eslint-plugin-import`.

Contributor guide

Open the contributing guide

Research direction

Review eslint-plugin-github's current dependency and resolver configuration, then compare the proposed eslint-import-resolver-typescript approach with the alternative eslint-plugin-i package. Done means TypeScript .d.ts imports resolve correctly under the plugin's ESLint rules and the existing lint checks pass.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.