Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add TypeScript type-checking to all rules #241

Open
bmish opened this issue Oct 7, 2022 · 2 comments
Open

Add TypeScript type-checking to all rules #241

bmish opened this issue Oct 7, 2022 · 2 comments
Labels
chore evaluating help wanted

Comments

@bmish
Copy link
Collaborator

bmish commented Oct 7, 2022

We don't need to convert our JavaScript files to TypeScript, but by adding JSDoc comments with types and using the TypeScript checkJs option, we can get the benefits of type-checking. See this PR for an example and list of benefits: square/eslint-plugin-square#723.
@bmish bmish added the chore label Oct 7, 2022
@platinumazure
Copy link
Owner

I'm on board in principle, but I would want to make sure the developer burden is not significantly increased.

I skimmed the PR but need to look through it more thoroughly.

@platinumazure
Copy link
Owner

@bmish Finally coming back to this... I'm open to this but I have one question. How do we ensure that type info (in doc comments) is added for new code/types? And are there ways to auto-generate at least some of those so the dev experience isn't too annoying?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
chore evaluating help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@platinumazure @bmish