Skip to content

Commit 514fa2b

Browse files
committed
refactor(config): [rules] error on missing leading blank lines
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent 9de0eb2 commit 514fa2b

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

src/config/__snapshots__/rules.integration.snap

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ exports[`integration:config/rules > @commitlint/lint > body-full-stop > should e
1111
]
1212
`;
1313

14-
exports[`integration:config/rules > @commitlint/lint > body-leading-blank > should warn if body does not have leading blank line 1`] = `
14+
exports[`integration:config/rules > @commitlint/lint > body-leading-blank > should error if body comes after 1 new line 1`] = `
1515
[
1616
{
17-
"level": 1,
17+
"level": 2,
1818
"message": "body must have leading blank line",
1919
"name": "body-leading-blank",
2020
"valid": false,
2121
},
2222
]
2323
`;
2424

25-
exports[`integration:config/rules > @commitlint/lint > footer-leading-blank > should warn if footer does not have leading blank line 1`] = `
25+
exports[`integration:config/rules > @commitlint/lint > footer-leading-blank > should error if footer comes after 1 new line 1`] = `
2626
[
2727
{
28-
"level": 1,
28+
"level": 2,
2929
"message": "footer must have leading blank line",
3030
"name": "footer-leading-blank",
3131
"valid": false,

src/config/__tests__/rules.integration.spec.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,17 @@ describe('integration:config/rules', () => {
7373

7474
beforeAll(() => {
7575
rule = 'body-leading-blank'
76-
severity = Severity.Warning
76+
severity = Severity.Error
7777
})
7878

79-
it('should warn if body does not have leading blank line', async () => {
79+
it('should error if body comes after 1 new line', async () => {
8080
// Act
8181
const result = await linter(signoff('fix: some message\nbody'))
8282

8383
// Expect
84-
expect(result.errors).to.be.an('array').that.is.empty
85-
expect(result.warnings).to.have.ruleOutcome(rule, severity)
86-
expect(result.warnings).toMatchSnapshot()
84+
expect(result.errors).to.have.ruleOutcome(rule, severity)
85+
expect(result.warnings).to.be.an('array').that.is.empty
86+
expect(result.errors).toMatchSnapshot()
8787
})
8888
})
8989

@@ -139,10 +139,10 @@ describe('integration:config/rules', () => {
139139

140140
beforeAll(() => {
141141
rule = 'footer-leading-blank'
142-
severity = Severity.Warning
142+
severity = Severity.Error
143143
})
144144

145-
it('should warn if footer does not have leading blank line', async () => {
145+
it('should error if footer comes after 1 new line', async () => {
146146
// Arrange
147147
const commit: string =
148148
'test: some message\n\nbody\nBREAKING CHANGE: It will be significant'
@@ -151,9 +151,9 @@ describe('integration:config/rules', () => {
151151
const result = await linter(signoff(commit, 0))
152152

153153
// Expect
154-
expect(result.errors).to.be.an('array').that.is.empty
155-
expect(result.warnings).to.have.ruleOutcome(rule, severity)
156-
expect(result.warnings).toMatchSnapshot()
154+
expect(result.errors).to.have.ruleOutcome(rule, severity)
155+
expect(result.warnings).to.be.an('array').that.is.empty
156+
expect(result.errors).toMatchSnapshot()
157157
})
158158
})
159159

src/config/rules.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ const rules: RulesConfig = {
2323
'body-case': [Severity.Disabled],
2424
'body-empty': [Severity.Disabled],
2525
'body-full-stop': [Severity.Error, 'never', '.'],
26-
'body-leading-blank': [Severity.Warning, 'always'],
26+
'body-leading-blank': [Severity.Error, 'always'],
2727
'body-max-length': [Severity.Error, 'always', Number.MAX_SAFE_INTEGER],
2828
'body-max-line-length': [Severity.Error, 'always', 2050],
2929
'body-min-length': [Severity.Disabled],
3030
'footer-empty': [Severity.Disabled],
31-
'footer-leading-blank': [Severity.Warning, 'always'],
31+
'footer-leading-blank': [Severity.Error, 'always'],
3232
'footer-max-length': [Severity.Error, 'always', Number.MAX_SAFE_INTEGER],
3333
'footer-max-line-length': [Severity.Error, 'always', 2050],
3434
'footer-min-length': [Severity.Disabled],

0 commit comments

Comments
 (0)