\r\n The above is a tool called\r\n commitlive, created using repll\r\n
\r\n\r\n\r\n### Features\r\n\r\n- `r`: **read** input key-by-key ( when you paste something, don't worry, we will handle it as a longer `key` )\r\n- `e`: **evaluate** input ( we do not evaluate javascript, that's boring, the `eval` function is provided **by you** )\r\n- `p`: **print** whatever you wanna output ( without even press `Enter` )\r\n- `ll`: we keep doing `r e p` **looply** and **livly**, so you can interact with user in real-time\r\n\r\nWe also support:\r\n\r\n- `input heilghting`: heightlight user's input at ease, this is what a repl should feels like\r\n- `tab completion`: not bash like, we won't endlessly prompt out the possibilities. Moreover, repll support adding detailed introduction by using a `completion object`\r\n- `stop detection`: when user stops input, we will calculate the pause time, compare it with the time you provide\r\n- `fake line`: sometimes, you want to process input just in one line(by hitting enter, you don't wanna create a new prompt). But readline won't let you do that line feed, repll implement that by using `onFakeLine`, press `` to try it!\r\n- `livly prompt`: by passing a prompt string sequence to repll, every time you press enter, a brand new prompt prompts up!\r\n- `livly placeholder`: can be used to give user tips on what to do, it has `livly` feature too!\r\n- `arrow key navigation`: you can using arrow keys to edit the text you input, we currently don't support `fake line` + `arrow key navigation`, this can lead to strange behavior, but the fact that it is still working 💊 (PR is welcome)\r\n\r\n### Get started!\r\n\r\n#### Installation\r\n\r\n```bash\r\nnpm i repll\r\n```\r\n\r\nThe installation process is super fast because repll does not need any dependencies\r\n\r\n**You must have NodeJS v13.5.0+(v12.16.0+) installed considering compatibility issues**\r\n\r\n#### Usage\r\n\r\n```js\r\nconst { replLive, onInput } = require('repll')\r\n\r\n// Create a repll instance\r\nconst repll = replLive({ 'prompt › ': 'placeholder' })\r\n\r\n// Listen input key-by-key\r\nonInput(input => {\r\n // Output in real-time\r\n repll.refresh(`\\nINPUT: ${input}\r\n \\nLINE: ${repll.input}`)\r\n})\r\n```\r\n\r\nThe arrow function passed to `onInput` acts as an `evaluate` function in repl, in this case, it will output what user inputs\r\n\r\n### Global methods explained\r\n\r\n> Note: Those methods can be directly required from `repll` module:\r\n\r\n```js\r\n// Require global methods\r\nconst { replLive, onTab } = require('repll')\r\n```\r\n\r\n- **replLive**(map)\r\n\r\n - `map`: a `Object` which contains `prompt-placeholder` key-value pairs, repll will close it's instance when all prompts are consumed, **Make sure to pass all the prompts you need, and try to use `repll.waitClosing()` to keep the closing flow in control**\r\n - _Return_: a `replLive` class's instance\r\n\r\n You must call this function first to init and generate a `repll` entity, which contains some very useful properties and methods:\r\n\r\n - `repll.input`: a `string`, which keeps tracking of user's accumulated input in current line\r\n - `repll.hl(len, string)`: a `Function`, it moves the cursor to the `len` left, cover user's input with a colorized `string`, it can be used to heightlighting user's input(NOTE: it won't change user's input, it covers a layer of colorized `string` **provided by you**)\r\n - `repll.write(string, object)`: a `Function`, same as readline's write method, it can type inputs for user. You can use it as an auto-completion\r\n - `repll.waitClosing()`: a `Function` which returns a `Promise`(will be resolved when prompt is running out), we can use it to [create a new repll instance](https://github.com/beetcb/repll/blob/master/TEST/multiRepl.js) or [write some sync code for good UX](https://github.com/beetcb/repll/blob/master/TEST/sync.js). **After it resolves, a repll's history array will return, you can catch it and do something like [inquirer](https://github.com/SBoudrias/Inquirer.js) does**\r\n - `repll.history` an `array`, when you have multiple lines of input, it records each line for user\r\n - `repll.inpuLine`: a `string`, it indicates which line user is currently on\r\n\r\n- **onTab**(callback(input))\r\n\r\n - callback `Function`: take in user accumulated input, generate a sequence for completing\r\n\r\n i.e. :\r\n\r\n ```js\r\n onTab(v => {\r\n const optionMap = {\r\n 'feat: ': 'add a new feature',\r\n 'fix: ': 'patch a bug',\r\n }\r\n const selectedList = Object.keys(optionMap).filter(\r\n e => e.includes(v) && e.length > v.length\r\n )\r\n return [selectedList, optionMap]\r\n })\r\n ```\r\n\r\nThis callback gets called each time user press the `tab`, view full example at here: [./TEST/completion.js](./TEST/completion.js)\r\n\r\n- **onLine**(callback(key))\r\n\r\n - callback `Function`: take in line number, if callback returns a `string`, it will be used as the new line's placeholder\r\n\r\n This function makes palceholder modifiable when user starts a new line.\r\n i.e. :\r\n\r\n ```js\r\n onLine(line => {\r\n return `LINE: ${line}`\r\n })\r\n ```\r\n\r\n View full example at here: [./TEST/placeholder.js](./TEST/placeholder.js)\r\n\r\n- **onFakeLine**\r\n\r\n - callback `Function`\r\n\r\n By default, when you press enter, readline creates a new line for you.\r\n repll listens to the `shfit + DownArrow` keypress to trigger the `onFakeLine` event, which allows you to simulate a (fake new) line feed on the current line\r\n\r\n- **onInput**(callback(key))\r\n\r\n - callback `Function`: take in user input key, evaluate it as you wish, repll with excute it for you\r\n\r\n This callback gets called each time user inputs a key\r\n\r\n- **onAny**(callback(data))\r\n\r\n - callback `Function`: take in user input key's data object, it can extend `onInput` because some modifier key can't fire `onInput`\r\n\r\n This callback gets called each time user inputs a any key\r\n\r\n- **onArrow**(callback(arrowKey))\r\n\r\n - callback `Function`: take in array key type (up|down|left|right)\r\n\r\n This callback gets called each time user press a arrow key\r\n\r\n- **onStop**(callback(), time)\r\n\r\n - callback `Function`: will be called when the user pause for a period of time\r\n - time `number`: if `time period of pausing input` seconds > `time` seconds, the callback function is executed\r\n\r\n You'd better use this function instead of `onInput` when you make a network request.\r\n The tldr demo uses this method, it's powerful!\r\n\r\n- **onSubmit**(callback())\r\n\r\n - callback `Function`\r\n\r\n This callback gets called when user press , this is where the program should end\r\n\r\n### Related projects\r\n\r\n- [`repl`](https://nodejs.org/dist/latest-v15.x/docs/api/repl.html): nodejs built-in module, seems to be livly, but things start to get static when you pass `completer` into it\r\n\r\n- [`ink`](https://github.com/vadimdemedes/ink): awesome project, requires a dependency on [react](https://github.com/facebook/react), also supports read user input livly\r\n\r\n- [`inquirer`](https://github.com/SBoudrias/Inquirer.js): super powerful interactive command line user interfacess collection\r\n","readmeFilename":"README.md"}
![\"demo\"](\"assets/demo-commitlive.svg\")
![\"npm\"](\"https://img.shields.io/npm/v/repll\")
\r\n ![\"npm\"](\"https://img.shields.io/badge/contribute-welcome-blue\"){kind=icon}
\r\n \r\n