rspress 2.0.0-beta.2 → 2.0.0-beta.21

package/README.md

@@ -1,14 +1,14 @@
 # Rspress
 
 <picture>
-  <img alt="Rspress Banner" src="https://assets.rspack.dev/rspress/rspress-banner.png">
+  <img alt="Rspress Banner" src="https://assets.rspack.rs/rspress/rspress-banner.png">
 </picture>
 
 <h2 align="center">A fast Rsbuild-based static site generator.</h2>
 
 ## Getting started
 
-Go to the [Quick start](https://rspress.dev/guide/start/getting-started.html) to get started.
+Go to the [Quick start](https://rspress.rs/guide/start/getting-started.html) to get started.
 
 ### License
 

package/dist/config.d.ts

@@ -0,0 +1,7 @@
+import type { UserConfig } from '@rspress/core';
+
+export declare function defineConfig(config: UserConfig): UserConfig;
+
+export { UserConfig }
+
+export { }

package/dist/config.js

@@ -0,0 +1,4 @@
+function defineConfig(config) {
+    return config;
+}
+export { defineConfig };

package/dist/core.d.ts

@@ -0,0 +1,4 @@
+
+export * from "@rspress/core/dist/index.js";
+
+export { }

package/dist/core.js

@@ -0,0 +1 @@
+export * from "@rspress/core/dist/index.js";

package/dist/index.js

@@ -1,98 +1,50 @@
-import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
-import * as __WEBPACK_EXTERNAL_MODULE__rspress_core_1b2e46ce__ from "@rspress/core";
-import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__ from "@rspress/shared/logger";
-import * as __WEBPACK_EXTERNAL_MODULE_cac__ from "cac";
-import * as __WEBPACK_EXTERNAL_MODULE_chokidar__ from "chokidar";
-import * as __WEBPACK_EXTERNAL_MODULE_picocolors__ from "picocolors";
-import * as __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__ from "node:fs";
-import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_constants_70084e62__ from "@rspress/shared/constants";
-import * as __WEBPACK_EXTERNAL_MODULE_node_child_process_27f17141__ from "node:child_process";
-import * as __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__ from "node:fs/promises";
-var package_namespaceObject = JSON.parse('{"i8":"2.0.0-beta.2"}');
-const findConfig = (basePath)=>__WEBPACK_EXTERNAL_MODULE__rspress_shared_constants_70084e62__.DEFAULT_CONFIG_EXTENSIONS.map((ext)=>basePath + ext).find(__WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__["default"].existsSync);
+import node_path from "node:path";
+import { build, dev, logger, serve } from "@rspress/core";
+import { logger as logger_logger } from "@rspress/shared/logger";
+import { cac } from "cac";
+import chokidar from "chokidar";
+import picocolors from "picocolors";
+import node_fs from "node:fs";
+import { DEFAULT_CONFIG_EXTENSIONS, DEFAULT_CONFIG_NAME } from "@rspress/shared/constants";
+var package_namespaceObject = JSON.parse('{"i8":"2.0.0-beta.21"}');
+const findConfig = (basePath)=>DEFAULT_CONFIG_EXTENSIONS.map((ext)=>basePath + ext).find(node_fs.existsSync);
 async function loadConfigFile(customConfigFile) {
     const baseDir = process.cwd();
     let configFilePath = '';
-    configFilePath = customConfigFile ? __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].isAbsolute(customConfigFile) ? customConfigFile : __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(baseDir, customConfigFile) : findConfig(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(baseDir, __WEBPACK_EXTERNAL_MODULE__rspress_shared_constants_70084e62__.DEFAULT_CONFIG_NAME));
+    configFilePath = customConfigFile ? node_path.isAbsolute(customConfigFile) ? customConfigFile : node_path.join(baseDir, customConfigFile) : findConfig(node_path.join(baseDir, DEFAULT_CONFIG_NAME));
     if (!configFilePath) {
-        __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.info(`No config file found in ${baseDir}`);
-        return {};
+        logger.info(`No config file found in ${baseDir}`);
+        return {
+            config: {},
+            configFilePath: ''
+        };
     }
     const { loadConfig } = await import("@rsbuild/core");
     const { content } = await loadConfig({
-        cwd: __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].dirname(configFilePath),
+        cwd: node_path.dirname(configFilePath),
         path: configFilePath
     });
-    return content;
+    return {
+        config: content,
+        configFilePath
+    };
 }
 function resolveDocRoot(cwd, cliRoot, configRoot) {
-    if (cliRoot) return __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(cwd, cliRoot);
-    if (configRoot) return __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].isAbsolute(configRoot) ? configRoot : __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(cwd, configRoot);
-    return __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(cwd, 'docs');
-}
-async function pathExists(path) {
-    try {
-        await __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__["default"].access(path);
-        return true;
-    } catch  {
-        return false;
-    }
-}
-const lockfileMap = {
-    'package-lock.json': 'npm',
-    'yarn.lock': 'yarn',
-    'pnpm-lock.yaml': 'pnpm',
-    'bun.lockb': 'bun'
-};
-async function getPackageManager(rootPath) {
-    let packageManager = 'npm';
-    for (const file of Object.keys(lockfileMap))if (await pathExists(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(rootPath, file))) {
-        packageManager = lockfileMap[file];
-        break;
-    }
-    return packageManager;
-}
-async function getRspressDependencies(rootPath) {
-    const packageJson = JSON.parse(await __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__["default"].readFile(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(rootPath, 'package.json'), {
-        encoding: 'utf-8'
-    }));
-    const dependencies = packageJson?.dependencies ? Object.keys(packageJson.dependencies) : [];
-    const devDependencies = packageJson?.devDependencies ? Object.keys(packageJson.devDependencies) : [];
-    return dependencies.concat(devDependencies).filter((item)=>item.startsWith('@rspress') || item.startsWith('rspress'));
-}
-async function update() {
-    const cwd = process.cwd();
-    const packageManager = await getPackageManager(cwd);
-    const rspressDependencies = await getRspressDependencies(cwd);
-    __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.greet(`Using ${packageManager} to update ${rspressDependencies.join(' ')}`);
-    if ('npm' === packageManager || 'bun' === packageManager) {
-        const dependencies = rspressDependencies.map((item)=>`${item}@latest`);
-        (0, __WEBPACK_EXTERNAL_MODULE_node_child_process_27f17141__.spawn)(packageManager, [
-            'install',
-            '--save',
-            ...dependencies
-        ], {
-            stdio: 'inherit'
-        });
-    } else {
-        const subCommand = 'yarn' === packageManager ? 'upgrade' : 'update';
-        (0, __WEBPACK_EXTERNAL_MODULE_node_child_process_27f17141__.spawn)(packageManager, [
-            subCommand,
-            '--latest',
-            ...rspressDependencies
-        ], {
-            stdio: 'inherit'
-        });
-    }
+    if (cliRoot) return node_path.join(cwd, cliRoot);
+    if (configRoot) return node_path.isAbsolute(configRoot) ? configRoot : node_path.join(cwd, configRoot);
+    return node_path.join(cwd, 'docs');
 }
 const CONFIG_FILES = [
     'rspress.config.ts',
     'rspress.config.js'
 ];
-const META_FILE = '_meta.json';
-const cli = (0, __WEBPACK_EXTERNAL_MODULE_cac__.cac)('rspress').version(package_namespaceObject.i8).help();
-const landingMessage = `🔥 Rspress v${package_namespaceObject.i8}\n`;
-__WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.greet(landingMessage);
+const META_FILES = [
+    '_meta.json',
+    '_nav.json'
+];
+const cli = cac('rspress').version(package_namespaceObject.i8).help();
+const landingMessage = `\u{1F525} Rspress v${package_namespaceObject.i8}\n`;
+logger_logger.greet(landingMessage);
 const setNodeEnv = (env)=>{
     process.env.NODE_ENV = env;
 };
@@ -105,13 +57,14 @@ cli.command('[root]', 'start dev server').alias('dev').option('--port [port]', '
     let devServer;
     const startDevServer = async ()=>{
         const { port, host } = options || {};
-        const config = await loadConfigFile(options?.config);
+        const { config, configFilePath } = await loadConfigFile(options?.config);
         config.root = resolveDocRoot(cwd, root, config.root);
         const docDirectory = config.root;
-        devServer = await (0, __WEBPACK_EXTERNAL_MODULE__rspress_core_1b2e46ce__.dev)({
+        devServer = await dev({
             appDirectory: cwd,
             docDirectory,
             config,
+            configFilePath,
             extraBuilderConfig: {
                 server: {
                     port,
@@ -119,7 +72,7 @@ cli.command('[root]', 'start dev server').alias('dev').option('--port [port]', '
                 }
             }
         });
-        cliWatcher = __WEBPACK_EXTERNAL_MODULE_chokidar__["default"].watch([
+        cliWatcher = chokidar.watch([
             `${cwd}/**/{${CONFIG_FILES.join(',')}}`,
             docDirectory
         ], {
@@ -131,10 +84,12 @@ cli.command('[root]', 'start dev server').alias('dev').option('--port [port]', '
             ]
         });
         cliWatcher.on('all', async (eventName, filepath)=>{
-            if ('add' === eventName || 'unlink' === eventName || 'change' === eventName && (CONFIG_FILES.includes(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].basename(filepath)) || __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].basename(filepath) === META_FILE)) {
+            const basename = node_path.basename(filepath);
+            if ('add' === eventName || 'unlink' === eventName || 'change' === eventName && (CONFIG_FILES.includes(basename) || META_FILES.includes(basename))) {
                 if (isRestarting) return;
                 isRestarting = true;
-                console.log(`\n✨ ${eventName} ${__WEBPACK_EXTERNAL_MODULE_picocolors__["default"].green(__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].relative(cwd, filepath))}, dev server will restart...\n`);
+                console.log(`
+\u{2728} ${eventName} ${picocolors.green(node_path.relative(cwd, filepath))}, dev server will restart...\n`);
                 await devServer.close();
                 await cliWatcher.close();
                 await startDevServer();
@@ -157,16 +112,17 @@ cli.command('[root]', 'start dev server').alias('dev').option('--port [port]', '
 cli.command('build [root]').action(async (root, options)=>{
     setNodeEnv('production');
     const cwd = process.cwd();
-    const config = await loadConfigFile(options.config);
+    const { config, configFilePath } = await loadConfigFile(options.config);
     config.root = resolveDocRoot(cwd, root, config.root);
     const docDirectory = config.root;
     try {
-        await (0, __WEBPACK_EXTERNAL_MODULE__rspress_core_1b2e46ce__.build)({
+        await build({
             docDirectory,
-            config
+            config,
+            configFilePath
         });
     } catch (err) {
-        __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.error(err);
+        logger_logger.error(err);
         process.exit(1);
     }
 });
@@ -174,13 +130,13 @@ cli.command('preview [root]').alias('serve').option('--port [port]', 'port numbe
     setNodeEnv('production');
     const cwd = process.cwd();
     const { port, host } = options || {};
-    const config = await loadConfigFile(options?.config);
+    const { config, configFilePath } = await loadConfigFile(options?.config);
     config.root = resolveDocRoot(cwd, root, config.root);
-    await (0, __WEBPACK_EXTERNAL_MODULE__rspress_core_1b2e46ce__.serve)({
+    await serve({
         config,
         host,
-        port
+        port,
+        configFilePath
     });
 });
-cli.command('update', 'update relevant packages about rspress').action(update);
 cli.parse();

package/dist/runtime.d.ts

@@ -0,0 +1,4 @@
+
+export * from "@rspress/core/dist/runtime.js";
+
+export { }

package/dist/runtime.js

@@ -0,0 +1 @@
+export * from "@rspress/core/dist/runtime.js";

package/dist/shiki-transformers.d.ts

@@ -0,0 +1,4 @@
+
+export * from "@rspress/core/dist/shiki-transformers.js";
+
+export { }

package/dist/shiki-transformers.js

@@ -0,0 +1 @@
+export * from "@rspress/core/dist/shiki-transformers.js";

package/dist/theme.d.ts

@@ -0,0 +1,4 @@
+
+export * from "@rspress/core/dist/theme.js";
+
+export { }

package/dist/theme.js

@@ -0,0 +1 @@
+export * from "@rspress/core/dist/theme.js";

package/meta-json-schema.json

@@ -0,0 +1,175 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/MetaJson",
+  "definitions": {
+    "MetaJson": {
+      "$ref": "#/definitions/SideMeta"
+    },
+    "SideMeta": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/SideMetaItem"
+      }
+    },
+    "SideMetaItem": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/FileSideMeta"
+        },
+        {
+          "$ref": "#/definitions/DirSideMeta"
+        },
+        {
+          "$ref": "#/definitions/DividerSideMeta"
+        },
+        {
+          "$ref": "#/definitions/SectionHeaderMeta"
+        },
+        {
+          "$ref": "#/definitions/CustomLinkMeta"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "FileSideMeta": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "file"
+        },
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "overviewHeaders": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        },
+        "context": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "type",
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "DirSideMeta": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "dir"
+        },
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "collapsible": {
+          "type": "boolean"
+        },
+        "collapsed": {
+          "type": "boolean"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "overviewHeaders": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        },
+        "context": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "type",
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "DividerSideMeta": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "divider"
+        },
+        "dashed": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "additionalProperties": false
+    },
+    "SectionHeaderMeta": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "section-header"
+        },
+        "label": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "type",
+        "label"
+      ],
+      "additionalProperties": false
+    },
+    "CustomLinkMeta": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "custom-link"
+        },
+        "label": {
+          "type": "string"
+        },
+        "link": {
+          "type": "string"
+        },
+        "context": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CustomLinkMeta"
+          }
+        }
+      },
+      "required": [
+        "type",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/nav-json-schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/NavJson",
+  "definitions": {
+    "NavJson": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/NavItem"
+      }
+    },
+    "NavItem": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/NavItemWithLink"
+        },
+        {
+          "$ref": "#/definitions/NavItemWithChildren"
+        },
+        {
+          "$ref": "#/definitions/NavItemWithLinkAndChildren"
+        }
+      ]
+    },
+    "NavItemWithLink": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "link": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "activeMatch": {
+          "type": "string"
+        },
+        "position": {
+          "type": "string",
+          "enum": [
+            "left",
+            "right"
+          ]
+        }
+      },
+      "required": [
+        "text",
+        "link"
+      ],
+      "additionalProperties": false
+    },
+    "NavItemWithChildren": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/NavItemWithLink"
+          }
+        },
+        "position": {
+          "type": "string",
+          "enum": [
+            "left",
+            "right"
+          ]
+        }
+      },
+      "required": [
+        "items"
+      ],
+      "additionalProperties": false
+    },
+    "NavItemWithLinkAndChildren": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "link": {
+          "type": "string"
+        },
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/NavItemWithLink"
+          }
+        },
+        "tag": {
+          "type": "string"
+        },
+        "activeMatch": {
+          "type": "string"
+        },
+        "position": {
+          "type": "string",
+          "enum": [
+            "left",
+            "right"
+          ]
+        }
+      },
+      "required": [
+        "text",
+        "link",
+        "items"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rspress",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.21",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -10,17 +10,30 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "default": "./dist/core.js"
+    },
     "./runtime": {
-      "default": "./runtime.ts"
+      "types": "./dist/runtime.d.ts",
+      "default": "./dist/runtime.js"
     },
     "./theme": {
-      "default": "./theme.ts"
+      "types": "./dist/theme.d.ts",
+      "default": "./dist/theme.js"
     },
     "./config": {
-      "default": "./config.ts"
-    }
+      "types": "./dist/config.d.ts",
+      "default": "./dist/config.js"
+    },
+    "./shiki-transformers": {
+      "types": "./dist/shiki-transformers.d.ts",
+      "default": "./dist/shiki-transformers.js"
+    },
+    "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -31,26 +44,26 @@
   "files": [
     "bin",
     "dist",
-    "runtime.ts",
-    "theme.ts",
-    "config.ts"
+    "meta-json-schema.json",
+    "nav-json-schema.json"
   ],
   "dependencies": {
-    "@rsbuild/core": "1.3.9",
+    "@rsbuild/core": "~1.4.6",
     "cac": "^6.7.14",
     "chokidar": "^3.6.0",
     "picocolors": "^1.1.1",
-    "@rspress/shared": "2.0.0-beta.2",
-    "@rspress/core": "2.0.0-beta.2"
+    "@rspress/shared": "2.0.0-beta.21",
+    "@rspress/core": "2.0.0-beta.21"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.4",
-    "@rslib/core": "0.6.5",
+    "@microsoft/api-extractor": "^7.52.8",
+    "@rslib/core": "0.10.5",
     "@types/jest": "~29.5.14",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
+    "@types/node": "^22.8.1",
+    "@types/react": "^19.1.8",
     "rimraf": "^6.0.1",
-    "rsbuild-plugin-publint": "^0.3.0",
+    "rsbuild-plugin-publint": "^0.3.2",
+    "ts-json-schema-generator": "^2.4.0",
     "typescript": "^5.8.2"
   },
   "publishConfig": {

package/config.ts

@@ -1,7 +0,0 @@
-import type { UserConfig } from '@rspress/core';
-
-export function defineConfig(config: UserConfig): UserConfig {
-  return config;
-}
-
-export type { UserConfig };

package/runtime.ts

@@ -1 +0,0 @@
-export * from '@rspress/core/runtime';

package/theme.ts

@@ -1 +0,0 @@
-export * from '@rspress/core/theme';