Skip to content

Commit

Permalink
Empty skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
overlookmotel committed Apr 27, 2018
0 parents commit 30b24aa
Show file tree
Hide file tree
Showing 11 changed files with 260 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 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]

# Change these settings to your own preference
indent_style = tab
indent_size = 4

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
node_modules
coverage
70 changes: 70 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
// enforcing options
"bitwise":true,
"camelcase":true,
"curly":false,
"eqeqeq":false,
"esversion":6,
"forin":false,
"freeze":true,
"funcscope":false,
"futurehostile":true,
"immed":true,
"indent":1,
"iterator":false,
"latedef":"nofunc",
"maxcomplexity":false,
"maxdepth":false,
"maxerr":50,
"maxlen":false,
"maxparams":false,
"maxstatements":false,
"newcap":true,
"noarg":true,
"nocomma":true,
"noempty":true,
"nonbsp":true,
"nonew":true,
"notypeof":true,
"quotmark":"single",
"shadow":false,
"singleGroups":true,
"strict":"global",
"undef":true,
"unused":"strict",
"varstmt":true,
"-W041":false, // suppress "Use '===' to compare with '0'" errors

// relaxing options
"asi":false,
"boss":false,
"debug":false,
"elision":false,
"eqnull":false,
"evil":false,
"expr":false,
"lastsemic":false,
"laxbreak":false,
"laxcomma":false,
"loopfunc":false,
"moz":false,
"multistr":false,
"notypeof":false,
"noyield":false,
"plusplus":false,
"proto":false,
"scripturl":false,
"sub":false,
"supernew":false,
"validthis":false,
"withstmt":false,

// environment options
"node":true,

"globals": {
},

"predef": [
]
}
7 changes: 7 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
test
coverage
.editorconfig
.gitignore
.jshintrc
.npmignore
.travis.yml
23 changes: 23 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
language: node_js

script:
- "npm run travis"

node_js:
- "6"
- "8"
- "10"

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

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

sudo: false
19 changes: 19 additions & 0 deletions License
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2018 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.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# stream-gen.js

# Create streams from generators and test them

## Current status

[![NPM version](https://img.shields.io/npm/v/stream-gen.svg)](https://www.npmjs.com/package/stream-gen)
[![Build Status](https://img.shields.io/travis/overlookmotel/stream-gen/master.svg)](http://travis-ci.org/overlookmotel/stream-gen)
[![Dependency Status](https://img.shields.io/david/overlookmotel/stream-gen.svg)](https://david-dm.org/overlookmotel/stream-gen)
[![Dev dependency Status](https://img.shields.io/david/dev/overlookmotel/stream-gen.svg)](https://david-dm.org/overlookmotel/stream-gen)
[![Greenkeeper badge](https://badges.greenkeeper.io/overlookmotel/stream-gen.svg)](https://greenkeeper.io/)
[![Coverage Status](https://img.shields.io/coveralls/overlookmotel/stream-gen/master.svg)](https://coveralls.io/r/overlookmotel/stream-gen)

## Usage

## Tests

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

## Changelog

See [changelog.md](https://github.com/overlookmotel/stream-gen/blob/master/changelog.md)

## Issues

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

## Contribution

Pull requests are very welcome. Please:

* ensure all tests pass before submitting PR
* add an entry to changelog
* add tests for new features
* document new functionality/API additions in README
3 changes: 3 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

## Next
9 changes: 9 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* --------------------
* stream-gen module
* ------------------*/

'use strict';

// Exports
module.exports = function() {
};
49 changes: 49 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"name": "stream-gen",
"version": "0.0.0",
"description": "Create streams from generators and test them",
"main": "./lib/",
"author": {
"name": "Overlook Motel"
},
"repository": {
"type": "git",
"url": "https://github.com/overlookmotel/stream-gen.git"
},
"bugs": {
"url": "https://github.com/overlookmotel/stream-gen/issues"
},
"dependencies": {
},
"devDependencies": {
"chai": "^4.1.2",
"coveralls": "^3.0.0",
"cross-env": "^5.1.4",
"istanbul": "^0.4.5",
"jshint": "^2.9.5",
"mocha": "^5.1.0"
},
"keywords": [
"stream",
"generator",
"iterator",
"test",
"spec",
"readable",
"writable"
],
"scripts": {
"test": "npm run jshint && npm run test-main",
"jshint": "jshint lib test",
"test-main": "mocha --check-leaks --colors -t 10000 -R spec \"test/**/*.test.js\"",
"cover": "npm run cover-main && rm -rf coverage",
"coveralls": "npm run cover-main && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
"cover-main": "cross-env COVERAGE=true istanbul cover _mocha --report lcovonly -- -t 10000 -R spec \"test/**/*.test.js\"",
"travis": "if [ $COVERAGE ]; then npm run coveralls; else npm test; fi"
},
"engines": {
"node": ">=6"
},
"readmeFilename": "README.md",
"license": "MIT"
}
25 changes: 25 additions & 0 deletions test/all.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/* --------------------
* stream-gen module
* Tests
* ------------------*/

'use strict';

// Modules
const chai = require('chai'),
{expect} = chai,
streamGen = require('../lib/');

// Init
chai.config.includeStack = true;

// Tests

/* jshint expr: true */
/* global describe, it */

describe('Tests', function() {
it.skip('all', function() {
expect(streamGen).to.be.ok;
});
});

0 comments on commit 30b24aa

Please sign in to comment.