@w5s/commitlint-config 1.0.0-alpha.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 +54 -0
- package/commitlint.config.js +3 -0
- package/package.json +41 -0
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=# W5s Commitlint configuration _(${name})_) -->
|
|
2
|
+
# W5s Commitlint configuration _(@w5s/commitlint-config)_
|
|
3
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
4
|
+
|
|
5
|
+
[![NPM Version][package-version-svg]][package-url]
|
|
6
|
+
[![License][license-image]][license-url]
|
|
7
|
+
|
|
8
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=> ${description}&unknownTxt= ) -->
|
|
9
|
+
> Commitlint configuration presets
|
|
10
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=```console\nnpm install --save-dev ${name} @commitlint/cli\n```) -->
|
|
15
|
+
```console
|
|
16
|
+
npm install --save-dev @w5s/commitlint-config @commitlint/cli
|
|
17
|
+
```
|
|
18
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
In the `package.json` of your project
|
|
23
|
+
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"commitlint": {
|
|
27
|
+
"extends": ["@w5s/commitlint-config"],
|
|
28
|
+
"rules": {}
|
|
29
|
+
},
|
|
30
|
+
"husky": {
|
|
31
|
+
"hooks": {
|
|
32
|
+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[${license}][license-url] © ${author}) -->
|
|
40
|
+
[MIT][license-url] © Julien Polo <julien.polo@gmail.com>
|
|
41
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
42
|
+
|
|
43
|
+
<!-- VARIABLES -->
|
|
44
|
+
|
|
45
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
|
|
46
|
+
[package-version-svg]: https://img.shields.io/npm/v/@w5s/commitlint-config.svg?style=flat-square
|
|
47
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
48
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
|
|
49
|
+
[package-url]: https://www.npmjs.com/package/@w5s/commitlint-config
|
|
50
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
51
|
+
<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
|
|
52
|
+
[license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
|
|
53
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
54
|
+
[license-url]: ../../LICENSE
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@w5s/commitlint-config",
|
|
3
|
+
"version": "1.0.0-alpha.1",
|
|
4
|
+
"description": "Commitlint configuration presets",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"commitlint",
|
|
7
|
+
"git",
|
|
8
|
+
"lint"
|
|
9
|
+
],
|
|
10
|
+
"homepage": "https://github.com/w5s/project-config/blob/master/packages/commitlint-config#readme",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/w5s/project-config/issues"
|
|
13
|
+
},
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "https://github.com/w5s/project-config.git",
|
|
17
|
+
"directory": "packages/commitlint-config"
|
|
18
|
+
},
|
|
19
|
+
"license": "MIT",
|
|
20
|
+
"author": "Julien Polo <julien.polo@gmail.com>",
|
|
21
|
+
"main": "commitlint.config.js",
|
|
22
|
+
"files": [
|
|
23
|
+
"commitlint.config.js"
|
|
24
|
+
],
|
|
25
|
+
"scripts": {
|
|
26
|
+
"build": "npm-run-all -p 'build:*'",
|
|
27
|
+
"build:empty": ":",
|
|
28
|
+
"docs": "md-magic --path '**/*.md' --ignore='node_modules'",
|
|
29
|
+
"test": "exit 0",
|
|
30
|
+
"test:git-log": "cd ../..;npm exec -- commitlint --from HEAD~3 --to HEAD --verbose"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"@commitlint/config-conventional": "^16.0.0"
|
|
34
|
+
},
|
|
35
|
+
"peerDependencies": {
|
|
36
|
+
"@commitlint/cli": "^16.0.0"
|
|
37
|
+
},
|
|
38
|
+
"publishConfig": {
|
|
39
|
+
"access": "public"
|
|
40
|
+
}
|
|
41
|
+
}
|