Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/privatenumber/cleye
👁🗨 Strongly typed CLI development for Node.js
https://github.com/privatenumber/cleye
argv cli commandline-interface commandline-parser flags node parameters typed typescript
Last synced: about 2 months ago
JSON representation
👁🗨 Strongly typed CLI development for Node.js
- Host: GitHub
- URL: https://github.com/privatenumber/cleye
- Owner: privatenumber
- License: mit
- Created: 2022-01-05T15:25:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T05:47:20.000Z (3 months ago)
- Last Synced: 2024-07-21T04:43:01.704Z (about 2 months ago)
- Topics: argv, cli, commandline-interface, commandline-parser, flags, node, parameters, typed, typescript
- Language: TypeScript
- Homepage:
- Size: 767 KB
- Stars: 482
- Watchers: 4
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
cleye
The intuitive command-line interface (CLI) development tool.
### Features
- Minimal API surface
- Powerful flag parsing
- Strongly typed parameters and flags
- Command support
- Help documentation generation (customizable too!)
→ [Try it out online](https://stackblitz.com/edit/cleye-demo?devtoolsheight=50&file=examples/greet.ts&view=editor)
Already a sponsor? Join the discussion in the Development repo!
## Install
```bash
npm i cleye
```
## About
_Cleye_ makes it very easy to develop command-line scripts in Node.js. It handles argv parsing to give you strongly typed parameters + flags and generates `--help` documentation based on the provided information.
Here's an example script that simply logs: `Good morning/evening !`:
_greet.js:_
```ts
import { cli } from 'cleye'
// Parse argv
const argv = cli({
name: 'greet.js',
// Define parameters
parameters: [
'', // First name is required
'[last name]' // Last name is optional
],
// Define flags/options
flags: {
// Parses `--time` as a string
time: {
type: String,
description: 'Time of day to greet (morning or evening)',
default: 'morning'
}
}
})
const name = [argv._.firstName, argv._.lastName].filter(Boolean).join(' ')
if (argv.flags.time === 'morning') {
console.log(`Good morning ${name}!`)
} else {
console.log(`Good evening ${name}!`)
}
```
🛠 In development, type hints are provided on parsed flags and parameters:
Type hints for Cleye's output are very verbose and readable
📖 Generated help documentation can be viewed with the `--help` flag:
```sh
$ node greet.js --help
greet.js
Usage:
greet.js [flags...] [last name]
Flags:
-h, --help Show help
--time Time of day to greet (morning or evening) (default: "morning")
```
✅ Run the script to see it in action:
```sh
$ node greet.js John Doe --time evening
Good evening John Doe!
```
## Examples
Want to dive right into some code? Check out some of these examples:
- [**greet.js**](/examples/greet/index.ts): Working example from above
- [**npm install**](/examples/npm/index.ts): Reimplementation of [`npm install`](https://docs.npmjs.com/cli/install/)'s CLI
- [**tsc**](/examples/tsc/index.ts): Reimplementation of TypeScript [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html)'s CLI
- [**snap-tweet**](/examples/snap-tweet/index.ts): Reimplementation of [`snap-tweet`](https://github.com/privatenumber/snap-tweet)'s CLI
- [**pkg-size**](/examples/pkg-size/index.ts): Reimplementation of [`pkg-size`](https://github.com/pkg-size/pkg-size)'s CLI
## Usage
### Arguments
Arguments are values passed into the script that are not associated with any flags/options.
For example, in the following command, the first argument is `file-a.txt` and the second is `file-b.txt`:
```
$ my-script file-a.txt file-b.txt
```
Arguments can be accessed from the `_` array-property of the returned object.
Example:
```ts
const argv = cli({ /* ... */ })
// $ my-script file-a.txt file-b.txt
argv._ // => ["file-a.txt", "file-b.txt"] (string[])
```
#### Parameters
Parameters (aka _positional arguments_) are the names that map against argument values. Think of parameters as variable names and arguments as values associated with the variables.
Parameters can be defined in the `parameters` array-property to make specific arguments accessible by name. This is useful for writing more readable code, enforcing validation, and generating help documentation.
Parameters are defined in the following formats:
- **Required parameters** are indicated by angle brackets (eg. ``).
- **Optional parameters** are indicated by square brackets (eg. `[parameter name]`).
- **Spread parameters** are indicated by `...` suffix (eg. `` or `[parameter name...]`).
Note, required parameters cannot come after optional parameters, and spread parameters must be last.
Parameters can be accessed in camelCase on the `_` property of the returned object.
Example:
```ts
const argv = cli({
parameters: [
'',
'[optional parameter]',
'[optional spread...]'
]
})
// $ my-script a b c d
argv._.requiredParameter // => "a" (string)
argv._.optionalParameter // => "b" (string | undefined)
argv._.optionalSpread // => ["c", "d"] (string[])
```
#### End-of-flags
End-of-flags (`--`) (aka _end-of-options_) allows users to pass in a subset of arguments. This is useful for passing in arguments that should be parsed separately from the rest of the arguments or passing in arguments that look like flags.
An example of this is [`npm run`](https://docs.npmjs.com/cli/v8/commands/npm-run-script):
```sh
$ npm run -- <script arguments>
```
The `--` indicates that all arguments afterwards should be passed into the _script_ rather than _npm_.
All end-of-flag arguments will be accessible from `argv._['--']`.
Additionally, you can specify `--` in the `parameters` array to parse end-of-flags arguments.
Example:
```ts
const argv = cli({
name: 'npm-run',
parameters: [
'<script>',
'--',
'[arguments...]'
]
})
// $ npm-run echo -- hello world
argv._.script // => "echo" (string)
argv._.arguments // => ["hello", "world] (string[])
```
### Flags
Flags (aka Options) are key-value pairs passed into the script in the format `--flag-name <value>`.
For example, in the following command, `--file-a` has value `data.json` and `--file-b` has value `file.txt`:
```
$ my-script --file-a data.json --file-b=file.txt
```
#### Parsing features
_Cleye_'s flag parsing is powered by [`type-flag`](https://github.com/privatenumber/type-flag) and comes with many features:
- Array & Custom types
- Flag delimiters: `--flag value`, `--flag=value`, `--flag:value`, and `--flag.value`
- Combined aliases: `-abcd 2` → `-a -b -c -d 2`
- [End of flags](https://unix.stackexchange.com/a/11382): Pass in `--` to end flag parsing
- Unknown flags: Unexpected flags stored in `unknownFlags`
Read the [_type-flag_ docs](https://github.com/privatenumber/type-flag) to learn more.
#### Defining flags
Flags can be specified in the `flag` object-property, where the key is the flag name, and the value is a flag type function or an object that describes the flag.
The flag name is recommended to be in camelCase as it will be interpreted to parse kebab-case equivalents.
The flag type function can be any function that accepts a string and returns the parsed value. Default JavaScript constructors should cover most use-cases: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/String), [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/Number), [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean), etc.
The flag description object can be used to store additional information about the flag, such as `alias`, `default`, and `description`. To accept multiple values for a flag, wrap the type function in an array.
All of the provided information will be used to generate better help documentation.
Example:
```ts
const argv = cli({
flags: {
someBoolean: Boolean,
someString: {
type: String,
description: 'Some string flag',
default: 'n/a'
},
someNumber: {
// Wrap the type function in an array to allow multiple values
type: [Number],
alias: 'n',
description: 'Array of numbers. (eg. -n 1 -n 2 -n 3)'
}
}
})
// $ my-script --some-boolean --some-string hello --some-number 1 -n 2
argv.flags.someBoolean // => true (boolean | undefined)
argv.flags.someString // => "hello" (string)
argv.flags.someNumber // => [1, 2] (number[])
```
#### Custom flag types & validation
Custom flag types can be created to validate flags and narrow types. Simply create a new function that accepts a string and returns the parsed value.
Here's an example with a custom `Size` type that narrows the flag type to `"small" | "medium" | "large"`:
```ts
const possibleSizes = ['small', 'medium', 'large'] as const
type Sizes = typeof possibleSizes[number] // => "small" | "medium" | "large"
// Custom type function
function Size(size: Sizes) {
if (!possibleSizes.includes(size)) {
throw new Error(`Invalid size: "${size}"`)
}
return size
}
const argv = cli({
flags: {
size: {
type: Size,
description: 'Size of the pizza (small, medium, large)'
}
}
})
// $ my-script --size large
argv.flags.size // => "large" ("small" | "medium" | "large")
```
#### Default flags
By default, _Cleye_ will try to handle the `--help, -h` and `--version` flags.
##### Help flag
Handling `--help, -h` is enabled by default.
To disable it, set `help` to `false`. The help documentation can still be manually displayed by calling `.showHelp(helpOptions)` on the returned object.
##### Version flag
To enable handling `--version`, specify the `version` property.
```ts
cli({
version: '1.2.3'
})
```
```sh
$ my-script --version
1.2.3
```
The version is also shown in the help documentation. To opt out of handling `--version` while still showing the version in `--help`, pass the version into `help.version`.
### Commands
Commands allow organizing multiple "scripts" into a single script. An example of this is the [`npm install`](https://docs.npmjs.com/cli/install/) command, which is essentially an "install" script inside the "npm" script, adjacent to other commands like [`npm run`](https://docs.npmjs.com/cli/run-script/).
#### Defining commands
A command can be created by importing the `command` function and initializing it with a name. The rest of the options are the same as the `cli` function.
Pass the created command into `cli` option's `commands` array-property to register it:
_npm.js_
```ts
import { cli, command } from 'cleye'
const argv = cli({
name: 'npm',
version: '1.2.3',
commands: [
command({
// Command name
name: 'install',
parameters: ['<package name>'],
flags: {
noSave: Boolean,
saveDev: Boolean
}
})
]
})
// $ npm install lodash
argv.command // => "install" (string)
argv._.packageName // => "lodash" (string)
```
Depending on the command given, the resulting type can be narrowed:
<p align="center">
<img src=".github/command-type-narrowing.png" width="420">
</p>
#### Command callback
When a CLI app has many commands, it's recommended to organize each command in its own file. With this structure, parsed output handling for each command is better placed where they are respectively defined rather than the single `cli` output point. This can be done by passing a callback function into the `command` function (callbacks are supported in the `cli` function too).
Example:
_install-command.js_ (`install` command using callback)
```ts
import { command } from 'cleye'
export const installCommand = command({
// Command name
name: 'install',
parameters: ['<package name>'],
flags: {
noSave: Boolean,
saveDev: Boolean
}
}, (argv) => {
// $ npm install lodash
argv._.packageName // => "lodash" (string)
})
```
_npm.js_ (CLI entry file)
```ts
import { installCommand } from './install-command.js'
cli({
name: 'npm',
commands: [
installCommand
]
})
```
### Help documentation
_Cleye_ uses all information provided to generate rich help documentation. The more information you give, the better the docs!
#### Help customization
The help document can be customized by passing a `render(nodes, renderers) => string` function to `help.render`.
The `nodes` parameter contains an array of nodes that will be used to render the document. The `renderers` parameter is an object of functions used to render the document. Each node has properties `type` and `data`, where `type` corresponds to a property in `renderers` and `data` is passed into the render function.
Default renderers can be found in [`/src/render-help/renderers.ts`](/src/render-help/renderers.ts).
Here's an example that adds an extra sentence at the end and also updates the flags table to use the `=` operator (`--flag <value>` → `--flag=<value>`):
```ts
cli({
// ...,
help: {
render(nodes, renderers) {
/* Modify nodes... */
// Add some text at end of document
nodes.push('\nCheckout Cleye: https://github.com/privatenumber/cleye')
/* Extend renderers... */
// Make all flag examples use `=` as the separator
renderers.flagOperator = () => '='
/* Render nodes and return help */
return renderers.render(nodes)
}
}
})
```
#### Responsive tables
_Cleye_'s "Flags" table in the help document is responsive and wraps cell text content based on the column & terminal width. It also has [breakpoints to display more vertically-optimized tables](/src/render-help/render-flags.ts#L4) for narrower viewports.
This feature is powered by [terminal-columns](https://github.com/privatenumber/terminal-columns) and can be configured via the `renderers.table` renderer.
<table>
<tr>
<th>Normal width</th>
<th>Narrow width</th>
</tr>
<tr>
<th><img src=".github/responsive-normal.png" width="420"></th>
<th><img src=".github/responsive-narrow.png" width="300"></th>
</tr>
</table>
## API
### cli(options, callback?, argvs?)
Return type:
```ts
type ParsedArgv = {
// Parsed arguments
_: string[] & Parameters
// Parsed flags
flags: {
[flagName: string]: InferredType
}
// Unexpected flags
unknownFlags: {
[flagName: string]: (string | boolean)[]
}
// Method to print version
showVersion: () => void
// Method to print help
showHelp: (options: HelpOptions) => void
}
```
Function to parse argvs by declaring parameters and flags.
#### options
Options object to configure `cli`.
##### name
Type: `string`
Name of the script used in the help documentation.
##### version
Type: `string`
Version of the script used in the help documentation.
Passing this in enables auto-handling `--version`. To provide a version for the documentation without auto-handling `--version`, pass it into [`help.version`](#version-1).
##### parameters
Type: `string[]`
Parameter names to map onto arguments. Also used for validation and help documentation.
Parameters must be defined in the following formats:
| Format | Description |
| - | - |
| `<parameter name>` | Required parameter |
| `[parameter name]` | Optional parameter |
| `<parameter name...>` | Required spread parameter (1 or more) |
| `[parameter name...]` | Optional spread parameter (0 or more) |
Required parameters must be defined before optional parameters, and spread parameters must be defined at the end.
##### flags
Type: An object that maps the flag name (in camelCase) to a flag type function or an object describing the flag:
| Property | Type | Description |
| - | - | - |
| `type` | `Function` | Flag value parsing function. |
| `alias` | `string` | Single character alias for the flag. |
| `default` | `any` | Default value for the flag. |
| `description` | `string` | Description of the flag shown in `--help`. |
| `placeholder` | `string` | Placeholder for the flag value shown in `--help`. |
##### help
Type: `false` or an object with the following properties.
| Property | Type | Description |
| - | - | - |
| `version` | `string` | Version shown in `--help`. |
| `description` | `string` | Description shown in `--help`. |
| `usage` | `string \| string[]` | Usage code examples shown in `--help`. |
| `examples` | `string \| string[]` | Example code snippets shown in `--help`. |
| `render` | `(nodes, renderers) => string` | Function to customize the help document. |
Handling `--help, -h` is enabled by default. To disable it, pass in `false`.
##### commands
Type: `Command[]`
Array of [commands](#commandoptions-callback) to register.
##### ignoreArgv
Type:
```ts
type IgnoreArgvCallback = (
type: 'known-flag' | 'unknown-flag' | 'argument',
flagOrArgv: string,
value: string | undefined,
) => boolean | void
```
A callback to ignore argv tokens from being parsed.
#### callback(parsed)
Type:
Optional callback function that is called when the script is invoked without a command.
#### argvs
Type: `string[]`
Default: `process.argv.slice(2)`
The raw parameters array to parse.
### command(options, callback?)
#### options
| Property | Type | Description |
| - | - | - |
| `name` | `string` | Required name used to invoke the command. |
| `alias` | `string \| string[]` | Aliases used to invoke the command. |
| `parameters` | `string[]` | Parameters for the command. Same as [`parameters`](#parameters-1). |
| `flags` | `Flags` | Flags for the command. Same as [`flags`](#flags-1). |
| `help` | `false \| HelpOptions` | Help options for the command. Same as [`help`](#help-1). |
#### callback(parsed)
Type:
Optional callback function that is called when the command is invoked.
## Sponsors
<p align="center">
<a href="https://github.com/sponsors/privatenumber">
<img src="https://cdn.jsdelivr.net/gh/privatenumber/sponsors/sponsorkit/sponsors.svg">
</a>
</p>