breadc 1.0.0-beta.2 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -11
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
# 🥪 Breadc
|
|
2
2
|
|
|
3
|
-
[](https://deepwiki.com/yjl9903/Breadc)
|
|
4
|
+
[](https://www.npmjs.com/package/breadc)
|
|
5
|
+
[](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml)
|
|
6
|
+
[](https://codecov.io/gh/yjl9903/Breadc)
|
|
4
7
|
|
|
5
|
-
Yet another Command Line Application Framework
|
|
8
|
+
Yet another **Command Line Application Framework** desgined for **[TypeScript](https://www.typescriptlang.org/)**.
|
|
6
9
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
+
- **TypeScript Infer**: infer command arguments, option values, and action signatures in IDE automatically
|
|
11
|
+
- **Command**: support default command, command alias, and nested sub-commands like `git remote add <name> <url>`
|
|
12
|
+
- **Group**: organize commands by modules and build large multi-command CLI applications with clear structure
|
|
13
|
+
- **Option**: support boolean, required, optional, spread options, `--no-*` negation, and `--` passthrough arguments
|
|
14
|
+
- **Middleware**: support middleware pipeline and unknown option handling
|
|
15
|
+
- **Builtin CLI Features**: provide common help / version options and i18n support out of the box
|
|
16
|
+
- **Toolkits**: contains many useful tools to build your next CLI application, such as [ansi color](https://github.com/yjl9903/Breadc/tree/main/packages/color), [process death handler](https://github.com/yjl9903/Breadc/tree/main/packages/death), [shell compelete script generation](https://github.com/yjl9903/Breadc/tree/main/packages/complete) and so on.
|
|
10
17
|
|
|
11
|
-
|
|
12
|
-
+ 💻 **Commands**: support default command, command alias and sub-commands like `git remote add <name> <url>`;
|
|
13
|
-
+ 📖 **East to Learn**: very similar with [commander.js](https://github.com/tj/commander.js/), [cac](https://github.com/cacjs/cac) and there are only 5 APIs for building a CLI application: `breadc`, `command`, `option`, `action`, `run`.
|
|
14
|
-
+ 🧰 **Toolkits**: contains many useful tools to build your next CLI application, such as [ansi color](https://github.com/yjl9903/Breadc/tree/main/packages/color), [process death handler](https://github.com/yjl9903/Breadc/tree/main/packages/death), [shell compelete script generation](https://github.com/yjl9903/Breadc/tree/main/packages/complete) and so on.
|
|
18
|
+
|
|
15
19
|
|
|
16
20
|
## Installation
|
|
17
21
|
|
|
@@ -46,8 +50,9 @@ If you are using IDEs that support TypeScript (like [Visual Studio Code](https:/
|
|
|
46
50
|
|
|
47
51
|
## Inspiration
|
|
48
52
|
|
|
49
|
-
|
|
50
|
-
|
|
53
|
+
- [cac](https://github.com/cacjs/cac): Simple yet powerful framework for building command-line apps.
|
|
54
|
+
- [Commander.js](https://github.com/tj/commander.js): Node.js command-line interfaces made easy.
|
|
55
|
+
- [TypeScript: Documentation - Template Literal Types](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html)
|
|
51
56
|
|
|
52
57
|
## License
|
|
53
58
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "breadc",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.3",
|
|
4
4
|
"description": "Yet another Command Line Application Framework with fully strong TypeScript support",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"breadc",
|
|
@@ -33,10 +33,10 @@
|
|
|
33
33
|
"dist"
|
|
34
34
|
],
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@breadc/color": "1.0.0-beta.
|
|
37
|
-
"@breadc/core": "1.0.0-beta.
|
|
38
|
-
"@breadc/
|
|
39
|
-
"@breadc/
|
|
36
|
+
"@breadc/color": "1.0.0-beta.3",
|
|
37
|
+
"@breadc/core": "1.0.0-beta.3",
|
|
38
|
+
"@breadc/death": "1.0.0-beta.3",
|
|
39
|
+
"@breadc/tui": "1.0.0-beta.3"
|
|
40
40
|
},
|
|
41
41
|
"scripts": {
|
|
42
42
|
"build": "tsdown",
|