Skip to content

Commit 3d76275

Browse files
PierreBrisorgueilPierreBrisorgueil
committed
feat(global): init ✨
0 parents  commit 3d76275

14 files changed

+12467
-0
lines changed

‎.editorconfig

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# Howto with your editor: http://editorconfig.org/#download
4+
# Sublime: https://github.com/sindresorhus/editorconfig-sublime
5+
6+
# top-most EditorConfig file
7+
root = true
8+
9+
# Unix-style newlines with a newline ending every file
10+
[**]
11+
end_of_line = lf
12+
insert_final_newline = true
13+
14+
# Standard at: https://github.com/felixge/node-style-guide
15+
[**.{js,json}]
16+
trim_trailing_whitespace = true
17+
indent_style = space
18+
indent_size = 2
19+
quote_type = single
20+
curly_bracket_next_line = false
21+
spaces_around_operators = true
22+
space_after_control_statements = true
23+
space_after_anonymous_functions = true
24+
spaces_in_brackets = false
25+
26+
# No Standard. Please document a standard if different from .js
27+
[**.{yml,css}]
28+
trim_trailing_whitespace = true
29+
indent_style = tab
30+
31+
[**.html]
32+
trim_trailing_whitespace = true
33+
indent_style = space
34+
indent_size = 2
35+
36+
# No standard. Please document a standard if different from .js
37+
[**.md]
38+
indent_style = tab
39+
40+
# Standard at:
41+
[Makefile]
42+
indent_style = tab
43+
44+
# The indentation in package.json will always need to be 2 spaces
45+
# https://github.com/npm/npm/issues/4718
46+
[{package, bower}.json]
47+
indent_style = space
48+
indent_size = 2

‎.eslintrc.js

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
module.exports = {
2+
extends: [
3+
'airbnb-base'
4+
],
5+
rules: {
6+
'max-len': 0,
7+
'no-console': 0,
8+
'no-param-reassign': 0,
9+
'global-require': 0,
10+
'prefer-destructuring': ['error', {'object': false, 'array': false}],
11+
'import/no-dynamic-require': 0,
12+
// due to switch es6
13+
'consistent-return': 0,
14+
'no-underscore-dangle': 0,
15+
'no-shadow': 0
16+
},
17+
env: {
18+
node: true,
19+
es6: true,
20+
browser: true,
21+
jest: true,
22+
mongo: true,
23+
},
24+
parserOptions: {
25+
ecmaVersion: 10,
26+
sourceType: 'module',
27+
}
28+
};
29+

‎.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Logs
2+
logs
3+
*.log
4+
5+
# Runtime data
6+
pids
7+
*.pid
8+
*.seed
9+
10+
# Directory for instrumented libs generated by jscoverage/JSCover
11+
lib-cov
12+
13+
# Coverage directory used by tools like istanbul
14+
coverage
15+
16+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
17+
.grunt
18+
19+
# node-waf configuration
20+
.lock-wscript
21+
22+
# Compiled binary addons (http://nodejs.org/api/addons.html)
23+
build/Release
24+
25+
# Dependency directory
26+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
27+
node_modules
28+
29+
.DS_Store

‎.travis.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
language: node_js
2+
node_js:
3+
- 10
4+
- 9
5+
matrix:
6+
allow_failures:
7+
- node_js: 11
8+
cache:
9+
directories:
10+
- node_modules
11+
install:
12+
- npm i
13+
jobs:
14+
include:
15+
- stage: release
16+
node_js: lts/*
17+
deploy:
18+
provider: script
19+
skip_cleanup: true
20+
script:
21+
- npx semantic-release
22+
branches:
23+
only:
24+
- master
25+
- /^greenkeeper/.*$/

‎LICENSE.md

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

‎README.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
[![npm](https://badges.weareopensource.me/npm/v/waos-conventional-changelog.svg?style=flat-square)](https://www.npmjs.com/package/waos-conventional-changelog) [![Build Status](https://badges.weareopensource.me/travis/WeAreOpenSourceProjects/waos-conventional-changelog.svg?style=flat-square)](https://travis-ci.org/WeAreOpenSourceProjects/waos-conventional-changelog) [![Code Climate](https://badges.weareopensource.me/codeclimate/maintainability-percentage/WeAreOpenSourceProjects/waos-conventional-changelog.svg?style=flat-square)](https://codeclimate.com/github/WeAreOpenSourceProjects/waos-conventional-changelog/maintainability)
2+
[![Dependencies Status](https://david-dm.org/WeAreOpenSourceProjects/waos-conventional-changelog.svg?style=flat-square)](https://david-dm.org/WeAreOpenSourceProjects/waos-conventional-changelog) [![Greenkeeper badge](https://badges.greenkeeper.io/WeAreOpenSourceProjects/waos-conventional-changelog.svg?style=flat-square)](https://greenkeeper.io/)
3+
[![Known Vulnerabilities](https://snyk.io/test/github/WeAreOpenSourceProjects/waos-conventional-changelog/badge.svg?style=flat-square)](https://snyk.io/test/github/WeAreOpenSourceProjects/waos-conventional-changelog)
4+
5+
[![Blog](https://badges.weareopensource.me/badge/Read-On%20our%20Blog-1abc9c.svg?style=flat-square)](https://weareopensource.me) [![Slack](https://badges.weareopensource.me/badge/Chat-On%20Slack-d0355b.svg?style=flat-square)](mailto:weareopensource.me@gmail.com?subject=Join%20Slack&body=Hi,%20I%20found%20your%20community%20We%20Are%20Open%20Source.%20I%20would%20be%20interested%20to%20join%20the%20Slack%20to%20share%20and%20discuss%20about%20...%20,%20Thanks) [![Mail](https://badges.weareopensource.me/badge/Contact-By%20Mail-3498db.svg?style=flat-square)](mailto:weareopensource.me@gmail.com?subject=Contact)
6+
7+
8+
# Presentation
9+
10+
Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard, based on [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog), which seems to be abandoned. For this reason, we decided to make our own package and included some PRs, switch to ES6 and add an Emoji system for some fun.
11+
12+
PR included :
13+
* yinzara - [feat: implement subject feedback, scope filtering, subject filtering](https://github.com/commitizen/cz-conventional-changelog/pull/75)
14+
15+
![gif](http://waos.ovh/content/gif/waos-conventional-changelog.gif)
16+
17+
# Prerequisites
18+
19+
Make sure you have installed all of the following prerequisites on your development machine:
20+
21+
- Node.js (10.x) - [Download & Install Node.js](https://nodejs.org/en/download/)
22+
23+
# Installation
24+
25+
Global :
26+
27+
```bash
28+
npm install --global commitizen waos-conventional-changelog
29+
```
30+
31+
Local :
32+
33+
```bash
34+
npm install --global commitizen
35+
commitizen init waos-conventional-changelog --save-dev --save-exact
36+
```
37+
38+
# Integration
39+
40+
We suggest to follow something like this : [How to create good commit messages](https://medium.com/@klauskpm/how-to-create-good-commit-messages-67943d30cced). Juste change cz-conventional-changelog part with waos-conventional-changelog
41+
42+
## Configuration
43+
44+
### package.json
45+
46+
Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's `config.commitizen` key.
47+
48+
```json5
49+
{
50+
// ... default values
51+
"config": {
52+
"commitizen": {
53+
"path": "./node_modules/cz-conventional-changelog",
54+
"maxHeaderWidth": 100,
55+
"maxLineWidth": 100,
56+
"defaultType": "",
57+
"defaultScope": "",
58+
"defaultSubject": "",
59+
"defaultBody": "",
60+
"defaultIssues": ""
61+
}
62+
}
63+
// ...
64+
}
65+
```
66+
### Environment variables
67+
68+
The following environment varibles can be used to override any default configuration or package.json based configuration.
69+
70+
* CZ_TYPE = defaultType
71+
* CZ_SCOPE = defaultScope
72+
* CZ_SUBJECT = defaultSubject
73+
* CZ_BODY = defaultBody
74+
* CZ_MAX_HEADER_WIDTH = maxHeaderWidth
75+
* CZ_MAX_LINE_WIDTH = maxLineWidth
76+
77+
### Commitlint
78+
79+
If using the [commitlint](https://github.com/conventional-changelog/commitlint) js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.
80+
81+
82+
# Licence
83+
84+
[![Packagist](https://badges.weareopensource.me/packagist/l/doctrine/orm.svg?style=flat-square)](/LICENSE.md)
85+
86+
# Thanks
87+
88+
[![Help](https://badges.weareopensource.me/badge/Help-On%20Patreon-052d49.svg?style=flat-square)](https://www.patreon.com/pbrisorgueil) [![Cofee](https://badges.weareopensource.me/badge/Buy-Me%20a%20Coffee-FF813F.svg?style=flat-square)](https://www.buymeacoffee.com/JrSa9tZGO)
89+
90+
91+
[![Twitter](https://badges.weareopensource.me/badge/Follow-me%20on%20Twitter-3498db.svg?style=flat-square)](https://twitter.com/pbrisorgueil?lang=fr) [![Youtube](https://badges.weareopensource.me/badge/Watch-me%20on%20Youtube-e74c3c.svg?style=flat-square)](https://www.youtube.com/channel/UCIIjHtrZL5-rFFupn7c3OtA)

‎commitlint.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = { extends: ['@commitlint/config-conventional'] };

‎config/default.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"emojis" : {
3+
"feat": "✨",
4+
"fix": "🐛",
5+
"docs": "📝",
6+
"style": "💄",
7+
"refactor": "♻️",
8+
"perf": "⚡️",
9+
"test": "✅",
10+
"build": "🏗",
11+
"ci": "👷🏼",
12+
"chore": "📦",
13+
"revert": "⏪"
14+
}
15+
}

0 commit comments

Comments
 (0)