Skip to content

Commit

Permalink
fix(cz-commitlint): fix minor formatting issues
Browse files Browse the repository at this point in the history
This commit adds a space after the title before the skip message and removes the double colon in the
`config-conventional` type of change prompt. For example (when using
`@commitlint/config-conventional`), the following would previously be printed:

```
Select the type of change that you're committing::  feat
What is the scope of this change (e.g. component or file name)(press enter to skip): (max 96 chars)
```

Now with this change:

```
Select the type of change that you're committing: feat
What is the scope of this change (e.g. component or file name) (press enter to skip): (max 96 chars)
```
  • Loading branch information
cherryblossom000 authored and AdeAttwood committed Jul 21, 2021
1 parent 15d3b9d commit 99d8881
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
2 changes: 1 addition & 1 deletion @commitlint/config-conventional/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module.exports = {
prompt: {
questions: {
type: {
description: "Select the type of change that you're committing:",
description: "Select the type of change that you're committing",
enum: {
feat: {
description: 'A new feature',
Expand Down
8 changes: 4 additions & 4 deletions @commitlint/cz-commitlint/src/Question.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ describe('message', () => {
enumList: ['cli', 'core'],
}).question;
expect(question).toHaveProperty('message', expect.any(Function));
expect((question.message as any)()).toBe('please input: ');
expect((question.message as any)()).toBe('please input:');
});

test('should display skip hint when it is input and can skip', () => {
Expand All @@ -112,7 +112,7 @@ describe('message', () => {
}).question;
expect(question).toHaveProperty('message', expect.any(Function));
expect((question.message as any)()).toBe(
'please input(press enter to skip): \n'
'please input (press enter to skip):\n'
);
});

Expand All @@ -123,7 +123,7 @@ describe('message', () => {
skip: true,
} as any).question;
expect(question).toHaveProperty('message', expect.any(Function));
expect((question.message as any)()).toBe('please input: \n');
expect((question.message as any)()).toBe('please input:\n');
});

test('should display upper limit hint when it is input and has max length', () => {
Expand Down Expand Up @@ -155,7 +155,7 @@ describe('message', () => {
} as any).question;
expect(question).toHaveProperty('message', expect.any(Function));
expect((question.message as any)()).toBe(
'please input(press enter to skip): 10 chars at least, upper 80 chars\n'
'please input (press enter to skip): 10 chars at least, upper 80 chars\n'
);
});

Expand Down
14 changes: 10 additions & 4 deletions @commitlint/cz-commitlint/src/Question.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,17 @@ export default class Question {
return messages.join(', ');
})();

const skipMessage = this.skip ? this.getMessage('skip') : '';

return this.title + skipMessage + ': ' + countLimitMessage + '\n';
const skipMessage = this.skip && this.getMessage('skip');

return (
this.title +
(skipMessage ? ` ${skipMessage}` : '') +
':' +
(countLimitMessage ? ` ${countLimitMessage}` : '') +
'\n'
);
} else {
return this.title + ': ';
return `${this.title}:`;
}
}
}

0 comments on commit 99d8881

Please sign in to comment.