chore: turbo cache build doc

mistic100 · Jan 4, 2024 · 8af584c · 8af584c
1 parent c5d9053
commit 8af584c
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 23 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -98,4 +98,4 @@ jobs:
       - name: build
         run: |
           yarn install
-          yarn doc:build
+          yarn ci:build-doc
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -18,12 +18,12 @@ function listFiles(dir) {
 }
 
 function getFiles(dir) {
-    const absoluteDir = posixJoin(process.cwd(), dir);
+    const absoluteDir = posixJoin(__dirname, '..', dir);
     return listFiles(absoluteDir).map((f) => f.substr(absoluteDir.length + 1));
 }
 
 module.exports = {
-    dest: './public',
+    dest: '../public',
     title: 'Photo Sphere Viewer',
     description: 'A JavaScript library to display Photo Sphere panoramas',
     // prettier-ignore
@@ -124,7 +124,7 @@ module.exports = {
                 {
                     title: 'Official plugins',
                     collapsable: false,
-                    children: getFiles('docs/plugins').filter((f) => {
+                    children: getFiles('plugins').filter((f) => {
                         return f !== 'README.md' && f !== 'writing-a-plugin.md' && f !== 'third-party.md';
                     }),
                 },
@@ -137,7 +137,7 @@ module.exports = {
                     sidebarDepth: 0,
                     collapsable: false,
                     children: (() => {
-                        const demoFiles = getFiles('docs/demos')
+                        const demoFiles = getFiles('demos')
                             .map((f) => f.split('/'))
                             .filter((f) => f.length === 2)
                             .reduce((groups, [dir, file]) => {

diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "photo-sphere-viewer-doc",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "scripts": {
+    "build-doc": "cross-env NODE_OPTIONS=--openssl-legacy-provider vuepress build",
+    "serve-doc": "cross-env NODE_OPTIONS=--openssl-legacy-provider vuepress dev"
+  },
+  "dependencies": {
+    "@vuepress/plugin-active-header-links": "^1.9.9",
+    "@vuepress/plugin-back-to-top": "^1.9.9",
+    "@vuepress/plugin-google-analytics": "^1.9.9",
+    "codesandbox-import-utils": "^2.2.3",
+    "date-fns": "^2.30.0",
+    "lodash": "^4.17.21",
+    "marked": "^4.2.3",
+    "raw-loader": "^4.0.2",
+    "vue-material": "^1.0.0-beta-16",
+    "vue-slider-component": "^3.2.24",
+    "vue-swatches": "^2.1.1",
+    "vuepress": "^1.9.9",
+    "yaml": "^2.3.1"
+  }
+}
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "private": true,
   "license": "MIT",
   "workspaces": [
+    "docs",
     "packages/*"
   ],
   "scripts": {
@@ -14,36 +15,28 @@
     "serve": "turbo run watch --parallel",
     "serve:filter": "run() { turbo run watch --parallel --filter=$1... --filter=//; }; run",
     "npm-link": "turbo run npm-link --output-logs=new-only",
-    "doc:build": "yarn doc:vuepress && yarn doc:typedoc",
-    "doc:typedoc": "node ./build/generate-typedoc-readme.mjs && typedoc --plugin typedoc-plugin-extras --out public/api",
-    "doc:vuepress": "cross-env NODE_OPTIONS=--openssl-legacy-provider vuepress build docs",
-    "doc:serve": "cross-env NODE_OPTIONS=--openssl-legacy-provider vuepress dev docs",
+    "doc:build": "turbo run build-doc",
+    "doc:serve": "turbo run serve-doc",
     "ci:build": "turbo run lint build test --cache-dir=.turbo",
+    "ci:build-doc": "turbo run build-doc --cache-dir=.turbo",
     "ci:version": "set-versions --workspaces",
     "ci:publish": "turbo run publish-dist --concurrency=1",
+    "build-doc": "node ./build/generate-typedoc-readme.mjs && typedoc --plugin typedoc-plugin-extras --out public/api",
     "watch": "node build/liveserver.mjs"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1",
     "@types/three": "^0.159.0",
     "@typescript-eslint/eslint-plugin": "^6.17.0",
     "@typescript-eslint/parser": "^6.17.0",
-    "@vuepress/plugin-active-header-links": "^1.9.9",
-    "@vuepress/plugin-back-to-top": "^1.9.9",
-    "@vuepress/plugin-google-analytics": "^1.9.9",
     "alive-server": "^1.3.0",
-    "codesandbox-import-utils": "^2.2.3",
     "cross-env": "^7.0.3",
-    "date-fns": "^2.30.0",
     "esbuild-plugin-external-global": "^1.0.1",
     "esbuild-sass-plugin": "^2.16.0",
     "eslint": "^8.56.0",
-    "lodash": "^4.17.21",
-    "marked": "^4.2.3",
     "mocha": "^10.2.0",
     "postcss": "^8.4.21",
     "prettier": "^2.8.8",
-    "raw-loader": "^4.0.2",
     "sass": "^1.69.0",
     "scss-bundle": "^3.1.2",
     "set-versions": "^1.0.3",
@@ -57,11 +50,6 @@
     "turbo": "^1.11.1",
     "typedoc": "^0.25.0",
     "typedoc-plugin-extras": "^3.0.0",
-    "typescript": "^5.2.2",
-    "vue-material": "^1.0.0-beta-16",
-    "vue-slider-component": "^3.2.24",
-    "vue-swatches": "^2.1.1",
-    "vuepress": "^1.9.9",
-    "yaml": "^2.3.1"
+    "typescript": "^5.2.2"
   }
 }
diff --git a/turbo.json b/turbo.json
@@ -18,12 +18,19 @@
     "test": {
       "inputs": ["src/**"]
     },
+    "build-doc": {},
+    "//#build-doc": {
+      "dependsOn": ["photo-sphere-viewer-doc#build-doc"]
+    },
     "watch": {
       "cache": false
     },
     "//#watch": {
       "cache": false
     },
+    "serve-doc": {
+      "cache": false
+    },
     "npm-link": {
       "dependsOn": ["build"],
       "cache": false