Programmatic access to deno doc --json

[lucacasonato]

Something like this would be nice:

const documentationNodes = Deno.doc("https://deno.land/std/http/server.ts");

It should probably have the same permission model as the compiler API.

[parkerdgabel]

Is anybody working on this? If not I'll do it.

[lucacasonato]

I already have a working branch, just need to do some cleanup and PR it.

[irustm]

@lucacasonato thanks!
any news on this issue? Is there anything I can do to help?

[wperron]

@lucacasonato as I understand it, deno doc is basically emitting a .d.ts annotated with JSdoc correct? following that logic, I think it'd make sense to add this under Deno.emit as a compilerOption rather than introduce another function to the namespace, wdyt?

[bartlomieju]

@lucacasonato as I understand it, deno doc is basically emitting a .d.ts annotated with JSdoc correct? following that logic, I think it'd make sense to add this under Deno.emit as a compilerOption rather than introduce another function to the namespace, wdyt?

No, deno doc emits a string with custom formatting, while deno doc --json emits custom JSON format.

I'm not a fan of adding Deno.doc especially that it will lead to requests to add programatic access to other CLI tools. Maybe Deno.cli that would harbor other subcommands...

[crowlKats]

This can extremely easily be achieved by importing deno_doc from /x; the complexities mentioned in #10731 (comment) in my opinion outweigh the little benefit from having this built-in compared to importing.

[crowlKats]

Closing as this issue predates the possibility to use deno_doc from /x, and as per #10731 (comment) it should be the way to go.