Skip to content
This repository has been archived by the owner on Aug 4, 2020. It is now read-only.

Commit

Permalink
feat: init project
Browse files Browse the repository at this point in the history
  • Loading branch information
getaclue00 committed Dec 8, 2018
0 parents commit 4da3b70
Show file tree
Hide file tree
Showing 14 changed files with 13,428 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/coverage/**
/node_modules/**
16 changes: 16 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
'use strict';

exports = module.exports = {
extends: 'standard',
rules: {
semi: [2, 'always'],
'space-before-function-paren': [
'error',
{
anonymous: 'always',
named: 'never',
asyncArrow: 'always'
}
]
}
};
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
out/
coverage/
21 changes: 21 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
language: node_js
node_js:
- '11'
- '10'
- '8'
sudo: false
cache: npm

script: echo "Running tests against $(node -v)..."

jobs:
include:
- stage: Produce Coverage
node_js: node
script:
- npm run test:full
after_success:
- npm run semantic-release
branches:
except:
- /^v\d+\.\d+\.\d+$/
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Template from https://gist.github.com/jxson/1784669

## Synopsis

At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

## Code Example

Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

## Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.

## Installation

Provide code examples and explanations of how to get the project.

## API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

## Tests

Describe and show how to run the tests with code examples.

## Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

## License

A short snippet describing the license (MIT, Apache, etc.)
5 changes: 5 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use strict';

exports = module.exports = {
presets: ['@babel/preset-env']
};
3 changes: 3 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict';

exports = module.exports = require('./src/index');
8 changes: 8 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
'use strict';

exports = module.exports = {
testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/coverage/'],
bail: true,
verbose: true,
collectCoverage: true
};
8 changes: 8 additions & 0 deletions jsdoc.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
'use strict';

exports = module.exports = {
plugins: ['plugins/markdown'],
source: {
include: ['src/']
}
};
Loading

0 comments on commit 4da3b70

Please sign in to comment.