This is better shown using the --lint flag if your library is not 100% documented:
Single file usage
Task lint-docs deno doc --html --lint --name=SLSy --output=./docs ./lib/mod.ts
error[private-type-ref]: public type 'Slsy.prototype.slsy' references private type 'Request'
--> ./lib/mod.ts:77:5
|
77 | public slsy(request: Request, response: Response): Response {
| ^
= hint: make the referenced type public or remove the reference
|
38 | export class Request {
| - this is the referenced type
info: to ensure documentation is complete all types that are exposed in the public API must be public
error[private-type-ref]: public type 'Slsy.prototype.slsy' references private type 'Response'
--> ./lib/mod.ts:77:5
|
77 | public slsy(request: Request, response: Response): Response {
| ^
= hint: make the referenced type public or remove the reference
|
113 | export class Response {
| - this is the referenced type
info: to ensure documentation is complete all types that are exposed in the public API must be public
error: Found 2 documentation lint errors.
Multi file usage
Here Deno just goes blind:
Task lint-docs deno doc --html --lint --name=SLSy --output=./docs ./lib/mod.ts ./types/mod.ts
Written 70 files to "./docs"
I also noticed running the command multiple times results in different results without touching code at all. Here's a screenshot for proof:
I modified my deno.json to print the time when the commands were excecuted:
I checked this with the following variations:
Using --lint and omitting --lint
Terminal Command (Just in case it was the name="" section)
deno.json task.
Regexps/patterns to include all .ts files (Didn't work)
System information
Deno 1.43.6 installed from Deno website
OS: Gnu/Linux x86_64
I read some issues here but couldn't find something similar. I did not read all issues though.
I suspected this was due to my library desing where lib/ and types/ were in the same level. After adjusting it to lib/ and lib/types/ the reproducibility error is still present.
The website that shows basic usage for
deno doc
shows the following example:Which “supposedly” generates the HTML documentation for such two mod files. This doesn't happen when using the following command:
For a single file the command works fine:
Problem starts when using more than one file to generate docs:
This is better shown using the
--lint
flag if your library is not 100% documented:Single file usage
Multi file usage
Here Deno just goes blind:
I also noticed running the command multiple times results in different results without touching code at all. Here's a screenshot for proof:
I checked this with the following variations:
--lint
and omitting--lint
name=""
section)deno.json
task..ts
files (Didn't work)System information
1.43.6
installed from Deno websiteI read some issues here but couldn't find something similar. I did not read all issues though.
Any ideas on how to fix this? :thinking: