Skip to content

Commit 161d982

Browse files
travitravi
committed
feat(initial): extended commitlint-config-travi
0 parents  commit 161d982

14 files changed

+5489
-0
lines changed

‎.commitlintrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {extends: ['travi']};

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
indent_style = space
10+
indent_size = 2
11+
end_of_line = lf
12+
insert_final_newline = true

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎.github/settings.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
repository:
2+
description: shareable config for commitlint
3+
homepage: 'https://npm.im/commitlint-config-traverson'
4+
has_wiki: false
5+
has_projects: false
6+
has_downloads: false
7+
allow_squash_merge: false
8+
allow_merge_commit: true
9+
allow_rebase_merge: true
10+
labels:
11+
- name: bug
12+
color: ee0701
13+
- name: duplicate
14+
color: cccccc
15+
- name: enhancement
16+
color: 84b6eb
17+
- name: help wanted
18+
color: 128A0C
19+
- name: invalid
20+
color: e6e6e6
21+
- name: question
22+
color: cc317c
23+
- name: wontfix
24+
color: ffffff
25+
- name: greenkeeper
26+
color: 00c775
27+
branches:
28+
- name: master
29+
protection:
30+
required_pull_request_reviews: null
31+
required_status_checks: null
32+
restrictions: null
33+
enforce_admins: true

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/node_modules/
2+
/lib/
3+
/coverage/
4+
/.nyc_output/
5+
6+
.eslintcache

‎.huskyrc.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"hooks": {
3+
"commit-msg": "commitlint -e"
4+
}
5+
}

‎.npmignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/.github/
2+
3+
.commitlintrc.js
4+
.editorconfig
5+
.gitattributes
6+
.huskyrc.json
7+
.nvmrc
8+
.travis.yml
9+
rollup.config.js

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v10.7.0

‎.travis.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
language: node_js
2+
notifications:
3+
email: false
4+
branches:
5+
except:
6+
- /^v\d+\.\d+\.\d+$/
7+
before_script:
8+
- 'npm run greenkeeper:update-lockfile'
9+
- npm ls >/dev/null
10+
after_script: 'npm run greenkeeper:upload-lockfile'
11+
after_success: 'npm run coverage:report'
12+
deploy:
13+
provider: script
14+
skip_cleanup: true
15+
script: npx semantic-release
16+
env:
17+
global:
18+
- FORCE_COLOR=1
19+
- NPM_CONFIG_COLOR=always
20+
- GK_LOCK_COMMIT_AMEND=true

‎LICENSE

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
MIT License
2+
3+
4+
5+
Copyright (c) 2018 The Traverson Authors
6+
7+
8+
9+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
10+
11+
12+
13+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14+
15+
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18+

‎README.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# commitlint-config-traverson
2+
3+
shareable config for [commitlint](https://github.com/marionebl/commitlint)
4+
5+
<!-- status badges -->
6+
[![Build Status][ci-badge]][ci-link]
7+
8+
## Purpose
9+
10+
This is a [shareable config](https://marionebl.github.io/commitlint/#/concepts-shareable-config) for [commitlint](https://github.com/marionebl/commitlint), which helps us ensure our commits are compatible with [semantic-release](https://github.com/semantic-release/semantic-release).
11+
12+
This config extends [commitlint-config-travi](https://github.com/travi/commitlint-config-travi).
13+
14+
## Usage
15+
16+
<!-- consumer badges -->
17+
[![npm][npm-badge]][npm-link]
18+
[![MIT license][license-badge]][license-link]
19+
20+
### Installation
21+
22+
```sh
23+
$ npm install commitlint-config-traverson --save-dev
24+
```
25+
26+
### Define the config for your project
27+
28+
```sh
29+
$ echo "module.exports = {extends: ['traverson']};" > .commitlintrc.js
30+
```
31+
32+
### Define the [husky](https://github.com/typicode/husky) hook
33+
34+
([in a `.huskyrc.json`](https://github.com/typicode/husky#upgrading-from-014),
35+
for example)
36+
37+
```json
38+
{
39+
"hooks": {
40+
"commit-msg": "commitlint -e"
41+
}
42+
}
43+
```
44+
45+
## Contributing
46+
47+
<!-- contribution badges -->
48+
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
49+
[![Commitizen friendly][commitizen-badge]][commitizen-link]
50+
[![semantic-release][semantic-release-badge]][semantic-release-link]
51+
[![PRs Welcome][PRs-badge]][PRs-link]
52+
53+
### Dependencies
54+
55+
```sh
56+
$ nvm install
57+
$ npm install
58+
```
59+
60+
### Verification
61+
62+
```sh
63+
$ npm test
64+
```
65+
66+
[npm-link]: https://www.npmjs.com/package/commitlint-config-traverson
67+
[npm-badge]: https://img.shields.io/npm/v/commitlint-config-traverson.svg
68+
[license-link]: LICENSE
69+
[license-badge]: https://img.shields.io/github/license/traverson/commitlint-config-traverson.svg
70+
[ci-link]: https://travis-ci.com/traverson/commitlint-config-traverson
71+
[ci-badge]: https://img.shields.io/travis/traverson/commitlint-config-traverson.svg?branch=master
72+
[commit-convention-link]: https://conventionalcommits.org
73+
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
74+
[commitizen-link]: http://commitizen.github.io/cz-cli/
75+
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
76+
[semantic-release-link]: https://github.com/semantic-release/semantic-release
77+
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
78+
[PRs-link]: http://makeapullrequest.com
79+
[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

‎index.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['travi']
3+
};

0 commit comments

Comments
 (0)