FR: generate api json for the typings

[chrisgrieser]

The Obsidian team uses API Extractor to create an api.json from their typings: https://github.com/obsidianmd/obsidian-developer-docs/tree/main/config

It would be very useful if your extended typings would also have a json file, as it would allow people like me to build API searches for that.

I tried to use the API extractor to create the api json myself from your extended typings, but for some reason, the output was lacking the actual content. I am not entirely sure what the reason is, since I think I have set up everything correctly – I suspect that some api-extractor-specific doc comments are missing somewhere in your typings. (see this discord message and a few of the messages above.)

[Fevol]

@chrisgrieser I'm really sorry for the delay with this. In truth, I did try in February to get this working, but I wasn't able to make any progress.

After trying the 2.0.0 release today, it finally does spit out a json.

Could you confirm whether this is already somewhat correct? (There are some warnings I'd still have to fix)

obsidian-typings.api.json

[chrisgrieser]

Well, since I am not really sure what the output is supposed to look like, I cannot really judge whether it's correct. It does appear to be usable though, I guess?

[chrisgrieser]

Before I am able to integrate this in my Alfred workflow, this would need to be available somewhere in the repo though (ideally auto-updated on any changes)

[Fevol]

Before I am able to integrate this in my Alfred workflow, this would need to be available somewhere in the repo though (ideally auto-updated on any changes)

I have added the build set-up, and it should hopefully be added to the assets of the next release. Does fetching from https://github.com/Fevol/obsidian-typings/releases/download/VERSION/obsidian-typings.api.json work for you, or would it have to be in the github repository itself?

[chrisgrieser]

Well, ideally it'd be something like https://github.com/Fevol/obsidian-typings/releases/download/latest/obsidian-typings.api.json, so my workflow does not need to constantly update to accommodate for the typings' updates. (As opposed to linking to releases via latest, downloading assets from a release does not seem to support latest.)

Alternatively, and maybe an even better solution, could be if there was a simple markdown file containing all the changes. Before you started using an index file a few weeks ago, there was simply one big .json file one could open and use cmd+f in. Now, there is no such simple way to search the typings other than installing them via npm I think?