Skip to content

Commit

Permalink
Generate project with oss-box
Browse files Browse the repository at this point in the history
  • Loading branch information
mattphillips committed May 2, 2018
1 parent f0d55fb commit 9b78fb6
Show file tree
Hide file tree
Showing 12 changed files with 3,541 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"projectName": "jest-chain",
"projectOwner": "mattphillips",
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"contributors": [
{
"login": "mattphillips",
"name": "Matt Phillips",
"avatar_url": "https://avatars0.githubusercontent.com/u/5610087?v=4",
"profile": "http://mattphillips.io",
"contributions": [
"code",
"doc",
"example",
"ideas",
"infra",
"test"
]
}
],
"repoType": "github"
}
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!--
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
If you are raising a bug uncomment the next section and fill in the relevant information.
If you would like to request a feature then uncomment the last section :)
-->

<!--
**Bug**
- `package` version:
- `node` version:
- `npm` (or `yarn`) version:
Relevant code or config
```javascript
```
What you did:
What happened (please provide anything you think will help):
Reproduction repository (if possible):
-->

<!--
**Feature Request**
Description:
Possible solution:
-->
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--
Thanks for spending the time to send this PR :D.
Please fill out the information below and make sure you're familiar
with the contributing guidelines (found in the CONTRIBUTING.md file).
-->

<!-- What changes are being made? (feature/bug) -->
### What

<!-- Why are these changes necessary? Link any related issues -->
### Why

<!-- If necessary add any additional notes on the implementation -->
### Notes

### Housekeeping

- [ ] Unit tests
- [ ] Documentation is up to date
- [ ] No additional lint warnings
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
dist
.DS_Store
*.log
coverage
9 changes: 9 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
language: node_js
node_js:
- '8'
- '6'
cache:
directories:
- node_modules
script: 'yarn test:coverage'
after_success: 'yarn test:report'
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing

Thanks for being willing to contribute!

**Working on your first Pull Request?** You can learn how from this *free* series
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

## Project setup

1. Fork and clone the repo
2. `$ yarn install` to install dependencies
3. `$ yarn test` to validate you've got it working
4. Create a branch for your PR

## Making changes

- All changes should have unit tests
- Any relevant documentation should be updated
- No linting warnings/errors should be introduced

## Committing and Pushing changes

Once you are ready to commit the changes, please use the below commands

1. `git add <files to be comitted>`
2. `git commit -m 'A meaningful message`

*Note: please use present tense in commit messages i.e. `Add feature X` and not ~`Added feature X`~*

## Add yourself as a contributor

This project follows the [all contributors](https://github.com/kentcdodds/all-contributors)
specification. To add yourself to the table of contributors on the README.md, please use
the automated script as part of your PR:

```console
yarn contributor <YOUR_GITHUB_USERNAME>
```

Follow the prompt. If you've already added yourself to the list and are making a
new type of contribution, you can run it again and select the added contribution
type. If you need to edit the `.all-contributorsrc` file by hand that's fine
too, just run `yarn contributor:generate` to regenerate the table

## Help needed

Please checkout the [ROADMAP](docs/ROADMAP.md) and raise an issue to discuss
any of the items
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018-present Matt Phillips <matt@mattphillips.io> (mattphillips.io)

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:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<div align="center">
<h1>jest-chain</h1>


Chain Jest matchers together to create one expectation
</div>

<hr />

[![Build Status](https://img.shields.io/travis/mattphillips/jest-chain.svg?style=flat-square)](https://travis-ci.org/mattphillips/jest-chain)
[![Code Coverage](https://img.shields.io/codecov/c/github/mattphillips/jest-chain.svg?style=flat-square)](https://codecov.io/github/mattphillips/jest-chain)
[![version](https://img.shields.io/npm/v/jest-chain.svg?style=flat-square)](https://www.npmjs.com/package/jest-chain)
[![downloads](https://img.shields.io/npm/dm/jest-chain.svg?style=flat-square)](http://npm-stat.com/charts.html?package=jest-chain&from=2017-09-14)
[![MIT License](https://img.shields.io/npm/l/jest-chain.svg?style=flat-square)](https://github.com/mattphillips/jest-chain/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Roadmap](https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square)](https://github.com/mattphillips/jest-chain/blob/master/docs/ROADMAP.md)
[![Examples](https://img.shields.io/badge/%F0%9F%92%A1-examples-ff615b.svg?style=flat-square)](https://github.com/mattphillips/jest-chain/blob/master/docs/EXAMPLES.md)

## Problem

## Solution

## Installation

With npm:
```sh
npm install --save-dev jest-chain
```

With yarn:
```sh
yarn add -D jest-chain
```

## Setup

## Usage

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars0.githubusercontent.com/u/5610087?v=4" width="100px;"/><br /><sub><b>Matt Phillips</b></sub>](http://mattphillips.io)<br />[💻](https://github.com/mattphillips/jest-chain/commits?author=mattphillips "Code") [📖](https://github.com/mattphillips/jest-chain/commits?author=mattphillips "Documentation") [💡](#example-mattphillips "Examples") [🤔](#ideas-mattphillips "Ideas, Planning, & Feedback") [🚇](#infra-mattphillips "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/mattphillips/jest-chain/commits?author=mattphillips "Tests") |
| :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

## LICENSE

[MIT](/LICENSE)
3 changes: 3 additions & 0 deletions docs/EXAMPLES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Examples

☹️ None created yet, fancy adding some? See [CONTRIBUTING](/CONTRIBUTING.md)
3 changes: 3 additions & 0 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Project Roadmap

## Want something added? Feel free to open an issue :)
36 changes: 36 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"name": "jest-chain",
"version": "1.0.0",
"description": "Chain Jest matchers together to create one expectation",
"main": "dist/index.js",
"scripts": {
"contributor": "all-contributors add",
"contributor:gen": "all-contributors generate",
"test": "jest",
"test:coverage": "yarn test -- --coverage",
"test:report": "codecov"
},
"keywords": [
"jest",
"matchers",
"chain",
"chainable",
"expect",
"test"
],
"author": "Matt Phillips <matt@mattphillips.io> (mattphillips.io)",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/mattphillips/jest-chain.git"
},
"bugs": {
"url": "https://github.com/mattphillips/jest-chain/issues"
},
"homepage": "https://github.com/mattphillips/jest-chain#readme",
"devDependencies": {
"all-contributors-cli": "^4.11.1",
"codecov": "^3.0.1",
"jest": "^22.4.3"
}
}
Loading

0 comments on commit 9b78fb6

Please sign in to comment.