Skip to content

Commit 221b12e

Browse files
13OnTheCode13OnTheCode
committed
chore: initialize repo
0 parents  commit 221b12e

13 files changed

+4537
-0
lines changed

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.idea
2+
.vscode
3+
.env
4+
.DS_Store
5+
6+
node_modules
7+
dist

‎.npmrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
engine-strict=true
2+
public-hoist-pattern[]=!*

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright © 2023-PRESENT [13OnTheCode](https://github.com./13OnTheCode)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.CN.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Commit-X
2+
3+
[![NPM version](https://img.shields.io/npm/v/commit-x?color=f14e32&label=)](https://www.npmjs.com/package/commit-x)
4+
[![License](https://img.shields.io/badge/license-MIT-blue.svg?color=f14e32&label=)](LICENSE.md)
5+
6+
[English](README.md) | 简体中文
7+
8+
一个命令行工具，允许你通过交互式方式生成符合 [Conventional Commits](https://www.conventionalcommits.org) 规范的 Git 提交消息，并自动进行提交
9+
10+
## Features
11+
12+
- 友好的交互式界面
13+
- 无需前置配置，无需适配器，没有额外的步骤
14+
- 自动校验提交消息是否符合规范，并给出错误提示和建议
15+
16+
## Install
17+
18+
### Global
19+
20+
为了全局访问和便于使用，建议在系统上全局安装 commit-x:
21+
22+
```bash
23+
npm install commit-x -g
24+
```
25+
26+
### Project-Specific
27+
28+
如果你更喜欢项目中的安装:
29+
30+
```bash
31+
npm install commit-x --save-dev
32+
```
33+
34+
## Usage
35+
36+
在终端中执行以下命令:
37+
38+
```bash
39+
commit-x
40+
```
41+
42+
按照提示逐步填写提交消息的内容，并确认后，它将被自动提交到你的 Git 仓库
43+
44+
## License
45+
46+
[MIT](LICENSE.md) License © 2023-PRESENT [13OnTheCode](https://github.com./13OnTheCode)

‎README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Commit-X
2+
3+
[![NPM version](https://img.shields.io/npm/v/commit-x?color=f14e32&label=)](https://www.npmjs.com/package/commit-x)
4+
[![License](https://img.shields.io/badge/license-MIT-blue.svg?color=f14e32&label=)](LICENSE.md)
5+
6+
English | [简体中文](README.CN.md)
7+
8+
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.
9+
10+
## Features
11+
12+
- User-friendly interactive interface
13+
- No upfront configuration, no adapters required, no extra steps
14+
- Automatic validation of commit messages to ensure compliance with the specification, with error messages and suggestions
15+
16+
## Install
17+
18+
### Global
19+
20+
For global access and ease of use, it's recommended to install commit-x globally on your system:
21+
22+
```bash
23+
npm install commit-x -g
24+
```
25+
26+
### Project-Specific
27+
28+
If you prefer project-specific installations:
29+
30+
```bash
31+
npm install commit-x --save-dev
32+
```
33+
34+
## Usage
35+
36+
Run the following command in your terminal:
37+
38+
```bash
39+
commit-x
40+
```
41+
42+
Follow the prompts to fill in the commit message details, and it will be automatically committed to your Git repository
43+
44+
## License
45+
46+
[MIT](LICENSE.md) License © 2023-PRESENT [13OnTheCode](https://github.com./13OnTheCode)

‎eslint.config.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { javascript, node, typescript } from '@13onthecode/eslint-config'
2+
3+
export default [
4+
node,
5+
javascript,
6+
typescript
7+
]

‎package.json

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"name": "commit-x",
3+
"description": "A CLI tool for interactive, Conventional Commits compliant Git commits",
4+
"version": "0.0.1",
5+
"type": "module",
6+
"license": "MIT",
7+
"homepage": "https://github.com./13OnTheCode/commit-x#readme",
8+
"bugs": "https://github.com./13OnTheCode/commit-x/issues",
9+
"author": {
10+
"name": "13OnTheCode",
11+
"email": "[email protected]",
12+
"url": "https://ryongyon.com"
13+
},
14+
"repository": {
15+
"type": "git",
16+
"url": "https://github.com./13OnTheCode/commit-x.git"
17+
},
18+
"keywords": [
19+
"git",
20+
"commit",
21+
"conventional-commits"
22+
],
23+
"publishConfig": {
24+
"access": "public"
25+
},
26+
"engines": {
27+
"node": ">=16"
28+
},
29+
"packageManager": "[email protected]",
30+
"scripts": {
31+
"build": "unbuild",
32+
"test": "node ./dist/cli.mjs",
33+
"clean": "pnpm dlx rimraf node_modules dist"
34+
},
35+
"dependencies": {
36+
"@clack/prompts": "^0.6.3",
37+
"colorette": "^2.0.20"
38+
},
39+
"devDependencies": {
40+
"@13onthecode/eslint-config": "^1.1.3",
41+
"@types/node": "^20.4.5",
42+
"eslint": "^8.45.0",
43+
"typescript": "^5.1.6",
44+
"unbuild": "^1.2.1"
45+
},
46+
"bin": {
47+
"commit-x": "./dist/cli.mjs"
48+
},
49+
"files": [
50+
"dist",
51+
"LICENSE.md",
52+
"CHANGELOG.md",
53+
"README.md",
54+
"README.CN.md"
55+
],
56+
"unbuild": {
57+
"rollup": {
58+
"esbuild": {
59+
"target": "esnext",
60+
"minify": true
61+
}
62+
}
63+
}
64+
}

0 commit comments

Comments
 (0)