rspress-plugin-gh-pages 0.1.0

package/src/index.ts

@@ -0,0 +1,66 @@
+import path from 'node:path';
+
+import chalk from 'chalk';
+import ghpages from 'gh-pages';
+import { logger } from '@rspress/shared/logger';
+
+import { PresetConfigMutator, type StrictOmit } from 'rspress-plugin-devkit';
+import type { RspressPlugin } from '@rspress/shared';
+
+export const componentsPath = path.join(__dirname, './components');
+
+const DefaultDocBuildOutput = 'doc_build';
+
+interface RspressPluginGHPagesOptions extends ghpages.PublishOptions {
+  directory?: string;
+  silent?: boolean;
+}
+
+export default function rspressPluginGHPages(
+  options: RspressPluginGHPagesOptions = {},
+): RspressPlugin {
+  const {
+    directory,
+    repo,
+    branch = 'gh-pages',
+    silent = false,
+    ...publishOptions
+  } = options;
+
+  return {
+    name: 'rspress-plugin-gh-pages',
+    config(config) {
+      config.base = '/rspress-plugins/';
+      return new PresetConfigMutator(config).toConfig();
+    },
+    async afterBuild(config, isBuild) {
+      if (!isBuild) return;
+
+      const publishDir = directory ?? config.outDir ?? DefaultDocBuildOutput;
+
+      const logPrefix = chalk.green('[rspress-plugin-gh-pages]');
+
+      if (!silent) {
+        logger.info(
+          `${logPrefix} Publish directory: ${chalk.cyan(publishDir)}`,
+        );
+        logger.info(`${logPrefix} Publish branch: ${chalk.cyan(branch)}`);
+      }
+
+      try {
+        await ghpages.publish(publishDir, {
+          repo,
+          branch,
+          ...publishOptions,
+        });
+      } catch (error) {
+        silent
+          ? void 0
+          : logger.error(`${logPrefix} Failed to publish: ${error}`);
+        process.exit(1);
+      }
+
+      silent ? void 0 : logger.success(`${logPrefix} Page Published.`);
+    },
+  };
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"],
+  "extends": "../../tsconfig.base.json"
+}