rspress-plugin-gh-pages 0.1.0 → 0.1.2

package/src/index.ts

@@ -1,45 +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 { MarkRequired } 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 {
+interface RspressPluginGHPagesOptions
+  extends MarkRequired<ghpages.PublishOptions, 'repo'> {
   directory?: string;
   silent?: boolean;
+  siteBase?: string;
 }
 
+const logPrefix = chalk.green('[gh-pages]');
+
 export default function rspressPluginGHPages(
-  options: RspressPluginGHPagesOptions = {},
+  options: RspressPluginGHPagesOptions,
 ): RspressPlugin {
   const {
-    directory,
     repo,
+    directory,
     branch = 'gh-pages',
     silent = false,
+    siteBase = '',
     ...publishOptions
   } = options;
 
   return {
     name: 'rspress-plugin-gh-pages',
     config(config) {
-      config.base = '/rspress-plugins/';
-      return new PresetConfigMutator(config).toConfig();
+      let baseFromRepo = repo.includes('github.io')
+        ? '/'
+        : /\/([^\/]+)\.git$/.exec(repo)?.[1];
+
+      // Use || here to as ?? will consider '' as a valid value
+      const base = siteBase || baseFromRepo || '';
+
+      if (!base) {
+        logger.warn(
+          `${logPrefix} Failed to parse base from repo, site base path will not be updated.`,
+        );
+
+        return config;
+      }
+
+      config.base = `/${base}/`;
+
+      return config;
     },
     async afterBuild(config, isBuild) {
+      if (!repo) {
+        logger.error(
+          `Option ${chalk.cyan('repo')} is required for rspress-plugin-gh-pages.`,
+        );
+      }
+
       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)}`,

package/doc_build/static/search_index.a36e1c1a.json

@@ -1 +0,0 @@
-[{"id":0,"title":"RSPress x GH Pages","content":"#","routePath":"/rspress-plugins/","lang":"","toc":[],"domain":"","frontmatter":{},"version":""}]