-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 221b12e
Showing
13 changed files
with
4,537 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.idea | ||
.vscode | ||
.env | ||
.DS_Store | ||
|
||
node_modules | ||
dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
engine-strict=true | ||
public-hoist-pattern[]=!* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# MIT License | ||
|
||
Copyright © 2023-PRESENT [13OnTheCode](https://github.com/13OnTheCode) | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Commit-X | ||
|
||
[![NPM version](https://img.shields.io/npm/v/commit-x?color=f14e32&label=)](https://www.npmjs.com/package/commit-x) | ||
[![License](https://img.shields.io/badge/license-MIT-blue.svg?color=f14e32&label=)](LICENSE.md) | ||
|
||
[English](README.md) | 简体中文 | ||
|
||
一个命令行工具,允许你通过交互式方式生成符合 [Conventional Commits](https://www.conventionalcommits.org) 规范的 Git 提交消息,并自动进行提交 | ||
|
||
## Features | ||
|
||
- 友好的交互式界面 | ||
- 无需前置配置,无需适配器,没有额外的步骤 | ||
- 自动校验提交消息是否符合规范,并给出错误提示和建议 | ||
|
||
## Install | ||
|
||
### Global | ||
|
||
为了全局访问和便于使用,建议在系统上全局安装 commit-x: | ||
|
||
```bash | ||
npm install commit-x -g | ||
``` | ||
|
||
### Project-Specific | ||
|
||
如果你更喜欢项目中的安装: | ||
|
||
```bash | ||
npm install commit-x --save-dev | ||
``` | ||
|
||
## Usage | ||
|
||
在终端中执行以下命令: | ||
|
||
```bash | ||
commit-x | ||
``` | ||
|
||
按照提示逐步填写提交消息的内容,并确认后,它将被自动提交到你的 Git 仓库 | ||
|
||
## License | ||
|
||
[MIT](LICENSE.md) License © 2023-PRESENT [13OnTheCode](https://github.com/13OnTheCode) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Commit-X | ||
|
||
[![NPM version](https://img.shields.io/npm/v/commit-x?color=f14e32&label=)](https://www.npmjs.com/package/commit-x) | ||
[![License](https://img.shields.io/badge/license-MIT-blue.svg?color=f14e32&label=)](LICENSE.md) | ||
|
||
English | [简体中文](README.CN.md) | ||
|
||
a command-line tool that allows you to interactively generate Git commit messages that comply with the [Conventional Commits](https://www.conventionalcommits.org) specification and automatically commit them. | ||
|
||
## Features | ||
|
||
- User-friendly interactive interface | ||
- No upfront configuration, no adapters required, no extra steps | ||
- Automatic validation of commit messages to ensure compliance with the specification, with error messages and suggestions | ||
|
||
## Install | ||
|
||
### Global | ||
|
||
For global access and ease of use, it's recommended to install commit-x globally on your system: | ||
|
||
```bash | ||
npm install commit-x -g | ||
``` | ||
|
||
### Project-Specific | ||
|
||
If you prefer project-specific installations: | ||
|
||
```bash | ||
npm install commit-x --save-dev | ||
``` | ||
|
||
## Usage | ||
|
||
Run the following command in your terminal: | ||
|
||
```bash | ||
commit-x | ||
``` | ||
|
||
Follow the prompts to fill in the commit message details, and it will be automatically committed to your Git repository | ||
|
||
## License | ||
|
||
[MIT](LICENSE.md) License © 2023-PRESENT [13OnTheCode](https://github.com/13OnTheCode) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { javascript, node, typescript } from '@13onthecode/eslint-config' | ||
|
||
export default [ | ||
node, | ||
javascript, | ||
typescript | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
{ | ||
"name": "commit-x", | ||
"description": "A CLI tool for interactive, Conventional Commits compliant Git commits", | ||
"version": "0.0.1", | ||
"type": "module", | ||
"license": "MIT", | ||
"homepage": "https://github.com/13OnTheCode/commit-x#readme", | ||
"bugs": "https://github.com/13OnTheCode/commit-x/issues", | ||
"author": { | ||
"name": "13OnTheCode", | ||
"email": "[email protected]", | ||
"url": "https://ryongyon.com" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/13OnTheCode/commit-x.git" | ||
}, | ||
"keywords": [ | ||
"git", | ||
"commit", | ||
"conventional-commits" | ||
], | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"engines": { | ||
"node": ">=16" | ||
}, | ||
"packageManager": "[email protected]", | ||
"scripts": { | ||
"build": "unbuild", | ||
"test": "node ./dist/cli.mjs", | ||
"clean": "pnpm dlx rimraf node_modules dist" | ||
}, | ||
"dependencies": { | ||
"@clack/prompts": "^0.6.3", | ||
"colorette": "^2.0.20" | ||
}, | ||
"devDependencies": { | ||
"@13onthecode/eslint-config": "^1.1.3", | ||
"@types/node": "^20.4.5", | ||
"eslint": "^8.45.0", | ||
"typescript": "^5.1.6", | ||
"unbuild": "^1.2.1" | ||
}, | ||
"bin": { | ||
"commit-x": "./dist/cli.mjs" | ||
}, | ||
"files": [ | ||
"dist", | ||
"LICENSE.md", | ||
"CHANGELOG.md", | ||
"README.md", | ||
"README.CN.md" | ||
], | ||
"unbuild": { | ||
"rollup": { | ||
"esbuild": { | ||
"target": "esnext", | ||
"minify": true | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.