mirror of
https://github.com/tridactyl/tridactyl.git
synced 2026-09-10 07:16:33 -04:00
0b6492bd85
Silences the "unknown block tag" warning TypeDoc logged for every @flag/@endflags use, since it didn't recognize them. --blockTags replaces TypeDoc's whole default list rather than appending, so we read the defaults at runtime and re-pass them alongside our two custom tags.
34 lines
1.2 KiB
Bash
Executable file
34 lines
1.2 KiB
Bash
Executable file
#!/bin/sh
|
|
set -e
|
|
|
|
dest=generated/static/docs
|
|
if revision=$(git rev-parse HEAD 2>/dev/null); then
|
|
set -- --basePath src --disableGit --gitRevision "$revision" \
|
|
--sourceLinkTemplate 'https://github.com/tridactyl/tridactyl/blob/{gitRevision}/src/{path}#L{line}'
|
|
else
|
|
set -- --disableSources
|
|
fi
|
|
blockTags=$(node -e '
|
|
import("typedoc").then(async ({ Application }) => {
|
|
const app = await Application.bootstrap({})
|
|
const tags = app.options.getValue("blockTags").filter(t => t !== "@inheritDoc")
|
|
console.log([...tags, "@flag", "@endflags"].join(" "))
|
|
})
|
|
')
|
|
for tag in $blockTags; do
|
|
set -- "$@" --blockTags "$tag"
|
|
done
|
|
"$(yarn bin)/typedoc" --plugin ./scripts/typedoc-theme.mjs \
|
|
--theme tridactyl --router tridactyl \
|
|
"$@" \
|
|
--entryPointStrategy expand --validation.notExported false \
|
|
--excludePrivate false --excludePrivateClassFields false \
|
|
--includeHierarchySummary false \
|
|
--exclude "src/**/?(test_utils|*.test).ts" \
|
|
--out "$dest" src
|
|
for command in next_completion prev_history accept_line; do
|
|
grep -q "id=\"$command\"" "$dest/modules/_src_commandline_frame_.html"
|
|
done
|
|
rm -rf build/static/docs
|
|
cp -r "$dest" build/static/
|