Skip to content

Commit

Permalink
Empty skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
overlookmotel committed May 18, 2020
0 parents commit e2a1625
Show file tree
Hide file tree
Showing 16 changed files with 7,783 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# jest-expect-subclass module
# Editor config

root = true

[*]
indent_style = tab
indent_size = 2

end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{json,yml,md}]
indent_style = space
indent_size = 2
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
!.*
coverage
15 changes: 15 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/* --------------------
* jest-expect-subclass module
* ESLint config
* ------------------*/

'use strict';

// Exports

module.exports = {
extends: [
'@overlookmotel/eslint-config',
'@overlookmotel/eslint-config-node'
]
};
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
coverage
node_modules
24 changes: 24 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
language: node_js

script:
- "npm run ci"

node_js:
- "14"
- "13"
- "12"
- "10"

branches:
except:
- /^v\d+\./

matrix:
fast_finish: true
include:
- node_js: "12"
env: COVERAGE=true
allow_failures:
- env: COVERAGE=true

cache: npm
19 changes: 19 additions & 0 deletions License
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2020 Overlook Motel (theoverlookmotel@gmail.com)

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.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[![NPM version](https://img.shields.io/npm/v/jest-expect-subclass.svg)](https://www.npmjs.com/package/jest-expect-subclass)
[![Build Status](https://img.shields.io/travis/overlookmotel/jest-expect-subclass/master.svg)](http://travis-ci.org/overlookmotel/jest-expect-subclass)
[![Dependency Status](https://img.shields.io/david/overlookmotel/jest-expect-subclass.svg)](https://david-dm.org/overlookmotel/jest-expect-subclass)
[![Dev dependency Status](https://img.shields.io/david/dev/overlookmotel/jest-expect-subclass.svg)](https://david-dm.org/overlookmotel/jest-expect-subclass)
[![Greenkeeper badge](https://badges.greenkeeper.io/overlookmotel/jest-expect-subclass.svg)](https://greenkeeper.io/)
[![Coverage Status](https://img.shields.io/coveralls/overlookmotel/jest-expect-subclass/master.svg)](https://coveralls.io/r/overlookmotel/jest-expect-subclass)

# Jest expect matchers for subclasses

## Usage

This module is under development and not ready for use yet.

## Versioning

This module follows [semver](https://semver.org/). Breaking changes will only be made in major version updates.

All active NodeJS release lines are supported (v10+ at time of writing). After a release line of NodeJS reaches end of life according to [Node's LTS schedule](https://nodejs.org/en/about/releases/), support for that version of Node may be dropped at any time, and this will not be considered a breaking change. Dropping support for a Node version will be made in a minor version update (e.g. 1.2.0 to 1.3.0). If you are using a Node version which is approaching end of life, pin your dependency of this module to patch updates only using tilde (`~`) e.g. `~1.2.3` to avoid breakages.

## Tests

Use `npm test` to run the tests. Use `npm run cover` to check coverage.

## Changelog

See [changelog.md](https://github.com/overlookmotel/jest-expect-subclass/blob/master/changelog.md)

## Issues

If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/jest-expect-subclass/issues

## Contribution

Pull requests are very welcome. Please:

* ensure all tests pass before submitting PR
* add tests for new features
* document new functionality/API additions in README
* do not add an entry to Changelog (Changelog is created when cutting releases)
5 changes: 5 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## Next

* Initial release
10 changes: 10 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/* --------------------
* jest-expect-subclass module
* Entry point
* ------------------*/

'use strict';

// Exports

module.exports = {};
15 changes: 15 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/* --------------------
* jest-expect-subclass module
* Jest config
* ------------------*/

'use strict';

// Exports

module.exports = {
testEnvironment: 'node',
coverageDirectory: 'coverage',
collectCoverageFrom: ['index.js', 'lib/**/*.js'],
setupFilesAfterEnv: ['jest-extended']
};
Loading

0 comments on commit e2a1625

Please sign in to comment.