Skip to content

Commit 25fe416

Browse files
committed
Update doc server and remove yarnhook
1 parent b8b5ab2 commit 25fe416

File tree

5 files changed

+11
-99
lines changed

5 files changed

+11
-99
lines changed

docs/.vitepress/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// Vitepress config
2+
import pathlib from 'path';
23
import { directoryTreePlugin } from '@sourceacademy/markdown-plugin-directory-tree';
34
import { defineConfig, type UserConfig } from 'vitepress';
45
import { groupIconMdPlugin, groupIconVitePlugin } from 'vitepress-plugin-group-icons';
@@ -23,7 +24,7 @@ const vitepressOptions: UserConfig = {
2324
dirtree: 'yml'
2425
}
2526
},
26-
outDir: `${import.meta.dirname}/../../build/devdocs`,
27+
outDir: pathlib.join(import.meta.dirname, '..', '..', 'build', 'devdocs'),
2728
srcDir: 'src',
2829
title: 'Modules Developer Documentation',
2930
themeConfig: {
@@ -90,7 +91,6 @@ const vitepressOptions: UserConfig = {
9091
}
9192
},
9293
vite: {
93-
// @ts-expect-error something weird going on here
9494
plugins: [groupIconVitePlugin()]
9595
}
9696
};

docs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Modules Documentation Server
2+
3+
Run `yarn dev` to run the development version of the server. If need be, run `yarn build-lib-docs` beforehand to build the
4+
documentation for the modules library.

docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"scripts": {
88
"build": "yarn build-lib-docs && vitepress build .",
99
"build-lib-docs": "yarn workspaces foreach -A --include \"@sourceacademy/modules-lib\" run docs",
10-
"dev": "vitepress dev .",
10+
"dev": "node ./runner.js",
11+
"postinstall": "yarn build-lib-docs",
1112
"preview": "vitepress preview ."
1213
},
1314
"dependencies": {

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@
7676
"typescript": "^5.8.2",
7777
"typescript-eslint": "^8.33.1",
7878
"vitest": "^3.2.3",
79-
"vitest-browser-react": "^1.0.0",
80-
"yarnhook": "^0.6.0"
79+
"vitest-browser-react": "^1.0.0"
8180
},
8281
"dependencies": {
8382
"js-slang": "^1.0.81",

yarn.lock

Lines changed: 2 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -3293,7 +3293,6 @@ __metadata:
32933293
typescript-eslint: "npm:^8.33.1"
32943294
vitest: "npm:^3.2.3"
32953295
vitest-browser-react: "npm:^1.0.0"
3296-
yarnhook: "npm:^0.6.0"
32973296
languageName: unknown
32983297
linkType: soft
32993298

@@ -6552,7 +6551,7 @@ __metadata:
65526551
languageName: node
65536552
linkType: hard
65546553

6555-
"cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.1, cross-spawn@npm:^7.0.6":
6554+
"cross-spawn@npm:^7.0.1, cross-spawn@npm:^7.0.6":
65566555
version: 7.0.6
65576556
resolution: "cross-spawn@npm:7.0.6"
65586557
dependencies:
@@ -8182,23 +8181,6 @@ __metadata:
81828181
languageName: node
81838182
linkType: hard
81848183

8185-
"execa@npm:^4.0.3":
8186-
version: 4.1.0
8187-
resolution: "execa@npm:4.1.0"
8188-
dependencies:
8189-
cross-spawn: "npm:^7.0.0"
8190-
get-stream: "npm:^5.0.0"
8191-
human-signals: "npm:^1.1.1"
8192-
is-stream: "npm:^2.0.0"
8193-
merge-stream: "npm:^2.0.0"
8194-
npm-run-path: "npm:^4.0.0"
8195-
onetime: "npm:^5.1.0"
8196-
signal-exit: "npm:^3.0.2"
8197-
strip-final-newline: "npm:^2.0.0"
8198-
checksum: 10c0/02211601bb1c52710260edcc68fb84c3c030dc68bafc697c90ada3c52cc31375337de8c24826015b8382a58d63569ffd203b79c94fef217d65503e3e8d2c52ba
8199-
languageName: node
8200-
linkType: hard
8201-
82028184
"expand-brackets@npm:^2.1.4":
82038185
version: 2.1.4
82048186
resolution: "expand-brackets@npm:2.1.4"
@@ -8394,13 +8376,6 @@ __metadata:
83948376
languageName: node
83958377
linkType: hard
83968378

8397-
"find-parent-dir@npm:^0.3.1":
8398-
version: 0.3.1
8399-
resolution: "find-parent-dir@npm:0.3.1"
8400-
checksum: 10c0/4817c60ff382a989da31cfa63ac748e6add98433f00a6d236b91d5a23dba8cfc80723b43ff45f47a2dbb54032737dd8643fe12834a60cbee0512021e64bfbf00
8401-
languageName: node
8402-
linkType: hard
8403-
84048379
"find-up@npm:^4.1.0":
84058380
version: 4.1.0
84068381
resolution: "find-up@npm:4.1.0"
@@ -8641,15 +8616,6 @@ __metadata:
86418616
languageName: node
86428617
linkType: hard
86438618

8644-
"get-stream@npm:^5.0.0":
8645-
version: 5.2.0
8646-
resolution: "get-stream@npm:5.2.0"
8647-
dependencies:
8648-
pump: "npm:^3.0.0"
8649-
checksum: 10c0/43797ffd815fbb26685bf188c8cfebecb8af87b3925091dd7b9a9c915993293d78e3c9e1bce125928ff92f2d0796f3889b92b5ec6d58d1041b574682132e0a80
8650-
languageName: node
8651-
linkType: hard
8652-
86538619
"get-symbol-description@npm:^1.1.0":
86548620
version: 1.1.0
86558621
resolution: "get-symbol-description@npm:1.1.0"
@@ -9122,13 +9088,6 @@ __metadata:
91229088
languageName: node
91239089
linkType: hard
91249090

9125-
"human-signals@npm:^1.1.1":
9126-
version: 1.1.1
9127-
resolution: "human-signals@npm:1.1.1"
9128-
checksum: 10c0/18810ed239a7a5e23fb6c32d0fd4be75d7cd337a07ad59b8dbf0794cb0761e6e628349ee04c409e605fe55344716eab5d0a47a62ba2a2d0d367c89a2b4247b1e
9129-
languageName: node
9130-
linkType: hard
9131-
91329091
"husky@npm:^9.1.7":
91339092
version: 9.1.7
91349093
resolution: "husky@npm:9.1.7"
@@ -9593,13 +9552,6 @@ __metadata:
95939552
languageName: node
95949553
linkType: hard
95959554

9596-
"is-stream@npm:^2.0.0":
9597-
version: 2.0.1
9598-
resolution: "is-stream@npm:2.0.1"
9599-
checksum: 10c0/7c284241313fc6efc329b8d7f08e16c0efeb6baab1b4cd0ba579eb78e5af1aa5da11e68559896a2067cd6c526bd29241dda4eb1225e627d5aa1a89a76d4635a5
9600-
languageName: node
9601-
linkType: hard
9602-
96039555
"is-string@npm:^1.0.7, is-string@npm:^1.1.1":
96049556
version: 1.1.1
96059557
resolution: "is-string@npm:1.1.1"
@@ -11129,13 +11081,6 @@ __metadata:
1112911081
languageName: node
1113011082
linkType: hard
1113111083

11132-
"mimic-fn@npm:^2.1.0":
11133-
version: 2.1.0
11134-
resolution: "mimic-fn@npm:2.1.0"
11135-
checksum: 10c0/b26f5479d7ec6cc2bce275a08f146cf78f5e7b661b18114e2506dd91ec7ec47e7a25bf4360e5438094db0560bcc868079fb3b1fb3892b833c1ecbf63f80c95a4
11136-
languageName: node
11137-
linkType: hard
11138-
1113911084
"minimalistic-assert@npm:^1.0.0, minimalistic-assert@npm:^1.0.1":
1114011085
version: 1.0.1
1114111086
resolution: "minimalistic-assert@npm:1.0.1"
@@ -11588,15 +11533,6 @@ __metadata:
1158811533
languageName: node
1158911534
linkType: hard
1159011535

11591-
"npm-run-path@npm:^4.0.0":
11592-
version: 4.0.1
11593-
resolution: "npm-run-path@npm:4.0.1"
11594-
dependencies:
11595-
path-key: "npm:^3.0.0"
11596-
checksum: 10c0/6f9353a95288f8455cf64cbeb707b28826a7f29690244c1e4bb61ec573256e021b6ad6651b394eb1ccfd00d6ec50147253aba2c5fe58a57ceb111fad62c519ac
11597-
languageName: node
11598-
linkType: hard
11599-
1160011536
"number-allocator@npm:^1.0.9":
1160111537
version: 1.0.14
1160211538
resolution: "number-allocator@npm:1.0.14"
@@ -11744,15 +11680,6 @@ __metadata:
1174411680
languageName: node
1174511681
linkType: hard
1174611682

11747-
"onetime@npm:^5.1.0":
11748-
version: 5.1.2
11749-
resolution: "onetime@npm:5.1.2"
11750-
dependencies:
11751-
mimic-fn: "npm:^2.1.0"
11752-
checksum: 10c0/ffcef6fbb2692c3c40749f31ea2e22677a876daea92959b8a80b521d95cca7a668c884d8b2045d1d8ee7d56796aa405c405462af112a1477594cc63531baeb8f
11753-
languageName: node
11754-
linkType: hard
11755-
1175611683
"oniguruma-to-es@npm:^3.1.0":
1175711684
version: 3.1.1
1175811685
resolution: "oniguruma-to-es@npm:3.1.1"
@@ -12010,7 +11937,7 @@ __metadata:
1201011937
languageName: node
1201111938
linkType: hard
1201211939

12013-
"path-key@npm:^3.0.0, path-key@npm:^3.1.0":
11940+
"path-key@npm:^3.1.0":
1201411941
version: 3.1.1
1201511942
resolution: "path-key@npm:3.1.1"
1201611943
checksum: 10c0/748c43efd5a569c039d7a00a03b58eecd1d75f3999f5a28303d75f521288df4823bc057d8784eb72358b2895a05f29a070bc9f1f17d28226cc4e62494cc58c4c
@@ -13875,13 +13802,6 @@ __metadata:
1387513802
languageName: node
1387613803
linkType: hard
1387713804

13878-
"strip-final-newline@npm:^2.0.0":
13879-
version: 2.0.0
13880-
resolution: "strip-final-newline@npm:2.0.0"
13881-
checksum: 10c0/bddf8ccd47acd85c0e09ad7375409d81653f645fda13227a9d459642277c253d877b68f2e5e4d819fe75733b0e626bac7e954c04f3236f6d196f79c94fa4a96f
13882-
languageName: node
13883-
linkType: hard
13884-
1388513805
"strip-json-comments@npm:^3.1.1":
1388613806
version: 3.1.1
1388713807
resolution: "strip-json-comments@npm:3.1.1"
@@ -15414,18 +15334,6 @@ __metadata:
1541415334
languageName: node
1541515335
linkType: hard
1541615336

15417-
"yarnhook@npm:^0.6.0":
15418-
version: 0.6.2
15419-
resolution: "yarnhook@npm:0.6.2"
15420-
dependencies:
15421-
execa: "npm:^4.0.3"
15422-
find-parent-dir: "npm:^0.3.1"
15423-
bin:
15424-
yarnhook: index.js
15425-
checksum: 10c0/5109fbc9c073faed41bc252bb8257d867afb466588a2a09c8b2fbedf8c0b8998a3c72ad847b7f484b59272d40b3928812896c7844120ac365f11c61afd2d4c89
15426-
languageName: node
15427-
linkType: hard
15428-
1542915337
"yocto-queue@npm:^0.1.0":
1543015338
version: 0.1.0
1543115339
resolution: "yocto-queue@npm:0.1.0"

0 commit comments

Comments
 (0)