-
Notifications
You must be signed in to change notification settings - Fork 905
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(prompt): rewrite codebase to use inquirer #2375
Closed
Closed
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
02179c8
feat(prompt): rewrite codebase to use inquirer
armano2 33ed2c0
fix(prompt): simplify logic used to compute maxLength
armano2 64c9cc8
test(prompt): add basic input test
armano2 85fca63
Merge branch 'master' into refactor/prompt2
armano2 f6c8b7d
fix(prompt): small code refactor
armano2 79b2283
Merge branch 'master' into refactor/prompt2
armano2 6a41f92
fix: correct linting issues, add missing dependencies
armano2 1ca392c
fix: add missing tsconfig reference
armano2 be63ce6
Merge branch 'master' into refactor/prompt2
armano2 b9d840c
fix: update lock file after merge
armano2 3ab85e2
fix: correct issue with mac-os tab completion
armano2 40f8c67
Merge branch 'master' into refactor/prompt2
armano2 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,18 @@ | ||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment | ||
// @ts-ignore | ||
import vorpal from 'vorpal'; | ||
import inquirer from 'inquirer'; | ||
import input from './input'; | ||
|
||
type Commit = (input: string) => void; | ||
|
||
/** | ||
* Entry point for commitizen | ||
* @param _ inquirer instance passed by commitizen, unused | ||
* @param cz inquirer instance passed by commitizen | ||
* @param commit callback to execute with complete commit message | ||
* @return generated commit message | ||
*/ | ||
export async function prompter(_: unknown, commit: Commit): Promise<void> { | ||
const message = await input(vorpal); | ||
export async function prompter( | ||
cz: typeof inquirer, | ||
commit: Commit | ||
): Promise<void> { | ||
const message = await input(cz.prompt); | ||
commit(message); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
import {Answers, PromptModule, QuestionCollection} from 'inquirer'; | ||
/// <reference path="./inquirer/inquirer.d.ts" /> | ||
import input from './input'; | ||
import chalk from 'chalk'; | ||
|
||
jest.mock( | ||
'@commitlint/load', | ||
() => { | ||
return () => require('@commitlint/config-angular'); | ||
}, | ||
{ | ||
virtual: true, | ||
} | ||
); | ||
|
||
test('should work with all fields filled', async () => { | ||
const prompt = stub({ | ||
'input-custom': { | ||
type: 'fix', | ||
scope: 'test', | ||
subject: 'subject', | ||
body: 'body', | ||
footer: 'footer', | ||
}, | ||
}); | ||
const message = await input(prompt); | ||
expect(message).toEqual('fix(test): subject\n' + 'body\n' + 'footer'); | ||
}); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. those tests actually test validation only, as there is no viable / easy way to write proper end to end tests most likely we should add more cases here |
||
|
||
test('should work without scope', async () => { | ||
const prompt = stub({ | ||
'input-custom': { | ||
type: 'fix', | ||
scope: '', | ||
subject: 'subject', | ||
body: 'body', | ||
footer: 'footer', | ||
}, | ||
}); | ||
const message = await input(prompt); | ||
expect(message).toEqual('fix: subject\n' + 'body\n' + 'footer'); | ||
}); | ||
|
||
test('should fail without type', async () => { | ||
const spy = jest.spyOn(console, 'error').mockImplementation(); | ||
const prompt = stub({ | ||
'input-custom': { | ||
type: '', | ||
scope: '', | ||
subject: '', | ||
body: '', | ||
footer: '', | ||
}, | ||
}); | ||
const message = await input(prompt); | ||
expect(message).toEqual(''); | ||
expect(console.error).toHaveBeenCalledTimes(1); | ||
expect(console.error).toHaveBeenLastCalledWith( | ||
new Error(`⚠ ${chalk.bold('type')} may not be empty.`) | ||
); | ||
spy.mockRestore(); | ||
}); | ||
armano2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
function stub(config: Record<string, Record<string, unknown>>): PromptModule { | ||
const prompt = async (questions: QuestionCollection): Promise<any> => { | ||
const result: Answers = {}; | ||
const resolvedConfig = Array.isArray(questions) ? questions : [questions]; | ||
for (const promptConfig of resolvedConfig) { | ||
const configType = promptConfig.type || 'input'; | ||
const questions = config[configType]; | ||
if (!questions) { | ||
throw new Error(`Unexpected config type: ${configType}`); | ||
} | ||
const answer = questions[promptConfig.name!]; | ||
if (answer == null) { | ||
throw new Error(`Unexpected config name: ${promptConfig.name}`); | ||
} | ||
const validate = promptConfig.validate; | ||
if (validate) { | ||
const validationResult = validate(answer, result); | ||
if (validationResult !== true) { | ||
throw new Error(validationResult || undefined); | ||
} | ||
} | ||
|
||
result[promptConfig.name!] = answer; | ||
} | ||
return result; | ||
}; | ||
prompt.registerPrompt = () => { | ||
return prompt; | ||
}; | ||
prompt.restoreDefaultPrompts = () => true; | ||
prompt.prompts = {}; | ||
return (prompt as any) as PromptModule; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
/// <reference path="./inquirer.d.ts" /> | ||
import {Interface as ReadlineInterface, Key} from 'readline'; | ||
|
||
import chalk from 'chalk'; | ||
import inquirer from 'inquirer'; | ||
import InputPrompt from 'inquirer/lib/prompts/input'; | ||
import observe from 'inquirer/lib/utils/events'; | ||
import type {Subscription} from 'rxjs/internal/Subscription'; | ||
|
||
import Answers = inquirer.Answers; | ||
import InputCustomOptions = inquirer.InputCustomOptions; | ||
import SuccessfulPromptStateData = inquirer.prompts.SuccessfulPromptStateData; | ||
|
||
interface KeyDescriptor { | ||
value: string; | ||
key: Key; | ||
} | ||
|
||
export default class InputCustomPrompt< | ||
TQuestion extends InputCustomOptions = InputCustomOptions | ||
> extends InputPrompt<TQuestion> { | ||
private lineSubscription: Subscription; | ||
private readonly tabCompletion: string[]; | ||
|
||
constructor( | ||
question: TQuestion, | ||
readLine: ReadlineInterface, | ||
answers: Answers | ||
) { | ||
super(question, readLine, answers); | ||
|
||
if (this.opt.log) { | ||
this.rl.write(this.opt.log(answers)); | ||
} | ||
|
||
if (!this.opt.maxLength) { | ||
this.throwParamError('maxLength'); | ||
} | ||
|
||
const events = observe(this.rl); | ||
this.lineSubscription = events.keypress.subscribe( | ||
this.onKeyPress2.bind(this) | ||
); | ||
this.tabCompletion = (this.opt.tabCompletion || []) | ||
.map((item) => item.value) | ||
.sort((a, b) => a.localeCompare(b)); | ||
} | ||
|
||
onEnd(state: SuccessfulPromptStateData): void { | ||
this.lineSubscription.unsubscribe(); | ||
super.onEnd(state); | ||
} | ||
|
||
/** | ||
* @see https://nodejs.org/api/readline.html#readline_rl_write_data_key | ||
* @see https://nodejs.org/api/readline.html#readline_rl_line | ||
*/ | ||
updateLine(line: string): void { | ||
this.rl.write(null as any, {ctrl: true, name: 'b'}); | ||
this.rl.write(null as any, {ctrl: true, name: 'd'}); | ||
this.rl.write(line.substr(this.rl.line.length)); | ||
} | ||
|
||
onKeyPress2(e: KeyDescriptor): void { | ||
if (e.key.name === 'tab' && this.tabCompletion.length > 0) { | ||
let line = this.rl.line.trim(); | ||
if (line.length > 0) { | ||
for (const item of this.tabCompletion) { | ||
if (item.startsWith(line) && item !== line) { | ||
line = item; | ||
break; | ||
} | ||
} | ||
} | ||
this.updateLine(line); | ||
} | ||
} | ||
|
||
measureInput(input: string): number { | ||
if (this.opt.filter) { | ||
return this.opt.filter(input).length; | ||
} | ||
return input.length; | ||
} | ||
|
||
render(error?: string): void { | ||
const answered = this.status === 'answered'; | ||
|
||
let bottomContent = ''; | ||
let message = this.getQuestion(); | ||
const length = this.measureInput(this.rl.line); | ||
|
||
if (answered) { | ||
message += chalk.cyan(this.answer); | ||
} else if (this.opt.transformer) { | ||
message += this.opt.transformer(this.rl.line, this.answers, {}); | ||
} | ||
|
||
if (error) { | ||
bottomContent = chalk.red('>> ') + error; | ||
} else if (!answered) { | ||
const maxLength = this.opt.maxLength(this.answers); | ||
if (maxLength < Infinity) { | ||
const lengthRemaining = maxLength - length; | ||
const color = | ||
lengthRemaining <= 5 | ||
? chalk.red | ||
: lengthRemaining <= 10 | ||
? chalk.yellow | ||
: chalk.grey; | ||
bottomContent = color(`${lengthRemaining} characters left`); | ||
} | ||
} | ||
|
||
this.screen.render(message, bottomContent); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you have better idea for this, I'm open to suggestions