Skip to content

Commit

Permalink
fixup! chore: Upgrade jsdoc-api to v9
Browse files Browse the repository at this point in the history
  • Loading branch information
avaly committed Sep 17, 2024
1 parent 979c5ff commit e5cc900
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ jobs:
env:
MONGOMS_VERSION: ${{ matrix.mongodb }}

docs:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
filter: tree:0
- uses: pnpm/[email protected]
- uses: actions/[email protected]
with:
node-version-file: 'package.json'
cache: 'pnpm'
- run: pnpm install --frozen-lockfile
- run: pnpm build:docs && git diff

lint:
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion docs/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ for (const doc of DOCS) {

const sourceTranspiled = transpileTS(source);

const jsdoc = jsdocApi.explainSync({ source: sourceTranspiled });
const jsdoc = await jsdocApi.explain({ source: sourceTranspiled });
const parsed = jsdocParse(jsdoc);

const intro = parsed.find((item) => item.kind === 'module' && item.name === 'intro');
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
},
"scripts": {
"build": "./build.sh",
"docs": "node docs/build.js && docsify serve ./docs",
"build:docs": "node docs/build.js",
"docs": "pnpm build:docs && docsify serve ./docs",
"benchmark": "pnpm build && node --experimental-specifier-resolution=node ./benchmark/run.js",
"lint:ci": "./tests/build.sh && eslint .",
"lint": "eslint .",
Expand Down

0 comments on commit e5cc900

Please sign in to comment.