Skip to content
This repository was archived by the owner on Jan 4, 2018. It is now read-only.

Commit 3b4da93

Browse files
pvdlgpvdlg
committed
feat: Initial commit 🎉
0 parents  commit 3b4da93

10 files changed

Lines changed: 9770 additions & 0 deletions

File tree

‎.eslintrc.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
extends: [
3+
'@metahub/eslint-config/es6-config',
4+
'@metahub/eslint-config/promise-config',
5+
'@metahub/eslint-config/ava-config',
6+
'@metahub/eslint-config/prettier-config',
7+
],
8+
parserOptions: {sourceType: 'module'},
9+
};

‎.gitignore‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
2+
# Created by https://www.gitignore.io/api/macos,windows,linux,node
3+
4+
### Linux ###
5+
*~
6+
7+
# temporary files which can be created if a process still has a handle open of a deleted file
8+
.fuse_hidden*
9+
10+
# KDE directory preferences
11+
.directory
12+
13+
# Linux trash folder which might appear on any partition or disk
14+
.Trash-*
15+
16+
# .nfs files are created when an open file is removed but is still being accessed
17+
.nfs*
18+
19+
### macOS ###
20+
*.DS_Store
21+
.AppleDouble
22+
.LSOverride
23+
24+
# Icon must end with two \r
25+
Icon
26+
27+
# Thumbnails
28+
._*
29+
30+
# Files that might appear in the root of a volume
31+
.DocumentRevisions-V100
32+
.fseventsd
33+
.Spotlight-V100
34+
.TemporaryItems
35+
.Trashes
36+
.VolumeIcon.icns
37+
.com.apple.timemachine.donotpresent
38+
39+
# Directories potentially created on remote AFP share
40+
.AppleDB
41+
.AppleDesktop
42+
Network Trash Folder
43+
Temporary Items
44+
.apdisk
45+
46+
### Node ###
47+
# Logs
48+
logs
49+
*.log
50+
npm-debug.log*
51+
yarn-debug.log*
52+
yarn-error.log*
53+
54+
# Runtime data
55+
pids
56+
*.pid
57+
*.seed
58+
*.pid.lock
59+
60+
# Directory for instrumented libs generated by jscoverage/JSCover
61+
lib-cov
62+
63+
# Coverage directory used by tools like istanbul
64+
coverage
65+
66+
# nyc test coverage
67+
.nyc_output
68+
69+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
70+
.grunt
71+
72+
# Bower dependency directory (https://bower.io/)
73+
bower_components
74+
75+
# node-waf configuration
76+
.lock-wscript
77+
78+
# Compiled binary addons (http://nodejs.org/api/addons.html)
79+
build/Release
80+
81+
# Dependency directories
82+
node_modules/
83+
jspm_packages/
84+
85+
# Typescript v1 declaration files
86+
typings/
87+
88+
# Optional npm cache directory
89+
.npm
90+
91+
# Optional eslint cache
92+
.eslintcache
93+
94+
# Optional REPL history
95+
.node_repl_history
96+
97+
# Output of 'npm pack'
98+
*.tgz
99+
100+
# Yarn Integrity file
101+
.yarn-integrity
102+
103+
# dotenv environment variables file
104+
.env
105+
106+
107+
### Windows ###
108+
# Windows thumbnail cache files
109+
Thumbs.db
110+
ehthumbs.db
111+
ehthumbs_vista.db
112+
113+
# Folder config file
114+
Desktop.ini
115+
116+
# Recycle Bin used on file shares
117+
$RECYCLE.BIN/
118+
119+
# Windows Installer files
120+
*.cab
121+
*.msi
122+
*.msm
123+
*.msp
124+
125+
# Windows shortcuts
126+
*.lnk
127+
128+
# End of https://www.gitignore.io/api/macos,windows,linux,node

‎.travis.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
language: node_js
2+
node_js:
3+
- node
4+
cache:
5+
directories:
6+
- node_modules
7+
branches:
8+
only:
9+
- master
10+
- /^greenkeeper.*$/
11+
git:
12+
depth: 3
13+
before_install:
14+
- if [[ `npm -v` < 5* ]]; then npm install -g npm@5; fi
15+
- npm install -g greenkeeper-lockfile@1
16+
before_script:
17+
- npm prune
18+
- greenkeeper-lockfile-update
19+
script:
20+
- npm run test
21+
after_script:
22+
- greenkeeper-lockfile-upload
23+
after_success:
24+
- if [ -n "${CODECOV_TOKEN:-}" ]; then npm run codecov; fi
25+
- npm run semantic-release-pre
26+
- npm run semantic-release-post

‎LICENSE‎

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

‎README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# **conventional-commit-types**
2+
3+
List of conventional commit types extending [conventional-commit-types](https://github.com/commitizen/conventional-commit-types) with emojis and additionnal commit types (aliases).
4+
5+
[![npm](https://img.shields.io/npm/v/conventional-commit-types.svg)](https://www.npmjs.com/package/conventional-commit-types)
6+
[![npm](https://img.shields.io/npm/dt/conventional-commit-types.svg)](https://www.npmjs.com/package/conventional-commit-types)
7+
[![Greenkeeper badge](https://badges.greenkeeper.io/vanduynslagerp/conventional-commit-types.svg)](https://greenkeeper.io/)
8+
[![license](https://img.shields.io/github/license/vanduynslagerp/conventional-commit-types.svg)](https://github.com/vanduynslagerp/conventional-commit-types/blob/master/LICENSE)
9+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
10+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
11+
12+
[![Travis](https://img.shields.io/travis/vanduynslagerp/conventional-commit-types.svg)](https://travis-ci.org/vanduynslagerp/conventional-commit-types)
13+
[![Codecov](https://img.shields.io/codecov/c/github/vanduynslagerp/conventional-commit-types.svg)](https://codecov.io/gh/vanduynslagerp/conventional-commit-types)
14+
15+
Used by [cz-conventional-commit](https://github.com/vanduynslagerp/cz-conventional-commit).
16+
17+
Commit types originally from:
18+
* [Angular Git Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type)
19+
* [commitizen/cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
20+
* [conventional-commit-types](https://github.com/commitizen/conventional-commit-types)
21+
22+
## Commit types
23+
24+
| Commit Type | Title | Description | Emoji |
25+
| ----------- | ------------------------ | ----------------------------------------------------------------------------------------------------------- |:------:|
26+
| `feat` | Features | A new feature | ✨ |
27+
| `fix` | Bug Fixes | A bug Fix | 🐛 |
28+
| `docs` | Documentation | Documentation only changes | 📚 |
29+
| `style` | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 |
30+
| `refactor` | Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 |
31+
| `perf` | Performance Improvements | A code change that improves performance | 🚀 |
32+
| `test` | Tests | Adding missing tests or correcting existing tests | 🚨 |
33+
| `build` | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 |
34+
| `ci` | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ |
35+
| `chore` | Chores | Other changes that don't modify src or test files | ♻️ |
36+
| `revert` | Reverts | Reverts a previous commit | 🗑 |
37+
38+
## Commit aliases
39+
40+
Aliases allow to have additionnal commit types (in a tool like [commitizen](https://github.com/commitizen/cz-cli) for example) that can be formatted to follow [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).
41+
42+
For example the [commitizen](https://github.com/commitizen/cz-cli) CLI can present the choice `initial` and the final commit message will be 'feat: Initial commit 🎉'
43+
44+
| Commit Type | Maps to | Title | Description | Emoji |
45+
| ------------------ | ------- | ----------------- | ------------------------------ |:------:|
46+
| `initial` | `feat` | Initial | Initial commit | 🎉 |
47+
| `dependencies` | `fix` | Dependencies | Update dependencies | ⏫ |
48+
| `peerDependencies` | `fix` | Peer dependencies | Update peer dependencies | ⬆️ |
49+
| `devDependencies` | `chore` | Dev dependencies | Update development dependencies | 🔼 |
50+
| `metadata` | `fix` | Metadata | Update metadata (package.json) | 📦 |

‎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-angular']};

‎index.js‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
module.exports = {
2+
types: {
3+
feat: {
4+
description: 'A new feature',
5+
title: 'Features',
6+
emoji: '✨',
7+
},
8+
fix: {
9+
description: 'A bug fix',
10+
title: 'Bug Fixes',
11+
emoji: '🐛',
12+
},
13+
docs: {
14+
description: 'Documentation only changes',
15+
title: 'Documentation',
16+
emoji: '📚',
17+
},
18+
style: {
19+
description:
20+
'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
21+
title: 'Styles',
22+
emoji: '💎',
23+
},
24+
refactor: {
25+
description: 'A code change that neither fixes a bug nor adds a feature',
26+
title: 'Code Refactoring',
27+
emoji: '📦',
28+
},
29+
perf: {
30+
description: 'A code change that improves performance',
31+
title: 'Performance Improvements',
32+
emoji: '🚀',
33+
},
34+
test: {
35+
description: 'Adding missing tests or correcting existing tests',
36+
title: 'Tests',
37+
emoji: '🚨',
38+
},
39+
build: {
40+
description:
41+
'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
42+
title: 'Builds',
43+
emoji: '🛠',
44+
},
45+
ci: {
46+
description:
47+
'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
48+
title: 'Continuous Integrations',
49+
emoji: '⚙️',
50+
},
51+
chore: {
52+
description: "Other changes that don't modify src or test files",
53+
title: 'Chores',
54+
emoji: '♻️',
55+
},
56+
revert: {
57+
description: 'Reverts a previous commit',
58+
title: 'Reverts',
59+
emoji: '🗑',
60+
},
61+
},
62+
aliases: {
63+
initial: {
64+
type: 'feat',
65+
description: 'Initial commit',
66+
title: 'Initial',
67+
emoji: '🎉',
68+
},
69+
dependencies: {
70+
type: 'fix',
71+
description: 'Update dependencies',
72+
title: 'Dependencies',
73+
emoji: '⏫',
74+
},
75+
peerDependencies: {
76+
type: 'fix',
77+
description: 'Update peer dependencies',
78+
title: 'Peer dependencies',
79+
emoji: '⬆️',
80+
},
81+
devDependencies: {
82+
type: 'chore',
83+
description: 'Update development dependencies',
84+
title: 'Dev dependencies',
85+
emoji: '🔼',
86+
},
87+
metadata: {
88+
type: 'fix',
89+
description: 'Update metadata (package.json)',
90+
title: 'Metadata',
91+
emoji: '📦',
92+
},
93+
},
94+
};

0 commit comments

Comments
 (0)