[apiview-js-parser] migrate to the new tree token #9034
Conversation
- build output to ./dist - add eslint, prettier - add v2 generation side-by-side in generate.ts and jstokens.ts
and build release tags
There was a problem hiding this comment.
This is an awesome improvement - and I like the way you structured the code. I only have two asks (neither is blocking)
- Would you mind adding some documentation: either a md file with your understanding of the flow and how APIView gets generated (kinda like an architecture.md doc) or just doc-comments throughout the code
- Any chance we can get a screenshot or gif? I am very curious what the new stuff looks like
My only reasoning for (1) is that this stuff looks complex, and the old code was complex (took me a while to even understand it!), so it would be great to get all the context you picked up out of your head and onto paper while it's still fresh
| } | ||
| } | ||
|
|
||
| let name = apiModel.packages[0].name; |
There was a problem hiding this comment.
Maybe we can have a helper function that encapsulates the building of name + the logic to get the version from the filename? It'll just be easier understand it
It could even be const { packageName, packageVersion } = parseFileName(fileName) or something
There was a problem hiding this comment.
The name is from apiModel so it is not just from fileName, but I tried some refactoring.
| const dependencies = apiJson.metadata.dependencies; | ||
|
|
||
| const result = JSON.stringify( | ||
| GenerateApiview({ |
There was a problem hiding this comment.
I am so sorry for the nitpicky comment but functions are usually camelCase 🙈
There was a problem hiding this comment.
I do not know why it is capitalized!
|
|
||
| function buildDocumentation(reviewLines: ReviewLine[], member: ApiItem, relatedTo: string) { | ||
| if (member instanceof ApiDocumentedItem) { | ||
| const lines = member.tsdocComment?.emitAsTsdoc().split("\n"); |
There was a problem hiding this comment.
Does this add doc-comments to the APIView? 😍
There was a problem hiding this comment.
Yes based on my understanding. It will add whatever ref docs included in the api.json. By default it is hidden.
| import jsTokens from "js-tokens"; | ||
| import { type ReviewToken, TokenKind } from "./models"; | ||
|
|
||
| const TS_KEYWORDS = new Set<string>([ |
There was a problem hiding this comment.
Where did this list come from and what does it impact? Just colorization? Or something else
There was a problem hiding this comment.
I should link to it in a comment https://github.com/microsoft/TypeScript/blob/aa9df4d68795052d1681ac7dc5f66d6362c3f3cb/src/compiler/scanner.ts#L135
There was a problem hiding this comment.
yes I think so, colorization for keywords in apiview.
Good point! I will add a README.md
I have not seen it in the UI either, hopefully soon though |
- refactoring
- refactoring - add ref docs
- replace "export declare function" with "export function"
Migrate to the new tree token based scheme. While at it, also