rspress-plugin-gh-pages 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# rspress-plugin-gh-pages
+
+## 0.1.4
+
+### Patch Changes
+
+- 546dcf0: release beta
+- 5e28903: fixup publish config
+- Updated dependencies [546dcf0]
+- Updated dependencies [5e28903]
+  - rspress-plugin-devkit@0.1.1
+
+## 0.1.4-beta.0
+
+### Patch Changes
+
+- 546dcf0: release beta
+- Updated dependencies [546dcf0]
+  - rspress-plugin-devkit@0.1.1-beta.0

package/README.md

@@ -30,12 +30,11 @@ export default defineConfig({
 
 ## Configure
 
-## repo
+## directory
 
-- Type: `string`
-- `Required`
+Target directory to push to the `gh-pages` branch, `config.outDir` will be used if this configuration is not specified.
 
-The repository to deploy to, you can also specify another repository to deploy to.
+- Type: `string`
 
 ## siteBase
 
@@ -43,4 +42,20 @@ The repository to deploy to, you can also specify another repository to deploy t
 
 Deploying to repositories other than the `<user>.github.io` repository requires specifying the `siteBase` option, as an example, deploying to repository `<user>/awesome-plugins` will require setting `siteBase` to `/awesome-plugins`, as the page will be hosted at `https://<user>.github.io/awesome-plugins`.
 
-By default, `rspress-plugin-gh-pages` will try to parse the `repo` option to get a `siteBase` value(if repo is a `github.io` repository, the `siteBase` will be `/`, otherwise, the `siteBase` will be `/<repo-name>`), you can also specify the `siteBase` option to override the default value.
+By default, this plugin will try to parse the `repo` option to get a `siteBase` value(if repo is a `github.io` repository, the `siteBase` will be `/`, otherwise, the `siteBase` will be `/<repo-name>`), you can also specify the `siteBase` option to override the default value.
+
+## silent
+
+Disable terminal log output from this plugin.
+
+- Type: `boolean`
+- Default: false
+
+## repo
+
+- Type: `string`
+- `Required`
+
+The repository to deploy to, you can also specify another repository to deploy to.
+
+More options can be found in documentation of [gh-pages](https://github.com/tschaub/gh-pages).

package/dist/index.js

@@ -3,6 +3,11 @@ import ghpages from 'gh-pages';
 import { logger } from '@rspress/shared/logger';
 const DefaultDocBuildOutput = 'doc_build';
 const logPrefix = chalk.green('[gh-pages]');
+function normalizeBase(base) {
+    return base === '/' || base === ''
+        ? '/'
+        : `/${base.replace(/^\/+|\/+$/g, '')}/`;
+}
 export default function rspressPluginGHPages(options) {
     const { repo, directory, branch = 'gh-pages', silent = false, siteBase = '', ...publishOptions } = options;
     return {
@@ -18,7 +23,7 @@ export default function rspressPluginGHPages(options) {
                 logger.warn(`${logPrefix} Failed to parse base from repo, site base path will not be updated.`);
                 return config;
             }
-            config.base = `/${base}/`;
+            config.base = normalizeBase(base);
             return config;
         },
         async afterBuild(config, isBuild) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rspress-plugin-gh-pages",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Rspress plugin that add support for automatic deployment to GitHub Pages",
   "keywords": [
     "rspress",
@@ -20,11 +20,14 @@
   "author": "Linbudu <linbudu599@gmail.com> (https://github.com/linbudu599)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "@rspress/shared": "^1.17.1",
     "chalk": "^5.3.0",
     "gh-pages": "^6.1.1",
-    "rspress-plugin-devkit": "^0.1.0"
+    "rspress-plugin-devkit": "^0.1.1"
   },
   "devDependencies": {
     "@types/gh-pages": "^6.1.0",
@@ -38,7 +41,6 @@
     "build": "tsc --declarationMap false",
     "dev": "tsc -w",
     "docs:build": "rspress build",
-    "docs:dev": "rspress dev",
-    "prepublish": "npm run build"
+    "docs:dev": "rspress dev"
   }
 }

package/src/index.ts

@@ -16,6 +16,12 @@ interface RspressPluginGHPagesOptions
 
 const logPrefix = chalk.green('[gh-pages]');
 
+function normalizeBase(base: string): string {
+  return base === '/' || base === ''
+    ? '/'
+    : `/${base.replace(/^\/+|\/+$/g, '')}/`;
+}
+
 export default function rspressPluginGHPages(
   options: RspressPluginGHPagesOptions,
 ): RspressPlugin {
@@ -46,7 +52,7 @@ export default function rspressPluginGHPages(
         return config;
       }
 
-      config.base = `/${base}/`;
+      config.base = normalizeBase(base);
 
       return config;
     },

package/tsconfig.json

@@ -1,7 +1,9 @@
 {
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist"
+    "outDir": "dist",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext"
   },
   "include": ["src"],
   "extends": "../../tsconfig.base.json"