vitepress 0.22.3 → 1.0.0-draft.2

package/dist/node/staticDataPlugin.js

@@ -0,0 +1,99 @@
+"use strict";
+// TODO figure out why it causes full page reload
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.staticDataPlugin = void 0;
+const vite_1 = require("vite");
+const path_1 = require("path");
+const micromatch_1 = require("micromatch");
+const loaderMatch = /\.data\.(j|t)s$/;
+let server;
+const idToLoaderModulesMap = Object.create(null);
+// During build, the load hook will be called on the same file twice
+// once for client and once for server build. Not only is this wasteful, it
+// also leads to a race condition in loadConfigFromFile() that results in an
+// fs unlink error. So we reuse the same Promise during build to avoid double
+// loading.
+let idToPendingPromiseMap = Object.create(null);
+let isBuild = false;
+exports.staticDataPlugin = {
+    name: 'vitepress:data',
+    configResolved(config) {
+        isBuild = config.command === 'build';
+    },
+    configureServer(_server) {
+        server = _server;
+    },
+    async load(id) {
+        var _a;
+        if (loaderMatch.test(id)) {
+            let _resolve;
+            if (isBuild) {
+                if (idToPendingPromiseMap[id]) {
+                    return idToPendingPromiseMap[id];
+                }
+                idToPendingPromiseMap[id] = new Promise((r) => {
+                    _resolve = r;
+                });
+            }
+            const base = (0, path_1.dirname)(id);
+            let pattern;
+            let loader;
+            const existing = idToLoaderModulesMap[id];
+            if (existing) {
+                ;
+                ({ pattern, loader } = existing);
+            }
+            else {
+                // use vite's load config util as a away to load Node.js file with
+                // TS & native ESM support
+                const loaderModule = (_a = (await (0, vite_1.loadConfigFromFile)({}, id))) === null || _a === void 0 ? void 0 : _a.config;
+                pattern =
+                    typeof loaderModule.watch === 'string'
+                        ? [loaderModule.watch]
+                        : loaderModule.watch;
+                if (pattern) {
+                    pattern = pattern.map((p) => {
+                        return p.startsWith('./') ? p.slice(2) : p;
+                    });
+                }
+                loader = loaderModule.load;
+            }
+            // load the data
+            const data = await loader();
+            // record loader module for HMR
+            if (server) {
+                idToLoaderModulesMap[id] = { base, pattern, loader };
+            }
+            const result = `export const data = JSON.parse(${JSON.stringify(JSON.stringify(data))})`;
+            if (_resolve)
+                _resolve(result);
+            return result;
+        }
+    },
+    transform(_code, id) {
+        if (server && loaderMatch.test(id)) {
+            // register this module as a glob importer
+            const { base, pattern } = idToLoaderModulesMap[id];
+            server._globImporters[id] = {
+                module: server.moduleGraph.getModuleById(id),
+                importGlobs: pattern === null || pattern === void 0 ? void 0 : pattern.map((pattern) => ({ base, pattern }))
+            };
+        }
+        return null;
+    },
+    handleHotUpdate(ctx) {
+        for (const id in idToLoaderModulesMap) {
+            const { base, pattern } = idToLoaderModulesMap[id];
+            const isLoaderFile = (0, vite_1.normalizePath)(ctx.file) === id;
+            if (isLoaderFile) {
+                // invalidate loader file
+                delete idToLoaderModulesMap[id];
+            }
+            if (isLoaderFile ||
+                (pattern && (0, micromatch_1.isMatch)((0, path_1.relative)(base, ctx.file), pattern))) {
+                ctx.modules.push(server.moduleGraph.getModuleById(id));
+            }
+        }
+    }
+};
+//# sourceMappingURL=staticDataPlugin.js.map

package/dist/node/staticDataPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticDataPlugin.js","sourceRoot":"","sources":["../../src/node/staticDataPlugin.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAEjD,+BAA+E;AAC/E,+BAAwC;AACxC,2CAAoC;AAEpC,MAAM,WAAW,GAAG,iBAAiB,CAAA;AAErC,IAAI,MAAqB,CAAA;AAazB,MAAM,oBAAoB,GACxB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;AAErB,oEAAoE;AACpE,2EAA2E;AAC3E,4EAA4E;AAC5E,6EAA6E;AAC7E,WAAW;AACX,IAAI,qBAAqB,GACvB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;AACrB,IAAI,OAAO,GAAG,KAAK,CAAA;AAEN,QAAA,gBAAgB,GAAW;IACtC,IAAI,EAAE,gBAAgB;IAEtB,cAAc,CAAC,MAAM;QACnB,OAAO,GAAG,MAAM,CAAC,OAAO,KAAK,OAAO,CAAA;IACtC,CAAC;IAED,eAAe,CAAC,OAAO;QACrB,MAAM,GAAG,OAAO,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE;;QACX,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YACxB,IAAI,QAA0C,CAAA;YAC9C,IAAI,OAAO,EAAE;gBACX,IAAI,qBAAqB,CAAC,EAAE,CAAC,EAAE;oBAC7B,OAAO,qBAAqB,CAAC,EAAE,CAAC,CAAA;iBACjC;gBACD,qBAAqB,CAAC,EAAE,CAAC,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC5C,QAAQ,GAAG,CAAC,CAAA;gBACd,CAAC,CAAC,CAAA;aACH;YAED,MAAM,IAAI,GAAG,IAAA,cAAO,EAAC,EAAE,CAAC,CAAA;YACxB,IAAI,OAA6B,CAAA;YACjC,IAAI,MAAiB,CAAA;YAErB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,EAAE,CAAC,CAAA;YACzC,IAAI,QAAQ,EAAE;gBACZ,CAAC;gBAAA,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAA;aAClC;iBAAM;gBACL,kEAAkE;gBAClE,0BAA0B;gBAC1B,MAAM,YAAY,GAAG,MAAA,CAAC,MAAM,IAAA,yBAAkB,EAAC,EAAS,EAAE,EAAE,CAAC,CAAC,0CAC1D,MAAsB,CAAA;gBAC1B,OAAO;oBACL,OAAO,YAAY,CAAC,KAAK,KAAK,QAAQ;wBACpC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;wBACtB,CAAC,CAAC,YAAY,CAAC,KAAK,CAAA;gBACxB,IAAI,OAAO,EAAE;oBACX,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;wBAC1B,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC5C,CAAC,CAAC,CAAA;iBACH;gBACD,MAAM,GAAG,YAAY,CAAC,IAAI,CAAA;aAC3B;YAED,gBAAgB;YAChB,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE,CAAA;YAE3B,+BAA+B;YAC/B,IAAI,MAAM,EAAE;gBACV,oBAAoB,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;aACrD;YAED,MAAM,MAAM,GAAG,kCAAkC,IAAI,CAAC,SAAS,CAC7D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACrB,GAAG,CAAA;YAEJ,IAAI,QAAQ;gBAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC9B,OAAO,MAAM,CAAA;SACd;IACH,CAAC;IAED,SAAS,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAClC,0CAA0C;YAC1C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,EAAE,CAAE,CAClD;YAAC,MAAc,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG;gBACpC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC5C,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aAC5D,CAAA;SACF;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,eAAe,CAAC,GAAG;QACjB,KAAK,MAAM,EAAE,IAAI,oBAAoB,EAAE;YACrC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,EAAE,CAAE,CAAA;YACnD,MAAM,YAAY,GAAG,IAAA,oBAAa,EAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;YACnD,IAAI,YAAY,EAAE;gBAChB,yBAAyB;gBACzB,OAAO,oBAAoB,CAAC,EAAE,CAAC,CAAA;aAChC;YACD,IACE,YAAY;gBACZ,CAAC,OAAO,IAAI,IAAA,oBAAO,EAAC,IAAA,eAAQ,EAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,EACvD;gBACA,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAE,CAAC,CAAA;aACxD;SACF;IACH,CAAC;CACF,CAAA"}

package/dist/node/utils/getGitTimestamp.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGitTimestamp = void 0;
+const cross_spawn_1 = require("cross-spawn");
+function getGitTimestamp(file) {
+    return new Promise((resolve, reject) => {
+        const child = (0, cross_spawn_1.spawn)('git', ['log', '-1', '--pretty="%ci"', file]);
+        let output = '';
+        child.stdout.on('data', (d) => (output += String(d)));
+        child.on('close', () => {
+            resolve(+new Date(output));
+        });
+        child.on('error', reject);
+    });
+}
+exports.getGitTimestamp = getGitTimestamp;
+//# sourceMappingURL=getGitTimestamp.js.map

package/dist/node/utils/getGitTimestamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getGitTimestamp.js","sourceRoot":"","sources":["../../../src/node/utils/getGitTimestamp.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AAEnC,SAAgB,eAAe,CAAC,IAAY;IAC1C,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC7C,MAAM,KAAK,GAAG,IAAA,mBAAK,EAAC,KAAK,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAA;QACjE,IAAI,MAAM,GAAG,EAAE,CAAA;QACf,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACrB,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QACF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC3B,CAAC,CAAC,CAAA;AACJ,CAAC;AAVD,0CAUC"}

package/dist/node/utils/parseHeader.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deeplyParseHeader = exports.parseHeader = exports.removeNonCodeWrappedHTML = void 0;
+// Since VuePress needs to extract the header from the markdown source
+// file and display it in the sidebar or title (#238), this file simply
+// removes some unnecessary elements to make header displays well at
+// sidebar or title.
+//
+// But header's parsing in the markdown content is done by the markdown
+// loader based on markdown-it. markdown-it parser will will always keep
+// HTML in headers, so in VuePress, after being parsed by the markdown
+// loader, the raw HTML in headers will finally be parsed by Vue-loader.
+// so that we can write HTML/Vue in the header. One exception is the HTML
+// wrapped by <code>(markdown token: '`') tag.
+const full_json_1 = __importDefault(require("markdown-it-emoji/lib/data/full.json"));
+const parseEmojis = (str) => {
+    return str.replace(/:(.+?):/g, (placeholder, key) => full_json_1.default[key] || placeholder);
+};
+const unescapeHtml = (html) => html
+    .replace(/&quot;/g, '"')
+    .replace(/&#39;/g, "'")
+    .replace(/&#x3A;/g, ':')
+    .replace(/&lt;/g, '<')
+    .replace(/&gt;/g, '>');
+const removeMarkdownTokens = (str) => str
+    .replace(/(\[(.[^\]]+)\]\((.[^)]+)\))/g, '$2') // []()
+    .replace(/(`|\*{1,3}|_)(.*?[^\\])\1/g, '$2') // `{t}` | *{t}* | **{t}** | ***{t}*** | _{t}_
+    .replace(/(\\)(\*|_|`|\!|<|\$)/g, '$2'); // remove escape char '\'
+const remvoeCustomAnchor = (str) => str.replace(/\{#([a-z0-9\-_]+?)\}\s*$/, ''); // {#custom-header}
+const trim = (str) => str.trim();
+// This method remove the raw HTML but reserve the HTML wrapped by `<code>`.
+// e.g.
+// Input: "<a> b",   Output: "b"
+// Input: "`<a>` b", Output: "`<a>` b"
+const removeNonCodeWrappedHTML = (str) => {
+    return String(str).replace(/(^|[^><`\\])<.*>([^><`]|$)/g, '$1$2');
+};
+exports.removeNonCodeWrappedHTML = removeNonCodeWrappedHTML;
+const compose = (...processors) => {
+    if (processors.length === 0)
+        return (input) => input;
+    if (processors.length === 1)
+        return processors[0];
+    return processors.reduce((prev, next) => {
+        return (str) => next(prev(str));
+    });
+};
+// Unescape html, parse emojis and remove some md tokens.
+exports.parseHeader = compose(unescapeHtml, parseEmojis, remvoeCustomAnchor, removeMarkdownTokens, trim);
+// Also clean the html that isn't wrapped by code.
+// Because we want to support using VUE components in headers.
+// e.g. https://vuepress.vuejs.org/guide/using-vue.html#badge
+exports.deeplyParseHeader = compose(exports.removeNonCodeWrappedHTML, exports.parseHeader);
+//# sourceMappingURL=parseHeader.js.map

package/dist/node/utils/parseHeader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseHeader.js","sourceRoot":"","sources":["../../../src/node/utils/parseHeader.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAsE;AACtE,uEAAuE;AACvE,oEAAoE;AACpE,oBAAoB;AACpB,EAAE;AACF,uEAAuE;AACvE,wEAAwE;AACxE,sEAAsE;AACtE,wEAAwE;AACxE,yEAAyE;AACzE,8CAA8C;AAC9C,qFAA4D;AAE5D,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE;IAClC,OAAO,GAAG,CAAC,OAAO,CAChB,UAAU,EACV,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,CAAC,mBAAS,CAAC,GAAG,CAAC,IAAI,WAAW,CACpD,CAAA;AACH,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE,CACpC,IAAI;KACD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;KACvB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;KACtB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;KACvB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;KACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;AAE1B,MAAM,oBAAoB,GAAG,CAAC,GAAW,EAAE,EAAE,CAC3C,GAAG;KACA,OAAO,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC,OAAO;KACrD,OAAO,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC,8CAA8C;KAC1F,OAAO,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA,CAAC,yBAAyB;AAErE,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE,CACzC,GAAG,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAA,CAAC,mBAAmB;AAEjE,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;AAExC,4EAA4E;AAC5E,OAAO;AACP,gCAAgC;AAChC,sCAAsC;AAC/B,MAAM,wBAAwB,GAAG,CAAC,GAAW,EAAE,EAAE;IACtD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAA;AACnE,CAAC,CAAA;AAFY,QAAA,wBAAwB,4BAEpC;AAED,MAAM,OAAO,GAAG,CAAC,GAAG,UAAuC,EAAE,EAAE;IAC7D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAA;IAC5D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAA;IACjD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACtC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACjC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,yDAAyD;AAC5C,QAAA,WAAW,GAAG,OAAO,CAChC,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,IAAI,CACL,CAAA;AAED,kDAAkD;AAClD,8DAA8D;AAC9D,6DAA6D;AAChD,QAAA,iBAAiB,GAAG,OAAO,CAAC,gCAAwB,EAAE,mBAAW,CAAC,CAAA"}

package/dist/node/utils/slash.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slash = void 0;
+function slash(p) {
+    return p.replace(/\\/g, '/');
+}
+exports.slash = slash;
+//# sourceMappingURL=slash.js.map

package/dist/node/utils/slash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slash.js","sourceRoot":"","sources":["../../../src/node/utils/slash.ts"],"names":[],"mappings":";;;AAAA,SAAgB,KAAK,CAAC,CAAS;IAC7B,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AAC9B,CAAC;AAFD,sBAEC"}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "vitepress",
-  "version": "0.22.3",
+  "version": "1.0.0-draft.2",
+  "packageManager": "pnpm@7.0.1",
   "description": "Vite & Vue powered static site generator",
   "main": "dist/node/index.js",
   "typings": "types/index.d.ts",
@@ -14,20 +15,6 @@
     "client.d.ts",
     "theme.d.ts"
   ],
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "gitHooks": {
-    "pre-commit": "lint-staged"
-  },
-  "lint-staged": {
-    "*.js": [
-      "prettier --write"
-    ],
-    "*.ts": [
-      "prettier --parser=typescript --write"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuejs/vitepress.git"
@@ -39,24 +26,41 @@
   ],
   "author": "Evan You",
   "license": "MIT",
-  "homepage": "https://github.com/vuejs/vitepress/tree/master/#readme",
+  "homepage": "https://github.com/vuejs/vitepress/tree/main/#readme",
   "bugs": {
     "url": "https://github.com/vuejs/vitepress/issues"
   },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged"
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write"
+    ],
+    "*.ts": [
+      "prettier --parser=typescript --write"
+    ]
+  },
   "dependencies": {
-    "@docsearch/css": "^3.0.0-alpha.41",
-    "@docsearch/js": "^3.0.0-alpha.41",
-    "@vitejs/plugin-vue": "^2.2.0",
+    "@docsearch/css": "^3.0.0",
+    "@docsearch/js": "^3.0.0",
+    "@vitejs/plugin-vue": "^2.3.2",
+    "@vueuse/core": "^8.5.0",
+    "body-scroll-lock": "^4.0.0-beta.0",
     "prismjs": "^1.25.0",
-    "vite": "^2.8.1",
-    "vue": "^3.2.31"
+    "vite": "^2.9.7",
+    "vue": "3.2.33"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.9",
+    "@microsoft/api-extractor": "^7.23.1",
     "@rollup/plugin-alias": "^3.1.5",
     "@rollup/plugin-commonjs": "^20.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.4",
+    "@types/body-scroll-lock": "^3.1.0",
     "@types/compression": "^1.7.0",
     "@types/cross-spawn": "^6.0.2",
     "@types/debug": "^4.1.7",
@@ -66,6 +70,7 @@
     "@types/lru-cache": "^5.1.0",
     "@types/markdown-it": "^12.0.1",
     "@types/micromatch": "^4.0.2",
+    "@types/minimist": "^1.2.2",
     "@types/node": "^15.6.1",
     "@types/polka": "^0.5.3",
     "chalk": "^4.1.1",
@@ -102,8 +107,8 @@
     "rollup-plugin-esbuild": "^4.8.2",
     "semver": "^7.3.5",
     "sirv": "^1.0.12",
-    "typescript": "^4.3.2",
-    "vitest": "^0.1.19",
+    "typescript": "^4.6.4",
+    "vitest": "^0.10.4",
     "yorkie": "^2.0.0"
   },
   "scripts": {
@@ -124,12 +129,13 @@
     "lint:js": "prettier --check --write \"{bin,docs,scripts,src}/**/*.js\"",
     "lint:ts": "prettier --check --write --parser typescript \"{__tests__,src,docs,types}/**/*.ts\"",
     "test": "vitest run __tests__ -c __tests__/vitest.config.js --global",
+    "test:all": "run-s lint test",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "release": "node scripts/release.js",
     "docs": "run-p dev docs-dev",
     "docs-dev": "node ./bin/vitepress dev docs",
     "docs-debug": "node --inspect-brk ./bin/vitepress dev docs",
-    "docs-build": "npm run build && node ./bin/vitepress build docs",
+    "docs-build": "run-s build docs-build-only",
     "docs-build-only": "node ./bin/vitepress build docs",
     "docs-serve": "node ./bin/vitepress serve docs",
     "ci-docs": "run-s build docs-build"

package/types/default-theme.d.ts

@@ -1,127 +1,170 @@
 export namespace DefaultTheme {
   export interface Config {
-    logo?: string
-    nav?: NavItem[] | false
-    sidebar?: SideBarConfig | MultiSideBarConfig
-
     /**
-     * GitHub repository following the format <user>/<project>.
+     * The logo file of the site.
      *
-     * @example `"vuejs/vue-next"`
+     * @example '/logo.svg'
      */
-    repo?: string
+    logo?: string
 
     /**
-     * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
-     * depending on the provided repo.
-     *
-     * @example `"Contribute!"`
+     * The nav items.
      */
-    repoLabel?: string
+    nav?: NavItem[]
 
     /**
-     * If your docs are in a different repository from your main project.
-     *
-     * @example `"vuejs/docs-next"`
+     * The sidebar items.
      */
-    docsRepo?: string
+    sidebar?: Sidebar
 
     /**
-     * If your docs are not at the root of the repo.
-     *
-     * @example `"docs"`
+     * Info for the edit link. If it's undefined, the edit link feature will
+     * be disabled.
      */
-    docsDir?: string
+    editLink?: EditLink
 
     /**
-     * If your docs are in a different branch. Defaults to `master`.
-     *
-     * @example `"next"`
+     * The social links to be displayed at the end of the nav bar. Perfect for
+     * placing links to social services such as GitHub, Twitter, Facebook, etc.
      */
-    docsBranch?: string
+    socialLinks?: SocialLink[]
 
     /**
-     * Enable links to edit pages at the bottom of the page.
+     * The footer configuration.
      */
-    editLinks?: boolean
+    footer?: Footer
 
     /**
-     * Custom text for edit link. Defaults to "Edit this page".
+     * Adds locale menu to the nav. This option should be used when you have
+     * your translated sites outside of the project.
      */
-    editLinkText?: string
+    localeLinks?: LocaleLinks
 
     /**
-     * Show last updated time at the bottom of the page. Defaults to `false`.
-     * If given a string, it will be displayed as a prefix (default value:
-     * "Last Updated").
+     * The algolia options. Leave it undefined to disable the search feature.
      */
-    lastUpdated?: string | boolean
-
-    prevLinks?: boolean
-    nextLinks?: boolean
-
-    locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
-
     algolia?: AlgoliaSearchOptions
 
-    carbonAds?: {
-      carbon: string
-      custom?: string
-      placement: string
-    }
+    /**
+     * The carbon ads options. Leave it undefined to disable the ads feature.
+     */
+    carbonAds?: CarbonAdsOptions
   }
 
-  // navbar --------------------------------------------------------------------
+  // nav -----------------------------------------------------------------------
 
   export type NavItem = NavItemWithLink | NavItemWithChildren
 
-  export interface NavItemBase {
+  export type NavItemWithLink = {
     text: string
-    target?: string
-    rel?: string
-    ariaLabel?: string
-    activeMatch?: string
-  }
-
-  export interface NavItemWithLink extends NavItemBase {
     link: string
+
+    /**
+     * `activeMatch` is expected to be a regex string. We can't use actual
+     * RegExp object here because it isn't serializable
+     */
+    activeMatch?: string
   }
 
-  export interface NavItemWithChildren extends NavItemBase {
+  export interface NavItemWithChildren {
+    text?: string
     items: NavItemWithLink[]
   }
 
   // sidebar -------------------------------------------------------------------
 
-  export type SideBarConfig = SideBarItem[] | 'auto' | false
+  export type Sidebar = SidebarGroup[] | SidebarMulti
 
-  export interface MultiSideBarConfig {
-    [path: string]: SideBarConfig
+  export interface SidebarMulti {
+    [path: string]: SidebarGroup[]
   }
 
-  export type SideBarItem = SideBarLink | SideBarGroup
+  export interface SidebarGroup {
+    text: string
+    items: SidebarItem[]
+  }
 
-  export interface SideBarLink {
+  export interface SidebarItem {
     text: string
     link: string
   }
 
-  export interface SideBarGroup {
-    text: string
-    link?: string
+  // edit link -----------------------------------------------------------------
+
+  export interface EditLink {
+    /**
+     * Repo of the site.
+     *
+     * @example 'vuejs/docs'
+     */
+    repo: string
+
+    /**
+     * Branch of the repo.
+     *
+     * @default 'main'
+     */
+    branch?: string
 
     /**
-     * @default false
+     * If your docs are not at the root of the repo.
+     *
+     * @example 'docs'
      */
-    collapsable?: boolean
+    dir?: string
 
-    children: SideBarItem[]
+    /**
+     * Custom text for edit link.
+     *
+     * @default 'Edit this page'
+     */
+    text?: string
   }
 
-  // algolia  ------------------------------------------------------------------
-  // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+  // social link ---------------------------------------------------------------
+
+  export interface SocialLink {
+    icon: SocialLinkIcon
+    link: string
+  }
+
+  export type SocialLinkIcon =
+    | 'discord'
+    | 'facebook'
+    | 'github'
+    | 'instagram'
+    | 'linkedin'
+    | 'slack'
+    | 'twitter'
+    | 'youtube'
+
+  // footer --------------------------------------------------------------------
+
+  export interface Footer {
+    message?: string
+    copyright?: string
+  }
+
+  // locales -------------------------------------------------------------------
+
+  export interface LocaleLinks {
+    text: string
+    items: LocaleLink[]
+  }
+
+  export interface LocaleLink {
+    text: string
+    link: string
+  }
+
+  // algolia ------------------------------------------------------------------
+
+  /**
+   * The Algolia search options. Partially copied from
+   * `@docsearch/react/dist/esm/DocSearch.d.ts`
+   */
   export interface AlgoliaSearchOptions {
-    appId?: string
+    appId: string
     apiKey: string
     indexName: string
     placeholder?: string
@@ -130,17 +173,11 @@ export namespace DefaultTheme {
     initialQuery?: string
   }
 
-  // locales -------------------------------------------------------------------
+  // carbon ads ----------------------------------------------------------------
 
-  export interface LocaleConfig {
-    /**
-     * Text for the language dropdown.
-     */
-    selectText?: string
-
-    /**
-     * Label for this locale in the language dropdown.
-     */
-    label?: string
+  export interface CarbonAdsOptions {
+    carbon: string
+    custom?: string
+    placement: string
   }
 }

package/types/shared.d.ts

@@ -11,19 +11,30 @@ export interface PageData {
   lastUpdated?: number
 }
 
+export interface Header {
+  level: number
+  title: string
+  slug: string
+}
+
 export interface SiteData<ThemeConfig = any> {
   base: string
+
   /**
    * Language of the site as it should be set on the `html` element.
+   *
    * @example `en-US`, `zh-CN`
    */
   lang: string
+
   title: string
   description: string
   head: HeadConfig[]
+  appearance: boolean
   themeConfig: ThemeConfig
   scrollOffset: number | string
   locales: Record<string, LocaleConfig>
+
   /**
    * Available locales for the site when it has defined `locales` in its
    * `themeConfig`. This object is otherwise empty. Keys are paths like `/` or
@@ -50,12 +61,6 @@ export type HeadConfig =
   | [string, Record<string, string>]
   | [string, Record<string, string>, string]
 
-export interface Header {
-  level: number
-  title: string
-  slug: string
-}
-
 export interface LocaleConfig {
   lang: string
   title?: string