feat: validate type comments and generate .d.ts (take 2) #251
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
fisker approved these changes Apr 11, 2025
scagood approved these changes Apr 11, 2025
scagood left a comment
scagood left a comment There was a problem hiding this comment.
Looks nice to me!
Could we publish a prerelease with this so I can give it a little whirl in https://github.com/eslint-community/eslint-plugin-n? Or do you think its
Comment on lines +2 to +3
| /** @typedef {import("eslint").Scope.Scope} Scope */ | ||
| /** @typedef {import("eslint").Scope.Variable} Variable */ |
There was a problem hiding this comment.
question(non-blocking): Does the @import tag work here?
/** * @import { Scope } from "eslint" * @import { Identifier } from "estree" */ Member Author
There was a problem hiding this comment.
I have tried that already and strangely it shows ts warning as unused.
If I copy this code into an eslint-plugin-n project I get no warnings, so I think it's because this repository uses older TypeScript to support older Node.
Comment on lines +28 to +45
| export type TraceMap<T = unknown> = { | ||
| [i: string]: TraceMapObject<T> | ||
| } | ||
| | ||
| export type TraceMapObject<T> = { | ||
| [i: string]: TraceMapObject<T> | ||
| [CALL]?: T | ||
| [CONSTRUCT]?: T | ||
| [READ]?: T | ||
| [ESM]?: boolean | ||
| } | ||
| | ||
| export type TrackedReferences<T> = { | ||
| info: T | ||
| node: Rule.Node | ||
| path: string[] | ||
| type: typeof CALL | typeof CONSTRUCT | typeof READ | ||
| } |
| 🎉 This PR is included in version 4.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This PR makes the same change as #204 to generate types from JSDoc.
The difference from #204 is that it has been changed to work with Node v12, so there are no breaking changes in this PR.
fixes #150
closes #60
closes #204