Merge pull request #1 from biaov/release/v2.0.0

Release/v2.0.0

.gitignore

@@ -0,0 +1,2 @@
+dist
+node_modules

.ncurc.json

@@ -0,0 +1,4 @@
+{
+  "upgrade": true,
+  "reject": []
+}

.prettierignore

@@ -0,0 +1,12 @@
+# 目录
+*.git/
+dist/
+lib/
+node_modules/
+
+# 文件
+.npmignore
+.prettierignore
+.prettierrc
+LICENSE
+package-lock.json

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "printWidth": 200,
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "auto",
+  "htmlWhitespaceSensitivity": "ignore"
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 biaov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# MIT License
+
+Copyright (c) 2023-present biaov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,55 @@
-# auto-cli
-一个将多个命令简化成一个命令的项目
+# mine-auto-cli
+
+一个将多个命令简化成一个命令的项目 😆
+
+<h2 align="center">
+  <a href="https://www.npmjs.com/package/mine-auto-cli"><img src="https://img.shields.io/npm/v/mine-auto-cli.svg?logo=npm" /></a>
+  <a href="https://www.npmjs.com/package/mine-auto-cli"><img src="https://img.shields.io/npm/dt/mine-auto-cli?logo=Markdown" /></a>
+  <a href="https://www.npmjs.com/package/mine-auto-cli"><img src="https://packagephobia.com/badge?p=mine-auto-cli" /></a>
+  <a href="https://github.com/biaov/mine-auto-cli/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?logo=Unlicense" /></a>
+</h2>
+
+## 使用
+
+- 简化 Git 提交命令
+
+```sh
+auto git [描述]
+# 等同于
+git add -A
+git commit -m [描述]
+git push
+```
+
+- 简化打包提交命令
+
+```sh
+auto build[:环境] [描述]
+# 等同于
+npm run build:staging
+git add -A
+git commit -m [描述]
+git push
+```
+
+### 技术栈
+
+- `Vite` + `TypeScript` + `Node`
+
+### 依赖特性
+
+- `chalk`: 字体颜色
+- `commander`: 命令
+- `log-symbols`: 图标
+- `ora`: 动画效果
+- `update-notifier`: 检查更新
+- `@types/node`: `node` 类型
+- `@types/update-notifier`: `update-notifier` 类型
+- `chokidar`: 监听文件更改
+- `prettier`: 格式化工具
+- `typescript`: 编程语言
+- `vite`: 项目构建工具
+
+## 贡献者们
+
+[![贡献者](https://contrib.rocks/image?repo=biaov/mine-auto-cli)](https://github.com/biaov/mine-auto-cli/graphs/contributors)

bin/mine-auto-cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../index.js'