fix: add prebuild:docs script to ensure dependencies are installed (#227

)
skyleague · Dec 27, 2024 · c3b70fb · c3b70fb
1 parent d7357c7
commit c3b70fb
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/reusable-release.yml b/.github/workflows/reusable-release.yml
@@ -108,7 +108,7 @@ jobs:
         env:
           GITHUB_NPM_TOKEN: ${{ secrets.GITHUB_NPM_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - run: node --run build:docs
+      - run: npm run build:docs
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

diff --git a/examples/yargs-cli/package.json b/examples/yargs-cli/package.json
@@ -28,7 +28,8 @@
     "lint:fix": "node --run lint -- --write --unsafe",
     "package": "rm -rf .dist && node --run build",
     "prepare": "husky || true",
-    "test": "vitest run"
+    "test": "vitest run",
+    "prebuild:docs": "npm ci"
   },
   "dependencies": {
     "yargs": "^17.7.2"

diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
   "files": ["bin", ".dist", "biome.json", "package.json", "release.config.cjs", "templates", "examples", "tsconfig.base.json"],
   "scripts": {
     "build": "tsc -p tsconfig.dist.json",
+    "prebuild:docs": "npm ci",
     "build:docs": "npx typedoc",
     "check:coverage": "vitest run --coverage=true",
     "check:project": "node-standards lint",

diff --git a/src/lib/templates/common.ts b/src/lib/templates/common.ts
@@ -23,6 +23,7 @@ export const CommonTypescriptTemplate: ProjectTemplateBuilder = {
         scripts: {
             build: 'tsc -p tsconfig.dist.json',
             'build:clean': undefined,
+            'prebuild:docs': 'npm ci',
             'build:docs': 'npx typedoc',
             'check:cost': undefined,
             'check:coverage': 'vitest run --coverage=true',

diff --git a/src/lib/templates/docusaurus.ts b/src/lib/templates/docusaurus.ts
@@ -7,6 +7,7 @@ export const DocusaurusTemplate: ProjectTemplate = {
     template: {
         repositoryUrl,
         scripts: {
+            'prebuild:docs': undefined,
             'build:docs': 'npm run --prefix=docs build',
         },
         devDependencies: {},