feat: 新建行为准则

xparcai · Jun 25, 2024 · 8b775d8 · 8b775d8
1 parent 79d7b41
commit 8b775d8
Show file tree

Hide file tree

Showing 13 changed files with 4,900 additions and 4,018 deletions.
diff --git a/.gitignore b/.gitignore
@@ -98,6 +98,5 @@ dist-*
 **/types/auto-*.d.ts
 
 # build runtime
-**/rollup.config-*.*
-
-**/*.md
+**/rollup.config*.*
+**/vite.config.ts*.*
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,8 +1,4 @@
 {
-  // Enable the ESlint flat config support
-  // (remove this if your ESLint extension above v3.0.5)
-  "eslint.experimental.useFlatConfig": true,
-
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
   "editor.formatOnSave": false,

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,45 @@
+# 贡献者公约行为准则
+
+## 承诺
+
+为了促进一个开放和包容的环境，作为贡献者和维护者，我们承诺为每个人提供无骚扰的参与项目和社区的体验，无论年龄、身体大小、残疾、种族、性别特征、性别认同和表达、经验水平、教育、社会经济地位、国籍、个人外貌、种族、宗教或性别认同和取向等。
+
+## 行为标准
+
+促进积极环境的行为准则：
+
+- 使用欢迎和包容性的语言
+- 尊重不同的观点和经验
+- 欢迎建设性批评
+- 关注社区最新最好的技术，行为准则等
+- 对其他社区成员展示友好
+
+不可接受行为示例：
+
+- 性化语言或图像等
+- 挑衅、侮辱、贬低的评论和个人或政治攻击
+- 骚扰
+- 未经明确允许，发布他人的私人信息
+- 其他在职业环境中可以被视为不合适的行为
+
+## 责任感
+
+项目维护者负责明确可接受行为的标准，并应对任何不可接受行为采取适当和公正的纠正措施。
+
+项目维护者有权和责任删除、编辑或拒绝评论、提交、代码、wiki、issue和其他不符合本行为准则的贡献，暂时或永久禁止任何贡献者参与其他不适当、具有威胁性、冒犯性或有害的行为。
+
+## 范围
+
+本行为准则适用于所有项目，并且当个人在公共空间代表项目或其社区时也适用。代表项目或社区的示例包括使用官方项目电子邮件地址，通过官方社交媒体账户发布内容，或在在线或离线活动中担任指定代表。项目的代表可以由项目维护者进一步定义和澄清。
+
+## 执行
+
+如有骚扰或其他不可接受的行为，可以通过联系项目团队（hi@vtrbo.cn）来报告。所有投诉将被审理和调查，在必要和适当的情况下会给予答复。项目团队将会对事件的报告者保密。特定的进一步详细信息可能会单独发布。
+
+不遵守或不诚信执行行为准则的项目维护人员可能会面临由项目管理者或其他成员决定的暂时或永久的封禁。
+
+## 版权声明
+
+本行为准则改编自贡献者公约，版本1.4，可在https://www.contributor-covenant.org/version/1/4/code-of-conduct.html获得。
+
+有关此行为准则的常见问题的答案，请参见https://www.contributor-covenant.org/faq。
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -70,8 +70,11 @@
      - 点击 Create pull request
      - 剩下你自己摸索吧少年，再写文档，还不如回家做草鞋。
 6. 当你的pr被作者通过后，那么，你就会发现，参与者的头像里，多了一个你，此时，你就能向你的面试官吹牛逼了，放肆大胆的吹牛逼
+
 ## 寄刀片地址
+
 如果你的pr没能快速的被处理，可以给作者寄刀片
+
 ```
 作者：
     Victor Bo

diff --git a/README.md b/README.md
@@ -7,16 +7,16 @@
 
 <p align="center">
   <img src="https://img.shields.io/badge/npm-v0.0.1-brightgreen" />
-  <img src="https://img.shields.io/badge/-Rollup-34495e?logo=rollup" />
+  <img src="https://img.shields.io/badge/-pnpm-F69220?logo=pnpm&logoColor=white" />
   <img src="https://img.shields.io/badge/-TypeScript-blue?logo=typescript&logoColor=white" />
+  <img src="https://img.shields.io/badge/-Rollup-34495e?logo=rollup" />
   <img src="https://img.shields.io/badge/-ESLint-4b32c3?logo=eslint&logoColor=white" />
-  <img src="https://img.shields.io/badge/-pnpm-F69220?logo=pnpm&logoColor=white" />
   <img src="https://img.shields.io/badge/-Prettier-ef9421?logo=Prettier&logoColor=white" alt="Prettier">
-  <img src="https://img.shields.io/badge/license-Apache-blue.svg" alt="Apache">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT">
 <p>
 你的救星，小趴菜工具库，一个轻量级的轮子集合，它来了~~~!
 
-[使用文档介绍](https://xparcai.github.io/xparcai-utils/) | [参与文档介绍](https://github.com/xparcai/xparcai-utils/blob/main/CONTRIBUTING.md)
+[使用文档介绍](https://xparcai.github.io/xparcai-utils/) | [参与文档介绍](./CONTRIBUTING.md)
 
 # 特点
 
@@ -40,10 +40,6 @@ yarn add xparcai-utils
 pnpm add xparcai-utils
 ```
 
-> 如果你不想在项目中引入太多依赖，而又想使用某一个方法
->
-> 那么可以复制文档中的源码，在你的项目中引入
-
 ### CDN源
 
 ```bash
@@ -65,13 +61,14 @@ const obj2 = deepCopy(obj)
 // { a: '123', b: 456 }
 ```
 
-## **参与者**
+## 贡献者
+
+有兴趣做出贡献的开发者应该阅读 [行为准则](./CODE_OF_CONDUCT.md) 和 [贡献指南](./CONTRIBUTING.md)。
 
-这个项目需要感谢的参与者
+感谢所有为 `xparcai-utils` 做出贡献的开发者！
 
 <div align="left">
   <a href="https://github.com/xparcai/xparcai-utils/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=xparcai/xparcai-utils" />
   </a>
 </div>
-<!-- 🍒🍇🫑 Collection of common JavaScript or TypeScript utils. -->
diff --git a/package.json b/package.json
@@ -79,6 +79,6 @@
     "commit-msg": "npm run precommit"
   },
   "lint-staged": {
-    "*": "npm run lint --fix"
+    "*": "npm run lint:fix"
   }
 }
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -24,7 +24,11 @@
     "tools"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "browser": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "exports": {
     ".": {
@@ -34,10 +38,8 @@
       "browser": "./dist/index.js"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.d.ts",
   "files": [
     "README.md",
     "dist"

diff --git a/packages/is/package.json b/packages/is/package.json
@@ -24,7 +24,11 @@
     "tools"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "browser": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "exports": {
     ".": {
@@ -34,10 +38,8 @@
       "browser": "./dist/index.js"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.d.ts",
   "files": [
     "README.md",
     "dist"

diff --git a/packages/object/package.json b/packages/object/package.json
@@ -24,7 +24,11 @@
     "tools"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "browser": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "exports": {
     ".": {
@@ -34,10 +38,8 @@
       "browser": "./dist/index.js"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.d.ts",
   "files": [
     "README.md",
     "dist"

diff --git a/packages/string/package.json b/packages/string/package.json
@@ -24,7 +24,11 @@
     "tools"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "browser": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "exports": {
     ".": {
@@ -34,10 +38,8 @@
       "browser": "./dist/index.js"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.d.ts",
   "files": [
     "README.md",
     "dist"

diff --git a/packages/tool/package.json b/packages/tool/package.json
@@ -24,7 +24,11 @@
     "tools"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "browser": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "exports": {
     ".": {
@@ -34,10 +38,8 @@
       "browser": "./dist/index.js"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "browser": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.d.ts",
   "files": [
     "README.md",
     "dist"