添加changesets

welives · Nov 29, 2023 · caa7269 · caa7269
1 parent d192acb
commit caa7269
Show file tree

Hide file tree

Showing 13 changed files with 2,364 additions and 54 deletions.
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [["@vitepress-code-preview/container", "@vitepress-code-preview/plugin"]],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "onlyUpdatePeerDependentsWhenOutOfRange": true
+  }
+}
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1,10 @@
+# code-preview-example
+
+## 1.0.2
+
+### Patch Changes
+
+- update README
+- Updated dependencies
+  - @vitepress-code-preview/container@1.0.3
+  - @vitepress-code-preview/plugin@1.0.3
diff --git a/docs/package.json b/docs/package.json
@@ -1,15 +1,15 @@
 {
   "name": "code-preview-example",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "scripts": {
     "dev": "vitepress dev",
     "build": "vitepress build",
     "preview": "vitepress preview"
   },
   "dependencies": {
-    "@vitepress-code-preview/container": "workspace:^1.0.1",
-    "@vitepress-code-preview/plugin": "workspace:^1.0.2",
+    "@vitepress-code-preview/container": "workspace:^1.0.3",
+    "@vitepress-code-preview/plugin": "workspace:^1.0.3",
     "vue": "^3.3.8"
   },
   "devDependencies": {

diff --git a/package.json b/package.json
@@ -22,16 +22,24 @@
     "docs",
     "packages/*"
   ],
-  "type": "module",
   "scripts": {
     "docs:dev": "pnpm --filter=code-preview-example dev",
     "docs:preview": "pnpm --filter=code-preview-example preview",
     "docs:build": "pnpm --filter=code-preview-example build",
     "build": "pnpm container:build && pnpm plugin:build",
+    "container:dev": "pnpm --filter=@vitepress-code-preview/container dev",
     "container:build": "pnpm --filter=@vitepress-code-preview/container build",
-    "plugin:build": "pnpm --filter=@vitepress-code-preview/plugin build"
+    "plugin:dev": "pnpm --filter=@vitepress-code-preview/plugin dev",
+    "plugin:build": "pnpm --filter=@vitepress-code-preview/plugin build",
+    "clear": "rimraf 'packages/*/{dist}'",
+    "copy": "esno ./scripts/copy.ts",
+    "changeset": "changeset",
+    "changeset-version": "changeset version",
+    "preinstall": "npx only-allow pnpm"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
     "@types/node": "^20.10.0",
     "@typescript-eslint/eslint-plugin": "^6.12.0",
     "@typescript-eslint/parser": "^6.12.0",
@@ -41,6 +49,7 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-vue": "^9.18.1",
+    "esno": "^4.0.0",
     "prettier": "^3.1.0",
     "typescript": "^5.3.2",
     "vue": "^3.3.8"

diff --git a/packages/container/CHANGELOG.md b/packages/container/CHANGELOG.md
@@ -1,11 +1,17 @@
 # @vitepress-code-preview/container
 
-## 1.0.0
+## 1.0.3
 
-### Release
+### Patch Changes
+
+- update README
 
 ## 1.0.1
 
 ### Patch Changes
 
 - update README
+
+## 1.0.0
+
+### Release
diff --git a/packages/container/README.md b/packages/container/README.md
@@ -1,28 +1,28 @@
 <div align="center">
 	<h1 style="margin:10px">vitepress-code-preview</h1>
-	<h6 align="center">一款在 vitepress 文档中嵌入 Vue 示例代码的插件, 支持 SFC, JSX, TSX</h6>
+	<h6 align="center">一款给 vitepress 文档中嵌入的 Vue 示例代码增加演示功能的插件, 支持 SFC, JSX, TSX</h6>
 </div>
 
 ## 🎉 简介
 
-本项目基于 `vitepress`、 `markdown-it` 和 `unified` 实现，它可以帮助你在编写文档的时候嵌入 Vue 示例，支持的 Vue 组件形式有 SFC, JSX, TSX
+本插件基于 `vitepress`、 `markdown-it` 和 `unified` 实现，它可以帮助你在编写文档的时候，对嵌入的 Vue 示例代码增加演示功能，支持的 Vue 组件形式有 SFC, JSX, TSX
 
 ## 🏄‍♂️ 插件包
 
-| Package                                      | Version (click for changelogs)                                                                       |
-| -------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| [@vitepress-code-preview/container](./)      | [![container version](https://badgen.net/npm/v/@vitepress-code-preview/container)](CHANGELOG.md)     |
-| [@vitepress-code-preview/plugin](../plugin/) | [![plugin version](https://badgen.net/npm/v/@vitepress-code-preview/plugin)](../plugin/CHANGELOG.md) |
+| Package                                                 | Version (click for changelogs)                                                                                      |
+| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [@vitepress-code-preview/container](packages/container) | [![container version](https://badgen.net/npm/v/@vitepress-code-preview/container)](packages/container/CHANGELOG.md) |
+| [@vitepress-code-preview/plugin](packages/plugin)       | [![plugin version](https://badgen.net/npm/v/@vitepress-code-preview/plugin)](packages/plugin/CHANGELOG.md)          |
 
-## ⚙️ 安装
+## ⚙ 安装
 
 ```sh
 pnpm add @vitepress-code-preview/container @vitepress-code-preview/plugin
 ```
 
-## ⚡ 快速上手
+## 🚀 引入
 
-编辑你的`docs/vite.config.ts`，注册 Vite 插件，如果需要支持 JSX 组件，请安装 `@vitejs/plugin-vue-jsx`
+- ① 编辑`docs/vite.config.ts`，注册 Vite 插件，如果需要支持 JSX 组件，请安装 `@vitejs/plugin-vue-jsx`
 
 ```ts
 import { defineConfig } from 'vite'
@@ -33,7 +33,7 @@ export default defineConfig({
 })
 ```
 
-编辑你的`.vitepress/config.ts`，注册 markdown 插件
+- ② 编辑`.vitepress/config.ts`，注册 markdown 插件
 
 ```ts
 import { fileURLToPath, URL } from 'node:url'
@@ -50,7 +50,7 @@ export default defineConfig({
 })
 ```
 
-编辑你的`.vitepress/theme/index.ts`，注册组件容器
+- ③ 编辑`.vitepress/theme/index.ts`，注册组件容器
 
 ```ts
 import type { Theme } from 'vitepress'
@@ -68,6 +68,8 @@ export default {
 
 ### 💡 基础用法
 
+在`demo`容器中直接编写`vue`代码
+
 ````md
 :::demo
 
@@ -84,7 +86,7 @@ const title = ref('this is basic demo')
 :::
 ````
 
-![basic-demo](../../assets/basic-demo.png)
+![basic-demo](./assets/basic-demo.png)
 
 ### 💪 支持 JSX 和 TSX
 
@@ -105,9 +107,22 @@ export default defineComponent({
 :::
 ````
 
-![support-jsx-tsx](../../assets/support-jsx-tsx.png)
+![support-jsx-tsx](./assets/support-jsx-tsx.png)
+
+### ✨ 使用其他已注册的组件
+
+假设我们有一个第三方的`Button`组件已经在`.vitepress/theme/index.ts`中注册过了，那么就可以在`demo`容器中使用它
 
-### 💡 使用其他组件
+```ts
+// ...
+export default {
+  ...DefaultTheme,
+  enhanceApp(ctx) {
+    // ...
+    useComponents(app, Button, Button.name)
+  },
+} satisfies Theme
+```
 
 ````md
 :::demo
@@ -126,13 +141,15 @@ export default defineComponent({
 :::
 ````
 
-![other-component](../../assets/other-component.png)
+![other-component](./assets/other-component.png)
+
+### ⚡ 直接引入组件文件
 
-### 🐱‍👤 还支持文件引入的方式
+如果你的示例代码比较多，在 markdown 中直接写会比较麻烦，那么可以引入一个单独的组件文件，引入的路径是以`docs`目录作为根目录
 
 ```md
 :::demo src=examples/Input.vue
 :::
 ```
 
-![use-file](../../assets/use-file.png)
+![use-file](./assets/use-file.png)
diff --git a/packages/container/package.json b/packages/container/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@vitepress-code-preview/container",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "preview component of code and component in vitepress",
   "keywords": [
     "Vite",
@@ -28,6 +28,7 @@
   "files": [
     "dist",
     "README.md",
+    "CHANGELOG.md",
     "package.json",
     "LICENSE"
   ],

diff --git a/packages/plugin/CHANGELOG.md b/packages/plugin/CHANGELOG.md
@@ -1,15 +1,19 @@
 # @vitepress-code-preview/plugin
 
-## 1.0.0
+## 1.0.3
 
-### Release
+### Patch Changes
 
-## 1.0.1
+- update README
+
+## 1.0.2
 
 ### Patch Changes
 
-## 1.0.2
+## 1.0.1
 
 ### Patch Changes
 
-- update README
+## 1.0.0
+
+### Release
diff --git a/packages/plugin/README.md b/packages/plugin/README.md
@@ -1,28 +1,28 @@
 <div align="center">
 	<h1 style="margin:10px">vitepress-code-preview</h1>
-	<h6 align="center">一款在 vitepress 文档中嵌入 Vue 示例代码的插件, 支持 SFC, JSX, TSX</h6>
+	<h6 align="center">一款给 vitepress 文档中嵌入的 Vue 示例代码增加演示功能的插件, 支持 SFC, JSX, TSX</h6>
 </div>
 
 ## 🎉 简介
 
-本项目基于 `vitepress`、 `markdown-it` 和 `unified` 实现，它可以帮助你在编写文档的时候嵌入 Vue 示例，支持的 Vue 组件形式有 SFC, JSX, TSX
+本插件基于 `vitepress`、 `markdown-it` 和 `unified` 实现，它可以帮助你在编写文档的时候，对嵌入的 Vue 示例代码增加演示功能，支持的 Vue 组件形式有 SFC, JSX, TSX
 
 ## 🏄‍♂️ 插件包
 
-| Package                                            | Version (click for changelogs)                                                                                |
-| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| [@vitepress-code-preview/container](../container/) | [![container version](https://badgen.net/npm/v/@vitepress-code-preview/container)](../container/CHANGELOG.md) |
-| [@vitepress-code-preview/plugin](./)               | [![plugin version](https://badgen.net/npm/v/@vitepress-code-preview/plugin)](CHANGELOG.md)                    |
+| Package                                                 | Version (click for changelogs)                                                                                      |
+| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [@vitepress-code-preview/container](packages/container) | [![container version](https://badgen.net/npm/v/@vitepress-code-preview/container)](packages/container/CHANGELOG.md) |
+| [@vitepress-code-preview/plugin](packages/plugin)       | [![plugin version](https://badgen.net/npm/v/@vitepress-code-preview/plugin)](packages/plugin/CHANGELOG.md)          |
 
-## ⚙️ 安装
+## ⚙ 安装
 
 ```sh
 pnpm add @vitepress-code-preview/container @vitepress-code-preview/plugin
 ```
 
-## ⚡ 快速上手
+## 🚀 引入
 
-编辑你的`docs/vite.config.ts`，注册 Vite 插件，如果需要支持 JSX 组件，请安装 `@vitejs/plugin-vue-jsx`
+- ① 编辑`docs/vite.config.ts`，注册 Vite 插件，如果需要支持 JSX 组件，请安装 `@vitejs/plugin-vue-jsx`
 
 ```ts
 import { defineConfig } from 'vite'
@@ -33,7 +33,7 @@ export default defineConfig({
 })
 ```
 
-编辑你的`.vitepress/config.ts`，注册 markdown 插件
+- ② 编辑`.vitepress/config.ts`，注册 markdown 插件
 
 ```ts
 import { fileURLToPath, URL } from 'node:url'
@@ -50,7 +50,7 @@ export default defineConfig({
 })
 ```
 
-编辑你的`.vitepress/theme/index.ts`，注册组件容器
+- ③ 编辑`.vitepress/theme/index.ts`，注册组件容器
 
 ```ts
 import type { Theme } from 'vitepress'
@@ -68,6 +68,8 @@ export default {
 
 ### 💡 基础用法
 
+在`demo`容器中直接编写`vue`代码
+
 ````md
 :::demo
 
@@ -84,7 +86,7 @@ const title = ref('this is basic demo')
 :::
 ````
 
-![basic-demo](../../assets/basic-demo.png)
+![basic-demo](./assets/basic-demo.png)
 
 ### 💪 支持 JSX 和 TSX
 
@@ -105,9 +107,22 @@ export default defineComponent({
 :::
 ````
 
-![support-jsx-tsx](../../assets/support-jsx-tsx.png)
+![support-jsx-tsx](./assets/support-jsx-tsx.png)
+
+### ✨ 使用其他已注册的组件
+
+假设我们有一个第三方的`Button`组件已经在`.vitepress/theme/index.ts`中注册过了，那么就可以在`demo`容器中使用它
 
-### 💡 使用其他组件
+```ts
+// ...
+export default {
+  ...DefaultTheme,
+  enhanceApp(ctx) {
+    // ...
+    useComponents(app, Button, Button.name)
+  },
+} satisfies Theme
+```
 
 ````md
 :::demo
@@ -126,13 +141,15 @@ export default defineComponent({
 :::
 ````
 
-![other-component](../../assets/other-component.png)
+![other-component](./assets/other-component.png)
+
+### ⚡ 直接引入组件文件
 
-### 🐱‍👤 还支持文件引入的方式
+如果你的示例代码比较多，在 markdown 中直接写会比较麻烦，那么可以引入一个单独的组件文件，引入的路径是以`docs`目录作为根目录
 
 ```md
 :::demo src=examples/Input.vue
 :::
 ```
 
-![use-file](../../assets/use-file.png)
+![use-file](./assets/use-file.png)