@theholocron/commitlint-config 3.4.4 → 3.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +16 -10
  2. package/README.md +25 -56
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,61 +1,67 @@
1
1
  # @theholocron/commitlint-config
2
2
 
3
+ ## 3.5.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`63a4c85`](https://github.com/theholocron/configs/commit/63a4c858b9e76566798aeb1dd45e4feddd83fb70) Thanks [@iamnewton](https://github.com/iamnewton)! - Remove registry url
8
+
3
9
  ## 3.4.4
4
10
 
5
11
  ### Patch Changes
6
12
 
7
- - [`2e3ce74`](https://github.com/theholocron/configs/commit/2e3ce74b54f83e344bcf79cb9e71fca0ed6e058e) Thanks [@iamnewton](https://github.com/iamnewton)! - Add in tsc as dependency
13
+ - [`2e3ce74`](https://github.com/theholocron/configs/commit/2e3ce74b54f83e344bcf79cb9e71fca0ed6e058e) Thanks [@iamnewton](https://github.com/iamnewton)! - Add in tsc as dependency
8
14
 
9
15
  ## 3.4.3
10
16
 
11
17
  ### Patch Changes
12
18
 
13
- - [`11f27c4`](https://github.com/theholocron/configs/commit/11f27c4c3db883ebb8141b7c4075e74887defc90) Thanks [@iamnewton](https://github.com/iamnewton)! - Add dependency to storybook config
19
+ - [`11f27c4`](https://github.com/theholocron/configs/commit/11f27c4c3db883ebb8141b7c4075e74887defc90) Thanks [@iamnewton](https://github.com/iamnewton)! - Add dependency to storybook config
14
20
 
15
21
  ## 3.4.2
16
22
 
17
23
  ### Patch Changes
18
24
 
19
- - [`d82832c`](https://github.com/theholocron/configs/commit/d82832c27aa3aa775365628bce98f82a5fe129b6) Thanks [@iamnewton](https://github.com/iamnewton)! - fix issue with deprecated prettier config values
25
+ - [`d82832c`](https://github.com/theholocron/configs/commit/d82832c27aa3aa775365628bce98f82a5fe129b6) Thanks [@iamnewton](https://github.com/iamnewton)! - fix issue with deprecated prettier config values
20
26
 
21
27
  ## 3.4.1
22
28
 
23
29
  ### Patch Changes
24
30
 
25
- - [`55b8263`](https://github.com/theholocron/configs/commit/55b8263d8ab99d804e6e5a77d677f1ad0637b5e1) Thanks [@iamnewton](https://github.com/iamnewton)! - Fix issue with prettier config main export
31
+ - [`55b8263`](https://github.com/theholocron/configs/commit/55b8263d8ab99d804e6e5a77d677f1ad0637b5e1) Thanks [@iamnewton](https://github.com/iamnewton)! - Fix issue with prettier config main export
26
32
 
27
33
  ## 3.4.0
28
34
 
29
35
  ### Minor Changes
30
36
 
31
- - [`6dfd8d4`](https://github.com/theholocron/configs/commit/6dfd8d4b1a58459d35af4253db59402e500f92b0) Thanks [@iamnewton](https://github.com/iamnewton)! - Update prettier to use module
37
+ - [`6dfd8d4`](https://github.com/theholocron/configs/commit/6dfd8d4b1a58459d35af4253db59402e500f92b0) Thanks [@iamnewton](https://github.com/iamnewton)! - Update prettier to use module
32
38
 
33
39
  ## 3.3.0
34
40
 
35
41
  ### Minor Changes
36
42
 
37
- - [`30e50b0`](https://github.com/theholocron/configs/commit/30e50b000dd1f9ac61e3ad1c3abee2ab3a52e7ac) Thanks [@iamnewton](https://github.com/iamnewton)! - Add in stylelint
43
+ - [`30e50b0`](https://github.com/theholocron/configs/commit/30e50b000dd1f9ac61e3ad1c3abee2ab3a52e7ac) Thanks [@iamnewton](https://github.com/iamnewton)! - Add in stylelint
38
44
 
39
45
  ## 3.2.1
40
46
 
41
47
  ### Patch Changes
42
48
 
43
- - [`3d54f12`](https://github.com/theholocron/configs/commit/3d54f12618e8a6cc6ccc4559eb48ef402bb04d77) Thanks [@iamnewton](https://github.com/iamnewton)! - Fix the storybook config; its missing the index file from the export
49
+ - [`3d54f12`](https://github.com/theholocron/configs/commit/3d54f12618e8a6cc6ccc4559eb48ef402bb04d77) Thanks [@iamnewton](https://github.com/iamnewton)! - Fix the storybook config; its missing the index file from the export
44
50
 
45
51
  ## 3.2.0
46
52
 
47
53
  ### Minor Changes
48
54
 
49
- - [`46d40c1`](https://github.com/theholocron/configs/commit/46d40c17d963b3c81fd6fdf308da4228112f5fe4) Thanks [@iamnewton](https://github.com/iamnewton)! - Add more to eslint-config, add in storybook-config
55
+ - [`46d40c1`](https://github.com/theholocron/configs/commit/46d40c17d963b3c81fd6fdf308da4228112f5fe4) Thanks [@iamnewton](https://github.com/iamnewton)! - Add more to eslint-config, add in storybook-config
50
56
 
51
57
  ## 3.1.0
52
58
 
53
59
  ### Minor Changes
54
60
 
55
- - [`4f8154a`](https://github.com/theholocron/configs/commit/4f8154a534d5d7668cd2659da322448f39646aed) Thanks [@iamnewton](https://github.com/iamnewton)! - Update to include Alex language linting in lint-staging
61
+ - [`4f8154a`](https://github.com/theholocron/configs/commit/4f8154a534d5d7668cd2659da322448f39646aed) Thanks [@iamnewton](https://github.com/iamnewton)! - Update to include Alex language linting in lint-staging
56
62
 
57
63
  ## 3.0.0
58
64
 
59
65
  ### Major Changes
60
66
 
61
- - [`88d7f99`](https://github.com/theholocron/configs/commit/88d7f995dd02cdbe63817ac0d13905d5aea3777a) Thanks [@iamnewton](https://github.com/iamnewton)! - Initial release
67
+ - [`88d7f99`](https://github.com/theholocron/configs/commit/88d7f995dd02cdbe63817ac0d13905d5aea3777a) Thanks [@iamnewton](https://github.com/iamnewton)! - Initial release
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # CommitLint Config
2
2
 
3
- A [CommitLint configuration](https://commitlint.js.org/reference/configuration.html#shareable-configuration) for writing well-formatted and consistent Git commits.
3
+ A [CommitLint configuration](https://commitlint.js.org/reference/configuration.html#shareable-configuration) for writing well-formatted and consistent Git commits.
4
4
 
5
5
  ## Installation
6
6
 
@@ -14,9 +14,9 @@ In your project `package.json` add the following:
14
14
 
15
15
  ```json
16
16
  {
17
- "commitlint": {
18
- "extends": "@theholocron"
19
- }
17
+ "commitlint": {
18
+ "extends": "@theholocron"
19
+ }
20
20
  }
21
21
  ```
22
22
 
@@ -30,25 +30,9 @@ Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/refer
30
30
 
31
31
  #### type-enum
32
32
 
33
- - **condition**: `type` is found in value
34
- - **rule**: `always`
35
- - **value**
36
-
37
- ```js
38
- [
39
- 'build',
40
- 'ci',
41
- 'chore',
42
- 'docs',
43
- 'feat',
44
- 'fix',
45
- 'perf',
46
- 'refactor',
47
- 'revert',
48
- 'style',
49
- 'test'
50
- ]
51
- ```
33
+ - **condition**: `type` is found in value
34
+ - **rule**: `always`
35
+ - **value**: "build" | "ci" | "chore" | "docs" | "feat" | "fix" | "perf" | "refactor" | "revert" | "style" | "test"
52
36
 
53
37
  ```sh
54
38
  echo "foo: some message" # fails
@@ -57,13 +41,9 @@ echo "fix: some message" # passes
57
41
 
58
42
  #### type-case
59
43
 
60
- - **description**: `type` is in case `value`
61
- - **rule**: `always`
62
- - **value**
63
-
64
- ```js
65
- 'lowerCase'
66
- ```
44
+ - **description**: `type` is in case `value`
45
+ - **rule**: `always`
46
+ - **value**: "lowercase"
67
47
 
68
48
  ```sh
69
49
  echo "FIX: some message" # fails
@@ -72,8 +52,8 @@ echo "fix: some message" # passes
72
52
 
73
53
  #### type-empty
74
54
 
75
- - **condition**: `type` is empty
76
- - **rule**: `never`
55
+ - **condition**: `type` is empty
56
+ - **rule**: `never`
77
57
 
78
58
  ```sh
79
59
  echo ": some message" # fails
@@ -82,12 +62,9 @@ echo "fix: some message" # passes
82
62
 
83
63
  #### scope-case
84
64
 
85
- - **condition**: `scope` is in case `value`
86
- - **rule**: `always`
87
-
88
- ```js
89
- 'lowerCase'
90
- ```
65
+ - **condition**: `scope` is in case `value`
66
+ - **rule**: `always`
67
+ - **value**: "lowercase"
91
68
 
92
69
  ```sh
93
70
  echo "fix(SCOPE): some message" # fails
@@ -96,8 +73,8 @@ echo "fix(scope): some message" # passes
96
73
 
97
74
  #### subject-case
98
75
 
99
- - **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`
100
- - **rule**: `never`
76
+ - **condition**: `subject` is in one of the cases "sentence-case", "start-case", "pascal-case", "upper-case"`
77
+ - **rule**: `never`
101
78
 
102
79
  ```sh
103
80
  echo "fix(SCOPE): Some message" # fails
@@ -110,8 +87,8 @@ echo "fix(scope): some Message" # passes
110
87
 
111
88
  #### subject-empty
112
89
 
113
- - **condition**: `subject` is empty
114
- - **rule**: `never`
90
+ - **condition**: `subject` is empty
91
+ - **rule**: `never`
115
92
 
116
93
  ```sh
117
94
  echo "fix:" # fails
@@ -120,13 +97,9 @@ echo "fix: some message" # passes
120
97
 
121
98
  #### subject-full-stop
122
99
 
123
- - **condition**: `subject` ends with `value`
124
- - **rule**: `never`
125
- - **value**
126
-
127
- ```js
128
- '.'
129
- ```
100
+ - **condition**: `subject` ends with `value`
101
+ - **rule**: `never`
102
+ - **value**: "."
130
103
 
131
104
  ```sh
132
105
  echo "fix: some message." # fails
@@ -135,13 +108,9 @@ echo "fix: some message" # passes
135
108
 
136
109
  #### header-max-length
137
110
 
138
- - **condition**: `header` has `value` or less characters
139
- - **rule**: `always`
140
- - **value**
141
-
142
- ```js
143
- 72
144
- ```
111
+ - **condition**: `header` has `value` or less characters
112
+ - **rule**: `always`
113
+ - **value**: 72
145
114
 
146
115
  ```sh
147
116
  echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/commitlint-config",
3
- "version": "3.4.4",
3
+ "version": "3.5.1",
4
4
  "description": "A CommitLint configuration for writing well-formatted and consistent Git commits.",
5
5
  "homepage": "https://github.com/theholocron/configs/tree/main/packages/commitlint-config#readme",
6
6
  "bugs": "https://github.com/theholocron/configs/issues",