Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add repro #3

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 1 addition & 14 deletions run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,4 @@ set -e
yarn

# Run TypeDoc
yarn typedoc

echo
echo ========================================================
echo

# Print commands before running them, to make CI output easier to understand
set -v

# You can add additional commands here to make assertions on the output,
# if TypeDoc's output doesn't match what you expected. Here's one example
# checking that the name from package.json is used in TypeDoc's output.

test $(jq '.name' docs/docs.json) = '"typedoc-repros"'
yarn typedoc && exit 1 || echo
5 changes: 3 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/**
* Some code reproducing a bug.
* Documented module
* @module
*/
export const bug = 123;
export function foo() {}
6 changes: 6 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"entryPoints": ["src/index.ts"],

"treatWarningsAsErrors": true,
"validation": {
"notDocumented": true
},
"requiredToBeDocumented": [
"Function"
],
"out": "docs",
"json": "docs/docs.json"
}