Skip to content

Commit 9bbb8e4

Browse files
committed
Initial commit
0 parents  commit 9bbb8e4

16 files changed

+392
-0
lines changed

.babelrc.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
presets: [
3+
['@babel/preset-env', {
4+
targets: { node: 6 },
5+
}],
6+
],
7+
}

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_size = 2
6+
end_of_line = lf
7+
indent_style = space
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
coverage/
2+
lib/

.eslintrc.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
module.exports = {
2+
parser: 'babel-eslint',
3+
extends: ['airbnb-base'],
4+
"env": {
5+
"node": true,
6+
"jest": true
7+
},
8+
rules: {
9+
semi: ['error', 'never'],
10+
},
11+
}

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# OS specific
2+
.DS_Store
3+
4+
# Dependency directories
5+
node_modules/
6+
.npm
7+
8+
# Outputs
9+
lib/
10+
coverage/
11+
*.tgz
12+
13+
# Lock files
14+
package-lock.json
15+
yarn.lock
16+
.yarn-integrity
17+
18+
# Logs
19+
logs
20+
*.log
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
lerna-debug.log*

.node-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10.16.2

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10.16.2

.travis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
language: node_js
2+
node_js:
3+
- 10
4+
- 12
5+
install:
6+
- npm install
7+
script:
8+
- npm run lint
9+
- npm test
10+
cache:
11+
directories:
12+
- node_modules

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
Contributions are always welcome, no matter how large or small.
4+
5+
## Developing setup
6+
7+
#### Node
8+
9+
Install [nodenv](https://github.com/nodenv/nodenv) and add append initializer in `.bash_profile`:
10+
11+
```bash
12+
$ brew install nodenv
13+
$ eval "$(nodenv init -)" # add it to .bash_profile
14+
```
15+
16+
Install latest lts Node.js version:
17+
18+
```bash
19+
ndenv install 10.16.0
20+
ndenv global 10.16.0
21+
```
22+
23+
#### Linter
24+
25+
To maintain consistent code style we're using [eslint](https://eslint.org/) with [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) config + some tweaks. We have a pre-commit hook that runs the linter but it's better to install plugin for your IDE/text editor to get immediate feedback about code style problems.
26+
27+
#### Editor config
28+
29+
In order to prevent some problems in source files related to different platforms we're using [`.editorconfig` file](https://editorconfig.org/). Please install plugin for your IDE/text editor.

LICENCE

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

0 commit comments

Comments
 (0)