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 declaration file #488

Open
brettz9 opened this issue Jul 19, 2024 · 4 comments · May be fixed by #512
Open

add TypeScript declaration file #488

brettz9 opened this issue Jul 19, 2024 · 4 comments · May be fixed by #512
Assignees
@voxpelli
Labels
enhancement

Comments

@brettz9
Copy link
Member

brettz9 commented Jul 19, 2024

Description

Add a TypeScript declaration file.

Steps to Reproduce

  1. Add import promise from 'eslint-plugin-promise'
  2. Hover over eslint-plugin-promise in VSC

Expected behavior: [What you expect to happen]

Get no errors.

Actual behavior: [What actually happens]

Get errors in VSC about TS types
@brettz9 brettz9 mentioned this issue Jul 19, 2024
Closed
@brettz9
Copy link
Member Author

brettz9 commented Jul 19, 2024

Should we go all in with checkJs: true, basically going full JavaScript+JSDoc-as-TypeScript?

@voxpelli
Copy link
Member

Real life example from neostandard: https://github.com/neostandard/neostandard/blob/08ae5469c71def357f0202fed2be9b83f62efc5a/lib/configs/base.js#L5

Should we go all in with checkJs: true, basically going full JavaScript+JSDoc-as-TypeScript?

I have a PR for that in another project, so I’m +1 on it

@brettz9
Copy link
Member Author

brettz9 commented Jul 20, 2024

Will probably wait on #484 to begin any work here, as don't want the tooling to have to be outdated to be supported...

@voxpelli
Copy link
Member

Agree @brettz9 👍 And I think @scagood is also interested in this topic :)

@voxpelli voxpelli self-assigned this Jul 24, 2024
@voxpelli voxpelli linked a pull request Jul 24, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@voxpelli voxpelli

Labels
enhancement
Projects
None yet
Milestone
No milestone
2 participants
@brettz9 @voxpelli