source-academy / js-slang / 35620323934

86%

push

github

ci: restore the `jsdoc` script, fixing the docs deploy (#2074)

deploy-docs.yml has been failing since #2070:

  ERROR: Unable to find the source file or directory .../prepare
  There are no input files to process.

That workflow runs `yarn run jsdoc prepare`. #2070 removed the `jsdoc`
script from package.json, so yarn fell through to the jsdoc *binary*
(still a devDependency) and handed it `prepare` as a filename.

The documentation this publishes to docs.sourceacademy.org is the
*language* documentation — the Source specs and stdlib reference. It is
a separate product from the runner, and making js-slang Conductor-only
should not have taken it out. I removed the script along with the rest
of the non-Conductor surface without checking which workflows used it,
having already fixed nodejs.yml and deploy-evaluators.yml and assumed
those were all of them.

`scripts/docs.mjs` was never deleted, so restoring the entry point is
enough. Its `autocomplete` and `docs` subcommands are dropped, along
with scripts/autocomplete.mjs: both existed only to regenerate
src/editors/ace/docTooltip, the Ace tooltip data the frontend used to
import, and #2070 deleted that directory. `run`, `prepare` and `clean`
— the ones that build the published docs — are untouched.

Verified by running exactly what the workflow runs, from a deleted
docs/source: `yarn jsdoc prepare` exits 0 and repopulates it.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

2225 of 2722 branches covered (81.74%)

Branch coverage included in aggregate %.

4385 of 5066 relevant lines covered (86.56%)

369570.5 hits per line