@show-docs/docusaurus-theme-copy-button 0.1.0 → 0.2.0

package/README.md

@@ -5,8 +5,11 @@
 
 ## 安装
 
+`@theme-prev/*` 的别名由解析器插件提供；theme-iframe 只在构建期提供一条共享函数，装上即可，
+不必注册成插件。三个包一起安装：
+
 ```bash
-pnpm add @show-docs/docusaurus-theme-copy-button
+pnpm add @show-docs/docusaurus-plugin-prev-layer-resolver @show-docs/docusaurus-theme-iframe @show-docs/docusaurus-theme-copy-button
 ```
 
 ## 使用
@@ -16,7 +19,10 @@ pnpm add @show-docs/docusaurus-theme-copy-button
 ```js
 // docusaurus.config.mjs
 export default {
-  plugins: ['@show-docs/docusaurus-theme-copy-button']
+  plugins: [
+    '@show-docs/docusaurus-plugin-prev-layer-resolver',
+    '@show-docs/docusaurus-theme-copy-button'
+  ]
 };
 ```
 
@@ -32,7 +38,7 @@ export default {
 这一层不读 frontmatter，也没有插件选项。
 
 层栈怎么推导、谁能盖住谁，是核心解析器那一格的事，见
-[`plugin-prev-layer-resolver` 的 README](../../plugins/plugin-prev-layer-resolver/README.md)；
+[`plugin-prev-layer-resolver` 的 README](../plugin-prev-layer-resolver/README.md)；
 这一层自己只负责「挂在哪一格」。
 
 ## 工作方式
@@ -58,5 +64,5 @@ export default {
 
 ## 相关文档
 
-- [`plugin-prev-layer-resolver` 的 README](../../plugins/plugin-prev-layer-resolver/README.md)：`@theme-prev/*` 的语义与层栈。
+- [`plugin-prev-layer-resolver` 的 README](../plugin-prev-layer-resolver/README.md)：`@theme-prev/*` 的语义与层栈。
 - [`sonner` 文档](https://sonner.emilkowal.ski/)：提示条的选项与样式。

package/components/copy-button.tsx

@@ -9,6 +9,10 @@ const FAILURE_MESSAGE = '复制失败';
 
 `navigator.clipboard` 只在这个页面是安全上下文（https，或 localhost）时才存在，
 用 http 打开的站点拿到的就是 `undefined` —— 这一格要单独判，不能只靠 `catch`。
+
+`location.href` 本身已经是百分号编码过的，**原样复制**：解码一遍会把 `%2F` 还原成 `/`，
+把地址改样；地址末尾有一个裸 `%`（`?q=100%`）时 `decodeURIComponent` 还会抛 `URIError`，
+按下去只会得到一句「复制失败」。
 */
 async function copyPageUrl(): Promise<void> {
   if (!navigator.clipboard) {
@@ -16,9 +20,7 @@ async function copyPageUrl(): Promise<void> {
     return;
   }
   try {
-    await navigator.clipboard.writeText(
-      decodeURIComponent(window.location.href),
-    );
+    await navigator.clipboard.writeText(window.location.href);
     toast.success(SUCCESS_MESSAGE);
   } catch (error) {
     toast.error(FAILURE_MESSAGE);

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import type { Plugin } from '@docusaurus/types';
-export default function theme(): Plugin;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function theme(context: LoadContext): Plugin;

package/dist/index.mjs

@@ -1,12 +1,23 @@
 import { dirname, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { assertThemePrerequisites } from '@show-docs/docusaurus-theme-iframe/lib/prerequisites.ts';
 // 包出口是 `dist/`，所以这里的路径都相对**产物**目录算，不是相对 `src/`。
 const thisDir = dirname(fileURLToPath(import.meta.url));
-export default function theme() {
+export default function theme(context) {
     return {
         name: '@show-docs/docusaurus-theme-copy-button',
+        loadContent() {
+            // 本层只在构建期引 theme-iframe 的一条纯函数，不需要它的插件规则；但 `@theme-prev/*`
+            // 的别名仍由解析器插件提供，缺了它同样是构建期才炸。
+            assertThemePrerequisites(context, {
+                namespace: '@show-docs/docusaurus-theme-copy-button',
+            });
+        },
         // 主题层与 `components/` 是**源码**，站在包根上，不经 `tsc`：用本包的 Docusaurus
         // 项目会用自己的 babel 编译它们。这里只编译 `src/` 那一份入口。
+        //
+        // 「谁来编」归 `@show-docs/docusaurus-plugin-prev-layer-resolver`（它按 `@show-docs`
+        // 这个 scope 认领 `node_modules` 里的 TS 源码），本包不自己补 babel 规则。
         getThemePath() {
             return resolve(thisDir, '../theme');
         },
@@ -19,21 +30,5 @@ export default function theme() {
         getClientModules() {
             return [resolve(thisDir, '../styles/copy-button.css')];
         },
-        configureWebpack(_config, isServer, utils) {
-            return {
-                module: {
-                    rules: [
-                        {
-                            // 官方那条 babel 规则排除整个 node_modules、只放行 `docusaurus*.js`，本包从
-                            // npm 安装后的 `.tsx` 会报 `Module parse failed`。补一条只覆盖本包的规则
-                            //（理由与代价见 theme-iframe 的 `lib/api-frame-theme.mts` 里同一条）。
-                            test: /\.tsx?$/,
-                            include: [resolve(thisDir, '..')],
-                            use: [utils.getJSLoader({ isServer })],
-                        },
-                    ],
-                },
-            };
-        },
     };
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@show-docs/docusaurus-theme-copy-button",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "页脚版权那一格右边加一颗按钮，点一下把当前页地址写进剪贴板",
   "keywords": [],
-  "homepage": "https://github.com/show-docs/docusaurus/tree/master/theme/theme-copy-button",
+  "homepage": "https://github.com/show-docs/docusaurus/tree/master/packages/theme-copy-button",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/show-docs/docusaurus.git",
-    "directory": "theme/theme-copy-button"
+    "directory": "packages/theme-copy-button"
   },
   "bugs": {
     "url": "https://github.com/show-docs/docusaurus/issues"
@@ -27,11 +27,17 @@
     "theme"
   ],
   "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "pnpm run build"
+  },
   "dependencies": {
     "sonner": "^2.0.8"
   },
   "peerDependencies": {
     "@docusaurus/types": "^3.9.2",
+    "@show-docs/docusaurus-plugin-prev-layer-resolver": "workspace:^",
+    "@show-docs/docusaurus-theme-iframe": "workspace:^",
     "react": "~18.3.1"
   },
   "peerDependenciesMeta": {
@@ -45,8 +51,5 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json"
   }
-}
+}