🚀 新增: 添加文档

.cz-config.js

@@ -5,7 +5,7 @@ module.exports = {
     { value: '🐛 修复  ', name: '修复:  修复一个Bug' },
     { value: '📝 文档  ', name: '文档:  变更的只有文档' },
     { value: '🏠 格式  ', name: '格式:  空格, 分号等格式修复' },
-    { value: '♻️ 重构  ', name: '重构:  代码重构，注意和特性、修复区分开' },
+    { value: '♻️ 优化  ', name: '优化:  代码重构, 提升性能, 优化语法' },
     { value: '⚡️ 性能  ', name: '性能:  提升性能' },
     { value: '✅ 测试  ', name: '测试:  添加一个测试' },
     { value: '🔨 工具  ', name: '工具:  开发工具变动(构建、脚手架工具等)' },

.release-it.json

@@ -0,0 +1,25 @@
+{
+  "git": {
+    "tag": true,
+    "tagName": "v${version}",
+    "tagAnnotation": "Release %s",
+    "commit": true,
+    "commitMessage": "版本更新: release %s",
+    "commitArgs": ["-S"],
+    "push": true,
+    "pushArgs": ["--follow-tags"],
+    "requireCleanWorkingDir": false,
+    "requireCommits": false
+  },
+  "github": {
+    "release": true,
+    "allowSameVersion": true,
+    "ignoreVersion": true,
+    "draft": false
+  },
+  "npm": {
+    "publish": true,
+    "allowSameVersion": true,
+    "ignoreVersion": true
+  }
+}

CHANGELOG.md

@@ -0,0 +1 @@
+[更新日志](http://js.warblerfe.top:5273/changelog.html)

README.md

@@ -6,20 +6,6 @@
  * @FilePath: \warbler-js\README.md
 -->
 
-# 简介
-
-## 安装
-
-### 通过 npm
-
-```js
-npm i --save warbler-js
-```
-
-## 什么是 warbler-js
-
-`warbler-js` 是一个 `JavaScript` 实用工具库。
-
 ## 说明文档
 
 👉👉 [warbler-js](http://www.warblerfe.top/warbler/js)
@@ -32,6 +18,4 @@ npm i --save warbler-js
 
 👉👉 [github](https://github.com/alanhzw)
 
-👉👉 [gitee](https://gitee.com/hzw_0174)
-
-👉👉 [个人博客](http://www.warblerfe.top/warbler/js)
+👉👉 [个人博客](http://www.warblerfe.top)

docs/.vitepress/config.ts

@@ -9,6 +9,7 @@ export default defineConfig({
   lastUpdated: true,
   appearance: 'dark',
   themeConfig: {
+    outlineTitle: '目录',
     siteTitle: 'warbler-js',
     nav: [],
     docFooter: {

docs/.vitepress/sidebar/index.ts

@@ -2,7 +2,7 @@
  * @Author: 一尾流莺
  * @Description:获取 sidebar
  * @Date: 2023-03-28 16:27:35
- * @LastEditTime: 2023-08-24 18:13:44
+ * @LastEditTime: 2023-08-24 18:47:53
  * @FilePath: \warbler-js\docs\.vitepress\sidebar\index.ts
  */
 
@@ -72,10 +72,12 @@ function generateTree(directory) {
     } else {
       // 去掉文件的后缀
       const fileName = file.split('.')[0];
+      const link = `/guide${filePath.split('guide')[1].replaceAll('\\', '/')}`;
+      console.log(`- [${fileName}](${link})`);
       // 如果是一个文件，则直接添加到当前层级的树中
       tree.push({
         text: fileName,
-        link: `/guide${filePath.split('guide')[1].replaceAll('\\', '/')}`,
+        link: link,
       });
     }
   });

docs/changelog.md

@@ -1 +1,134 @@
-# 1.0.0(2023-08-24)
+---
+layout: doc
+lastUpdated: true
+outline: 1
+---
+
+# 🌈 1.0.0 **(2023-08-24)**
+
+## 🚀 新增
+
+### 🅰️ 数组
+
+- [计算对象数组中某个属性值的出现次数](/guide/array/calculation/计算对象数组中某个属性值的出现次数.md)
+- [计算对象数组指定健的平均值](/guide/array/calculation/计算对象数组指定健的平均值.md)
+- [计算对象数组某个属性值的总和](/guide/array/calculation/计算对象数组某个属性值的总和.md)
+- [计算数组中元素的出现次数](/guide/array/calculation/计算数组中元素的出现次数.md)
+- [计算数组元素的总和](/guide/array/calculation/计算数组元素的总和.md)
+- [检测所有元素是否符合要求](/guide/array/check/检测所有元素是否符合要求.md)
+- [删除对象数组中的重复元素](/guide/array/duplicate/删除对象数组中的重复元素.md)
+- [删除数组中的重复元素](/guide/array/duplicate/删除数组中的重复元素.md)
+- [过滤数组中的唯一值](/guide/array/filter/过滤数组中的唯一值.md)
+- [过滤数组中的非唯一值](/guide/array/filter/过滤数组中的非唯一值.md)
+- [根据对象的键值在数组中查找对象](/guide/array/find/根据对象的键值在数组中查找对象.md)
+- [获取两个数组之间不同的元素](/guide/array/find/获取两个数组之间不同的元素.md)
+- [获取两个数组之间相同的元素](/guide/array/find/获取两个数组之间相同的元素.md)
+- [获取数组中指定个数的最大元素](/guide/array/find/获取数组中指定个数的最大元素.md)
+- [获取数组中指定个数的最小元素](/guide/array/find/获取数组中指定个数的最小元素.md)
+- [获取数组二相对于数组一不同的元素](/guide/array/find/获取数组二相对于数组一不同的元素.md)
+- [随机化数组元素的顺序](/guide/array/other/随机化数组元素的顺序.md)
+- [根据元素值移除数组的元素](/guide/array/remove/根据元素值移除数组的元素.md)
+- [根据函数名称移除函数数组的元素](/guide/array/remove/根据函数名称移除函数数组的元素.md)
+- [根据对象数组的属性值移除数组的元素](/guide/array/remove/根据对象数组的属性值移除数组的元素.md)
+
+### 🅱️ 布尔值
+
+- [获得一个随机的布尔值](/guide/boolean/获得一个随机的布尔值.md)
+
+### 🕒 日期
+
+- [判断指定日期是不是 n 天前](/guide/date/判断指定日期是不是n天前.md)
+- [判断指定日期是不是 n 天后](/guide/date/判断指定日期是不是n天后.md)
+- [判断指定日期是不是今天](/guide/date/判断指定日期是不是今天.md)
+- [判断是否达到指定时间](/guide/date/判断是否达到指定时间.md)
+- [获取两个日期之间的差值](/guide/date/获取两个日期之间的差值.md)
+- [获取指定日期是所在年份的第几天](/guide/date/获取指定日期是所在年份的第几天.md)
+
+### 🚩 常用方法
+
+- [异步加载 script 脚本](/guide/methods/异步加载script脚本.md)
+- [模拟延迟](/guide/methods/模拟延迟.md)
+- [滚动到页面顶部](/guide/methods/滚动到页面顶部.md)
+- [获取当前页面的 URL](/guide/methods/获取当前页面的URL.md)
+- [获取浏览器 Cookie 的值](/guide/methods/获取浏览器Cookie的值.md)
+
+### 🔢 数字
+
+- [判断一个数字是不是偶数](/guide/number/判断一个数字是不是偶数.md)
+- [判断一个数字是不是奇数](/guide/number/判断一个数字是不是奇数.md)
+- [判断数字是否可以整除](/guide/number/判断数字是否可以整除.md)
+- [求平均值](/guide/number/求平均值.md)
+- [生成范围内的随机数](/guide/number/生成范围内的随机数.md)
+- [生成范围内的随机整数](/guide/number/生成范围内的随机整数.md)
+
+### 🎯 正则
+
+- [12 小时制时间](/guide/reg/12小时制时间.md)
+- [16 进制颜色](/guide/reg/16进制颜色.md)
+- [24 小时制时间](/guide/reg/24小时制时间.md)
+- [base64 格式](/guide/reg/base64格式.md)
+- [GUID 或 UUID](/guide/reg/GUID或UUID.md)
+- [ip-v4](/guide/reg/ip-v4.md)
+- [mac 地址](/guide/reg/mac地址.md)
+- [QQ 号](/guide/reg/QQ号.md)
+- [不能包含字母](/guide/reg/不能包含字母.md)
+- [中国手机号(严格)](</guide/reg/中国手机号(严格).md>)
+- [中国手机号(复杂)](</guide/reg/中国手机号(复杂).md>)
+- [中国手机号(简单)](</guide/reg/中国手机号(简单).md>)
+- [中文](/guide/reg/中文.md)
+- [中文名字](/guide/reg/中文名字.md)
+- [中文和数字](/guide/reg/中文和数字.md)
+- [同时含有数字和英文字母](/guide/reg/同时含有数字和英文字母.md)
+- [图片链接地址](/guide/reg/图片链接地址.md)
+- [大写英文](/guide/reg/大写英文.md)
+- [子网掩码](/guide/reg/子网掩码.md)
+- [密码强度校验](/guide/reg/密码强度校验.md)
+- [小写英文](/guide/reg/小写英文.md)
+- [帐号是否合法](/guide/reg/帐号是否合法.md)
+- [座机](/guide/reg/座机.md)
+- [微信号](/guide/reg/微信号.md)
+- [必须带端口号的网址](/guide/reg/必须带端口号的网址.md)
+- [手机机身码(IMEI)](</guide/reg/手机机身码(IMEI).md>)
+- [护照](/guide/reg/护照.md)
+- [数字](/guide/reg/数字.md)
+- [数字和字母](/guide/reg/数字和字母.md)
+- [整数(不包含 0)](</guide/reg/整数(不包含0).md>)
+- [整数(包含 0)](</guide/reg/整数(包含0).md>)
+- [日期(年月日)](</guide/reg/日期(年月日).md>)
+- [日期(年月日时分秒)](</guide/reg/日期(年月日时分秒).md>)
+- [正整数(不包含 0)](</guide/reg/正整数(不包含0).md>)
+- [正整数(包含 0)](</guide/reg/正整数(包含0).md>)
+- [火车车次](/guide/reg/火车车次.md)
+- [版本号](/guide/reg/版本号.md)
+- [用户名校验](/guide/reg/用户名校验.md)
+- [统一社会信用代码(严格)](</guide/reg/统一社会信用代码(严格).md>)
+- [统一社会信用代码(宽松)](</guide/reg/统一社会信用代码(宽松).md>)
+- [网址](/guide/reg/网址.md)
+- [考试分数(150 分)](</guide/reg/考试分数(150分).md>)
+- [英文](/guide/reg/英文.md)
+- [英文名字](/guide/reg/英文名字.md)
+- [视频链接地址](/guide/reg/视频链接地址.md)
+- [负整数(不包含 0)](</guide/reg/负整数(不包含0).md>)
+- [负整数(包含 0)](</guide/reg/负整数(包含0).md>)
+- [货币金额](/guide/reg/货币金额.md)
+- [货币金额，支持负数](/guide/reg/货币金额，支持负数.md)
+- [身份证号（一二代）](/guide/reg/身份证号（一二代）.md)
+- [身份证号（一代）](/guide/reg/身份证号（一代）.md)
+- [身份证号（二代）](/guide/reg/身份证号（二代）.md)
+- [身份证号（台湾）](/guide/reg/身份证号（台湾）.md)
+- [身份证号（澳门）](/guide/reg/身份证号（澳门）.md)
+- [身份证号（香港）](/guide/reg/身份证号（香港）.md)
+- [车牌号（全）](/guide/reg/车牌号（全）.md)
+- [车牌号（新能源）](/guide/reg/车牌号（新能源）.md)
+- [车牌号（非新能源）](/guide/reg/车牌号（非新能源）.md)
+- [邮政编码](/guide/reg/邮政编码.md)
+- [邮箱](/guide/reg/邮箱.md)
+- [银行卡号](/guide/reg/银行卡号.md)
+
+### 🔠 字符
+
+- [反转字符串](/guide/string/反转字符串.md)
+- [将字符串中每个单词的首字母转为大写](/guide/string/将字符串中每个单词的首字母转为大写.md)
+- [将字符串按字母顺序排列](/guide/string/将字符串按字母顺序排列.md)
+- [将字符串的首字母转换成大写字母](/guide/string/将字符串的首字母转换成大写字母.md)
+- [将字符串的首字母转换成小写字母](/guide/string/将字符串的首字母转换成小写字母.md)

docs/index.md

@@ -1,7 +1,6 @@
 ---
 layout: doc
 lastUpdated: true
-sidebarDepth: 1
 ---
 
 # warbler-js
@@ -20,4 +19,10 @@ npm i warbler-js --save-dev
 
 ## 什么是 warbler-js
 
-`warbler-js` 参考了优秀的 `Lodash` ，`1loc` 等第三方库，从 `掘金`, `CSDN` 等社区的优秀文章中收集，结合作者 `一尾流莺` 的开发经验，完成了一个轻量级的 `JavaScript` 实用工具库。
+`warbler-js` 参考了优秀的 `Lodash` ，`1loc` 等第三方库，完成了一个轻量级的 `JavaScript` 实用工具库。
+
+::: tip
+
+本工具适用于学习用途，不建议在生产环境中使用。如需在生产环境中使用，请复制源代码到自己的项目中，以保障不会出现意外的问题。
+
+:::

package.json

@@ -11,7 +11,10 @@
     "commit:all": "git add . && git-cz",
     "dev": "vitepress dev docs --port 5273",
     "build": "vitepress build docs",
-    "preview": "vitepress preview docs"
+    "preview": "vitepress preview docs",
+    "release:major": "release-it --increment major",
+    "release:minor": "release-it --increment minor",
+    "release:patch": "release-it --increment patch"
   },
   "keywords": [
     "JavaScript",
@@ -37,6 +40,7 @@
     "eslint-plugin-import": "^2.27.5",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.0",
+    "release-it": "^16.1.5",
     "rimraf": "^4.4.1",
     "vite": "^4.4.9",
     "vitepress": "1.0.0-alpha.63"