From c47c2900ccbdd0521501cc456d288bbc9fe8da00 Mon Sep 17 00:00:00 2001 From: Armano Date: Sun, 7 Nov 2021 16:18:04 +0100 Subject: [PATCH 1/2] fix(prompt): correct import kind in prompt package --- @commitlint/prompt/src/index.ts | 6 ++++++ @commitlint/prompt/src/input.test.ts | 2 +- @commitlint/prompt/src/input.ts | 2 +- @commitlint/prompt/src/inquirer/InputCustomPrompt.ts | 2 +- @commitlint/prompt/src/library/format.test.ts | 2 +- @commitlint/prompt/src/library/format.ts | 4 ++-- @commitlint/prompt/src/library/get-forced-case-fn.ts | 4 ++-- @commitlint/prompt/src/library/get-forced-leading-fn.ts | 2 +- @commitlint/prompt/src/library/get-prompt.ts | 4 ++-- @commitlint/prompt/src/library/meta.ts | 2 +- @commitlint/prompt/src/library/types.ts | 2 +- @commitlint/prompt/src/library/utils.ts | 5 +++-- 12 files changed, 22 insertions(+), 15 deletions(-) diff --git a/@commitlint/prompt/src/index.ts b/@commitlint/prompt/src/index.ts index ca85678b1a..0447d708d3 100644 --- a/@commitlint/prompt/src/index.ts +++ b/@commitlint/prompt/src/index.ts @@ -3,6 +3,12 @@ import {input} from './input'; type Commit = (input: string) => void; +/** + * Entry point for commitizen + * @param cz inquirer instance passed by commitizen, unused + * @param commit callback to execute with complete commit message + * @return {void} + */ export function prompter(cz: typeof inquirer, commit: Commit): void { input(cz.prompt).then((message) => { commit(message); diff --git a/@commitlint/prompt/src/input.test.ts b/@commitlint/prompt/src/input.test.ts index cde2a5efb2..7a0997869b 100644 --- a/@commitlint/prompt/src/input.test.ts +++ b/@commitlint/prompt/src/input.test.ts @@ -1,7 +1,7 @@ import {Answers, PromptModule, QuestionCollection} from 'inquirer'; /// import {input} from './input'; -import chalk from 'chalk'; +import * as chalk from 'chalk'; jest.mock( '@commitlint/load', diff --git a/@commitlint/prompt/src/input.ts b/@commitlint/prompt/src/input.ts index ff7db40901..702c04608f 100644 --- a/@commitlint/prompt/src/input.ts +++ b/@commitlint/prompt/src/input.ts @@ -1,5 +1,5 @@ import load from '@commitlint/load'; -import {DistinctQuestion, PromptModule} from 'inquirer'; +import type {DistinctQuestion, PromptModule} from 'inquirer'; import format from './library/format'; import getPrompt from './library/get-prompt'; diff --git a/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts b/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts index 036bb78cc3..7ad5700d81 100644 --- a/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts +++ b/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts @@ -3,7 +3,7 @@ import chalk from 'chalk'; import inquirer from 'inquirer'; import InputPrompt from 'inquirer/lib/prompts/input'; import observe from 'inquirer/lib/utils/events'; -import {Interface as ReadlineInterface, Key} from 'readline'; +import type {Interface as ReadlineInterface, Key} from 'readline'; import type {Subscription} from 'rxjs/internal/Subscription'; import Answers = inquirer.Answers; diff --git a/@commitlint/prompt/src/library/format.test.ts b/@commitlint/prompt/src/library/format.test.ts index ae20b3b1ab..7c7bfe9460 100644 --- a/@commitlint/prompt/src/library/format.test.ts +++ b/@commitlint/prompt/src/library/format.test.ts @@ -1,4 +1,4 @@ -import {Result} from './types'; +import type {Result} from './types'; import format from './format'; test('should return empty string', () => { diff --git a/@commitlint/prompt/src/library/format.ts b/@commitlint/prompt/src/library/format.ts index e2d3076b9b..0bf53863f7 100644 --- a/@commitlint/prompt/src/library/format.ts +++ b/@commitlint/prompt/src/library/format.ts @@ -1,5 +1,5 @@ -import chalk from 'chalk'; -import {Result, ResultPart} from './types'; +import * as chalk from 'chalk'; +import type {Result, ResultPart} from './types'; /** * Get formatted commit message diff --git a/@commitlint/prompt/src/library/get-forced-case-fn.ts b/@commitlint/prompt/src/library/get-forced-case-fn.ts index ae9bddad5e..2fb39c607c 100644 --- a/@commitlint/prompt/src/library/get-forced-case-fn.ts +++ b/@commitlint/prompt/src/library/get-forced-case-fn.ts @@ -1,7 +1,7 @@ import {toCase} from '@commitlint/ensure'; -import {RuleEntry} from './types'; import {ruleIsActive, ruleIsNotApplicable} from './utils'; -import {TargetCaseType} from '@commitlint/types'; +import type {RuleEntry} from './types'; +import type {TargetCaseType} from '@commitlint/types'; /** * Get forced case for rule diff --git a/@commitlint/prompt/src/library/get-forced-leading-fn.ts b/@commitlint/prompt/src/library/get-forced-leading-fn.ts index 12614a0158..8a37906609 100644 --- a/@commitlint/prompt/src/library/get-forced-leading-fn.ts +++ b/@commitlint/prompt/src/library/get-forced-leading-fn.ts @@ -1,4 +1,4 @@ -import {RuleEntry} from './types'; +import type {RuleEntry} from './types'; import {ruleIsActive, ruleIsNotApplicable} from './utils'; /** diff --git a/@commitlint/prompt/src/library/get-prompt.ts b/@commitlint/prompt/src/library/get-prompt.ts index 81abe7fc73..790cfcc75a 100644 --- a/@commitlint/prompt/src/library/get-prompt.ts +++ b/@commitlint/prompt/src/library/get-prompt.ts @@ -1,5 +1,5 @@ -import chalk from 'chalk'; -import {InputCustomOptions} from 'inquirer'; +import * as chalk from 'chalk'; +import type {InputCustomOptions} from 'inquirer'; import type {InputSetting, RuleEntry, Result, ResultPart} from './types'; diff --git a/@commitlint/prompt/src/library/meta.ts b/@commitlint/prompt/src/library/meta.ts index 61c9a412eb..f860356413 100644 --- a/@commitlint/prompt/src/library/meta.ts +++ b/@commitlint/prompt/src/library/meta.ts @@ -1,4 +1,4 @@ -import chalk from 'chalk'; +import * as chalk from 'chalk'; /** * Get formatted meta hints for configuration diff --git a/@commitlint/prompt/src/library/types.ts b/@commitlint/prompt/src/library/types.ts index e873e4a36a..be8582ad28 100644 --- a/@commitlint/prompt/src/library/types.ts +++ b/@commitlint/prompt/src/library/types.ts @@ -1,4 +1,4 @@ -import {RuleConfigCondition, RuleConfigSeverity} from '@commitlint/types'; +import type {RuleConfigCondition, RuleConfigSeverity} from '@commitlint/types'; export type RuleEntry = | [string, Readonly<[RuleConfigSeverity.Disabled]>] diff --git a/@commitlint/prompt/src/library/utils.ts b/@commitlint/prompt/src/library/utils.ts index 4eb6e74d73..089bd1b800 100644 --- a/@commitlint/prompt/src/library/utils.ts +++ b/@commitlint/prompt/src/library/utils.ts @@ -1,5 +1,6 @@ -import {QualifiedRules, RuleConfigSeverity} from '@commitlint/types'; -import {RuleEntry} from './types'; +import {RuleConfigSeverity} from '@commitlint/types'; +import type {QualifiedRules} from '@commitlint/types'; +import type {RuleEntry} from './types'; /** * Get name for a given rule id From 673f1751c4dad739935a00259cb16870af16baa7 Mon Sep 17 00:00:00 2001 From: Armano Date: Mon, 8 Nov 2021 02:45:13 +0100 Subject: [PATCH 2/2] fix(prompt): revert chalk type imports --- @commitlint/prompt/src/input.test.ts | 2 +- @commitlint/prompt/src/library/format.ts | 2 +- @commitlint/prompt/src/library/get-prompt.ts | 2 +- @commitlint/prompt/src/library/meta.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/@commitlint/prompt/src/input.test.ts b/@commitlint/prompt/src/input.test.ts index 7a0997869b..cde2a5efb2 100644 --- a/@commitlint/prompt/src/input.test.ts +++ b/@commitlint/prompt/src/input.test.ts @@ -1,7 +1,7 @@ import {Answers, PromptModule, QuestionCollection} from 'inquirer'; /// import {input} from './input'; -import * as chalk from 'chalk'; +import chalk from 'chalk'; jest.mock( '@commitlint/load', diff --git a/@commitlint/prompt/src/library/format.ts b/@commitlint/prompt/src/library/format.ts index 0bf53863f7..2e97eca039 100644 --- a/@commitlint/prompt/src/library/format.ts +++ b/@commitlint/prompt/src/library/format.ts @@ -1,4 +1,4 @@ -import * as chalk from 'chalk'; +import chalk from 'chalk'; import type {Result, ResultPart} from './types'; /** diff --git a/@commitlint/prompt/src/library/get-prompt.ts b/@commitlint/prompt/src/library/get-prompt.ts index 790cfcc75a..abaf4ce82b 100644 --- a/@commitlint/prompt/src/library/get-prompt.ts +++ b/@commitlint/prompt/src/library/get-prompt.ts @@ -1,4 +1,4 @@ -import * as chalk from 'chalk'; +import chalk from 'chalk'; import type {InputCustomOptions} from 'inquirer'; import type {InputSetting, RuleEntry, Result, ResultPart} from './types'; diff --git a/@commitlint/prompt/src/library/meta.ts b/@commitlint/prompt/src/library/meta.ts index f860356413..61c9a412eb 100644 --- a/@commitlint/prompt/src/library/meta.ts +++ b/@commitlint/prompt/src/library/meta.ts @@ -1,4 +1,4 @@ -import * as chalk from 'chalk'; +import chalk from 'chalk'; /** * Get formatted meta hints for configuration