breadc 0.1.1 → 0.4.0

package/README.md

@@ -2,7 +2,13 @@
 
 [![version](https://img.shields.io/npm/v/breadc?color=rgb%2850%2C203%2C86%29&label=Breadc)](https://www.npmjs.com/package/breadc) [![CI](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml/badge.svg)](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml)
 
-Yet another Command Line Application Framework powered by [minimist](https://www.npmjs.com/package/minimist), but with fully [TypeScript](https://www.typescriptlang.org/) support.
+Yet another Command Line Application Framework powered by [minimist](https://www.npmjs.com/package/minimist), but with fully strong [TypeScript](https://www.typescriptlang.org/) support.
+
+## Features
+
++ ⚡️ **Light-weight**: Only 61 kB.
++ 📖 **East to Learn**: Breadc is basically compatible with [cac](https://github.com/cacjs/cac) and there are only 4 APIs for building a CLI application: `command`, `option`, `action`, `run`.
++ 💻 **TypeScript Infer**: IDE will automatically infer the type of your command action function.
 
 ## Installation
 
@@ -12,36 +18,35 @@ npm i breadc
 
 ## Usage
 
-See [./examples/echo.ts](./examples/echo.ts).
+Try [./examples/echo.ts](./examples/echo.ts).
 
 ```ts
 import Breadc from 'breadc'
 
 const cli = Breadc('echo', { version: '1.0.0' })
-  .option('--host <host>')
-  .option('--port <port>')
+  .option('--host <host>', { default: 'localhost' })
+  .option('--port <port>', { construct: (port) => (port ? +port : 3000) });
 
 cli
-  .command('[message]')
+  .command('[message]', 'Say something!')
   .action((message, option) => {
-    console.log(message ?? 'You can say anything!')
-    console.log(`Host: ${option.host}`)
-    console.log(`Port: ${option.port}`)
+    const host = option.host;
+    const port = option.port;
+    console.log(`Host: ${host}`);
+    console.log(`Port: ${port}`);
   })
 
 cli.run(process.argv.slice(2))
   .catch(err => cli.logger.error(err.message))
 ```
 
-If you are using IDEs that support TypeScript (like [Visual Studio Code](https://code.visualstudio.com/)), move your cursor to the parameter `option` in this `dev` command, and then you will find the `option` is automatically typed with `{ host: string, port: string }` or `Record<'host' | 'port', string>`.
-
-![vscode1](./images/vscode1.png)
+If you are using IDEs that support TypeScript (like [Visual Studio Code](https://code.visualstudio.com/)), move your cursor to the parameter `option` in the default command, and then you will find the `option` is automatically typed with `{ host: string | boolean, port: string | boolean }`.
 
-![vscode2](./images/vscode2.png)
+![vscode](./images/vscode.png)
 
 ### Limitation
 
-For the limitation of TypeScript, in the command format string, you can only write up to **4** pieces. That is to say, you can only write format string like `<p1> <p2> <p3> <p4>`, but `<p1> <p2> <p3> <p4> <p5>` does not work.
+For the limitation of TypeScript, in the command format string, you can only write up to **5** pieces. That is to say, you can only write format string like `<p1> <p2> <p3> <p4> [p5]`, but `<p1> <p2> <p3> <p4> <p5> [p6]` does not work.
 
 You should always use method chaining when registering options and commands. The example below will fail to infer the option `--host`.