Comments (4)
I think you mixed up VariableStatement and VariableDeclarationList in your example.
VariableDeclarationList never has any JSDoc, because it is located on the VariableStatement.
This function is not intended to find the JSDoc on any parent node. It's just a thin wrapper to make the internal property Node.jsDoc
available to use in your program.
TypeScript never parses JSDoc on VariableDeclaration or VariableDeclarationList. You need to take care of passing the correct node to the function.
If there is the need for a function that retrieves JSDoc for a node the way TypeScript does, I can probably add that on top.
from tsutils.
Yes and yes. The context is TSLint's completed-docs function.
from tsutils.
@JoshuaKGoldberg what would the ideal API look like?
You throw in any Node / (Named)Declaration and get back the JSDoc TypeScript would use?
Should it automatically search for JSDoc on the opposite property accessor?
from tsutils.
IMO yes, but with the caveat that it only looks at the single file (no class inheritance checks or the like). Other than that get
/set
edge case, and parsing through variable statement/declaration/declaration lists, I can't think of other edge cases.
from tsutils.
Related Issues (20)
- feature: hasSuperMethod or isSuperMethodOverride HOT 2
- isValidJsxIdentifier: handle colon as namespace separator
- getJsDoc on EndOfFileToken should return comments usable with TypeChecker HOT 1
- TypeScript as a peerDependency HOT 10
- Bad .d.ts file contents breaking tsc builds
- improve the readme HOT 1
- FIx typescript peer deps
- Add is*Type for newer types such as BigInt and TemplateLiteral? HOT 1
- isPropertyReadonlyInType fails for "interface J extends Readonly<I>"
- tsutils doesn't find typescript in monorepo HOT 1
- make peerDependency on typescript optional HOT 1
- Incorrect result from TSUtils.isTypeAssignableToString/Number
- Help maintaining this project? HOT 3
- `isReadonlyPropertyFromMappedType` throws error when `type.modifiersType` is `undefined`
- no type error when using a default import
- Typescript 5 support? HOT 2
- compile error with `exactOptionalPropertyTypes` compiler option enabled
- Get all identifiers that are typed as `any` in `.js` files.
- Is tsutils no longer maintained? HOT 1
- originalKeywordKind has been deprecated HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tsutils.