@astral/commitlint-config 2.5.0 → 2.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/{index.js → config.js} +11 -6
- package/package.json +6 -10
package/README.md
CHANGED
|
@@ -35,6 +35,7 @@ module.exports = createConfig({
|
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
### Message example
|
|
38
|
+
|
|
38
39
|
#### Valid
|
|
39
40
|
```feat(UIKIT-222,ui): Title```
|
|
40
41
|
```feat: Title```
|
|
@@ -53,7 +54,8 @@ Default ENUM:
|
|
|
53
54
|
- bug - исправлена ошибка. Можно связать с релизом patch версии
|
|
54
55
|
- wip (work in progress) - промежуточные изменения
|
|
55
56
|
- refactor - произведен рефакторинг. Можно связать с релизом patch версии
|
|
56
|
-
- doc - внесены изменения в .md
|
|
57
|
+
- doc - внесены изменения в .md файлы. Можно связать с релизом patch версии
|
|
58
|
+
- story - внесены изменения в storybook.
|
|
57
59
|
- build - внесены изменения в сборке пакетов. Можно связать с релизом patch версии
|
|
58
60
|
- chore - внесены изменения в настройку окружения проекта (линтеры, ci...).
|
|
59
61
|
- revert - удалены ранее внесенные изменения
|
|
@@ -61,8 +63,8 @@ Default ENUM:
|
|
|
61
63
|
- test - написаны или изменены тесты проекта
|
|
62
64
|
- major - breaking changes. Полезен для пакетов. Можно связать с релизом major версии
|
|
63
65
|
|
|
64
|
-
|
|
65
66
|
# API
|
|
67
|
+
|
|
66
68
|
## createConfig
|
|
67
69
|
```ts
|
|
68
70
|
const { createConfig } = require('@astral/commitlint-config');
|
package/{index.js → config.js}
RENAMED
|
@@ -10,6 +10,7 @@ const DEFAULT_TYPE_ENUM = [
|
|
|
10
10
|
'style',
|
|
11
11
|
'test',
|
|
12
12
|
'major',
|
|
13
|
+
'story',
|
|
13
14
|
];
|
|
14
15
|
|
|
15
16
|
/**
|
|
@@ -63,20 +64,24 @@ const createConfig = ({
|
|
|
63
64
|
2,
|
|
64
65
|
'always',
|
|
65
66
|
({ scope }) => {
|
|
66
|
-
const ticketPrefixes = Array.isArray(ticketPrefix)
|
|
67
|
+
const ticketPrefixes = Array.isArray(ticketPrefix)
|
|
68
|
+
? ticketPrefix
|
|
69
|
+
: [ticketPrefix];
|
|
67
70
|
|
|
68
|
-
const isTicketScope = ticketPrefixes.some((prefix) =>
|
|
71
|
+
const isTicketScope = ticketPrefixes.some((prefix) =>
|
|
72
|
+
scope?.startsWith(`${prefix}-`),
|
|
73
|
+
);
|
|
69
74
|
|
|
70
75
|
if (!scope || scopes.includes(scope) || isTicketScope) {
|
|
71
76
|
return [true];
|
|
72
77
|
}
|
|
73
78
|
|
|
74
|
-
const formattedTickets = ticketPrefixes.map(
|
|
75
|
-
|
|
76
|
-
const scopesEnumsMessage = [...scopes, ...formattedTickets].join(
|
|
77
|
-
', ',
|
|
79
|
+
const formattedTickets = ticketPrefixes.map(
|
|
80
|
+
(ticket) => `${ticket}-XXXX`,
|
|
78
81
|
);
|
|
79
82
|
|
|
83
|
+
const scopesEnumsMessage = [...scopes, ...formattedTickets].join(', ');
|
|
84
|
+
|
|
80
85
|
return [false, `scope must be one of [${scopesEnumsMessage}]`];
|
|
81
86
|
},
|
|
82
87
|
],
|
package/package.json
CHANGED
|
@@ -1,22 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astral/commitlint-config",
|
|
3
|
-
"main": "./
|
|
4
|
-
"version": "2.5.0",
|
|
3
|
+
"main": "./config.js",
|
|
5
4
|
"dependencies": {
|
|
6
|
-
"@commitlint/config-conventional": "^
|
|
7
|
-
"commitlint-plugin-function-rules": "^
|
|
5
|
+
"@commitlint/config-conventional": "^19.8.1",
|
|
6
|
+
"commitlint-plugin-function-rules": "^4.0.1"
|
|
8
7
|
},
|
|
9
8
|
"peerDependencies": {
|
|
10
9
|
"commitlint": ">=16.x.x"
|
|
11
10
|
},
|
|
11
|
+
"version": "2.5.1",
|
|
12
12
|
"author": "Astral.Soft",
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"repository": {
|
|
15
15
|
"type": "git",
|
|
16
|
-
"url": "
|
|
17
|
-
}
|
|
18
|
-
"bugs": {
|
|
19
|
-
"url": "https://github.com/kaluga-astral/code-style/issues"
|
|
20
|
-
},
|
|
21
|
-
"keywords": []
|
|
16
|
+
"url": "https://git.astralnalog.ru/frontend.shared/commitlint-config"
|
|
17
|
+
}
|
|
22
18
|
}
|