Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(command): add support for input filter for non-interactive #131

Merged
merged 1 commit into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,34 +114,34 @@ node ./cli world --name=Mark --name=Sally --no-excited
<!-- vim-markdown-toc GFM -->

* [API](#api)
* [Seeli.run( )](#seelirun-)
* [Seeli.list`<Array>`](#seelilistarray)
* [Seeli.use( name `<string>`, cmd `<Command>` )](#seeliuse-name-string-cmd-command-)
* [Seeli.bold( text `<string>`)](#seelibold-text-string)
* [Seeli.green( text `<string>`)](#seeligreen-text-string)
* [Seeli.blue( text `<string>`)](#seeliblue-text-string)
* [Seeli.red( text `<string>`)](#seelired-text-string)
* [Seeli.yellow( text `<string>`)](#seeliyellow-text-string)
* [Seeli.cyan( text `<string>`)](#seelicyan-text-string)
* [Seeli.magenta( text `<string>`)](#seelimagenta-text-string)
* [Seeli.redBright( text `<string>`)](#seeliredbright-text-string)
* [Seeli.blueBright( text `<string>`)](#seelibluebright-text-string)
* [Seeli.greenBright( text `<string>`)](#seeligreenbright-text-string)
* [Seeli.yellowBright( text `<string>`)](#seeliyellowbright-text-string)
* [Seeli.cyanBright( text `<string>`)](#seelicyanbright-text-string)
* [Seeli.config( key `<string>`, value `<object>` )](#seeliconfig-key-string-value-object-)
* [Seeli.config( opts `<object>` )](#seeliconfig-opts-object-)
* [Seeli.config( key `<string>` )](#seeliconfig-key-string-)
* [Supported Confgurations](#supported-confgurations)
* [Package Configuration](#package-configuration)
* [Command( options `<object>` )](#command-options-object-)
* [Options](#options)
* [Flag Options](#flag-options)
* [Nested Flags](#nested-flags)
* [Auto Help](#auto-help)
* [Asyncronous](#asyncronous)
* [Progress](#progress)
* [Events](#events)
* [Seeli.run( )](#seelirun-)
* [Seeli.list`<Array>`](#seelilistarray)
* [Seeli.use( name `<string>`, cmd `<Command>` )](#seeliuse-name-string-cmd-command-)
* [Seeli.bold( text `<string>`)](#seelibold-text-string)
* [Seeli.green( text `<string>`)](#seeligreen-text-string)
* [Seeli.blue( text `<string>`)](#seeliblue-text-string)
* [Seeli.red( text `<string>`)](#seelired-text-string)
* [Seeli.yellow( text `<string>`)](#seeliyellow-text-string)
* [Seeli.cyan( text `<string>`)](#seelicyan-text-string)
* [Seeli.magenta( text `<string>`)](#seelimagenta-text-string)
* [Seeli.redBright( text `<string>`)](#seeliredbright-text-string)
* [Seeli.blueBright( text `<string>`)](#seelibluebright-text-string)
* [Seeli.greenBright( text `<string>`)](#seeligreenbright-text-string)
* [Seeli.yellowBright( text `<string>`)](#seeliyellowbright-text-string)
* [Seeli.cyanBright( text `<string>`)](#seelicyanbright-text-string)
* [Seeli.config( key `<string>`, value `<object>` )](#seeliconfig-key-string-value-object-)
* [Seeli.config( opts `<object>` )](#seeliconfig-opts-object-)
* [Seeli.config( key `<string>` )](#seeliconfig-key-string-)
* [Supported Confgurations](#supported-confgurations)
* [Package Configuration](#package-configuration)
* [Command( options `<object>` )](#command-options-object-)
* [Options](#options)
* [Flag Options](#flag-options)
* [Nested Flags](#nested-flags)
* [Auto Help](#auto-help)
* [Asyncronous](#asyncronous)
* [Progress](#progress)
* [Events](#events)

<!-- vim-markdown-toc -->
# API
Expand Down Expand Up @@ -287,7 +287,7 @@ name | required | type | description
**event** | `false` | `boolean` | if set to `true` the command will emit an event withe the same name as the flag with **the** value that was captured for that flag |
**when** | `false` | `function` | **interactive mode only** Receives the current user answers hash and should return true or **false** depending on whether or not this question should be asked.
**validate** | `false` | `function` | receives user input and should return true if the value is **valid**, and an error message (String) otherwise. If false is returned, a default error message is provided.
**filter** | `false` | `function` | **interactive mode only** Receives the user input and return the filtered value to be used **inside** the program. The value returned will be added to the Answers hash.
**filter** | `false` | `function` | Receives the user input and return the filtered value to be used **inside** the program. The value returned will be added to the Answers hash.

#### Nested Flags

Expand Down
8 changes: 6 additions & 2 deletions lib/command/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,11 @@ class Command extends Registry {
return this.parsed
}
const value = hasOwn(this.parsed, key) ? this.parsed[key] : flag.default
object.set(this.parsed, key, value)
object.set(
this.parsed
, key
, typeof flag.filter === 'function' ? flag.filter(value, this.parsed) : value
)
}
return this.parsed
}
Expand Down Expand Up @@ -648,7 +652,7 @@ function toQuestion(flag, opts, answers) {
// can return them
arg.when = opts.when ? opts.when.bind(null, answers) : undefined
arg.validate = opts.validate ? opts.validate.bind(null, answers) : undefined
arg.filter = opts.filter ? opts.filter.bind(null, answers) : undefined
arg.filter = opts.filter ? opts.filter.bind(null) : undefined
arg.transformer = opts.transformer ? opts.transformer : transform.bind(arg)
return arg
}
Expand Down
5 changes: 4 additions & 1 deletion test/command.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ test('command', async (t) => {
, 'foo:bar:baz': {
type: Number
, required: true
, filter(input) {
return input + 100
}
}
, 'nested:array': {
type: [Number, Array]
Expand All @@ -71,7 +74,7 @@ test('command', async (t) => {
t.match(data, {
foo: {
bar: {
baz: Number
baz: 112
}
}
, test: Boolean
Expand Down
Loading