Skip to content

Commit 104acfa

Browse files
authored
chore(lint): merge missing-change-version into invalid-change-version (#248)
1 parent bff2b9b commit 104acfa

File tree

5 files changed

+32
-69
lines changed

5 files changed

+32
-69
lines changed

Diff for: src/linter/rules/index.mjs

-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import { duplicateStabilityNodes } from './duplicate-stability-nodes.mjs';
44
import { invalidChangeVersion } from './invalid-change-version.mjs';
5-
import { missingChangeVersion } from './missing-change-version.mjs';
65
import { missingIntroducedIn } from './missing-introduced-in.mjs';
76

87
/**
@@ -11,6 +10,5 @@ import { missingIntroducedIn } from './missing-introduced-in.mjs';
1110
export default {
1211
'duplicate-stability-nodes': duplicateStabilityNodes,
1312
'invalid-change-version': invalidChangeVersion,
14-
'missing-change-version': missingChangeVersion,
1513
'missing-introduced-in': missingIntroducedIn,
1614
};

Diff for: src/linter/rules/invalid-change-version.mjs

+3-4
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,9 @@ export const invalidChangeVersion = entries =>
6060
.filter(isInvalid)
6161
.map(version => ({
6262
level: 'error',
63-
message: LINT_MESSAGES.invalidChangeVersion.replace(
64-
'{{version}}',
65-
version
66-
),
63+
message: version
64+
? LINT_MESSAGES.invalidChangeVersion.replace('{{version}}', version)
65+
: LINT_MESSAGES.missingChangeVersion,
6766
location: { path: api_doc_source, position: yaml_position },
6867
}))
6968
)

Diff for: src/linter/rules/missing-change-version.mjs

-28
This file was deleted.

Diff for: src/linter/tests/rules/invalid-change-version.test.mjs

+29
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,35 @@ import { fileURLToPath } from 'node:url';
77
import { execPath } from 'node:process';
88

99
describe('invalidChangeVersion', () => {
10+
it('should return an empty array if all change versions are non-empty', () => {
11+
const issues = invalidChangeVersion([assertEntry]);
12+
13+
deepEqual(issues, []);
14+
});
15+
16+
it('should return an issue if a change version is missing', () => {
17+
const issues = invalidChangeVersion([
18+
{
19+
...assertEntry,
20+
changes: [...assertEntry.changes, { version: undefined }],
21+
},
22+
]);
23+
24+
deepEqual(issues, [
25+
{
26+
level: 'error',
27+
location: {
28+
path: 'doc/api/assert.md',
29+
position: {
30+
end: { column: 35, line: 7, offset: 137 },
31+
start: { column: 1, line: 7, offset: 103 },
32+
},
33+
},
34+
message: 'Missing version field in the API doc entry',
35+
},
36+
]);
37+
});
38+
1039
it('should work with NODE_RELEASED_VERSIONS', () => {
1140
const result = spawnSync(
1241
execPath,

Diff for: src/linter/tests/rules/missing-change-version.test.mjs

-35
This file was deleted.

0 commit comments

Comments
 (0)