From 508fdc3d6bad00d17e19cfd01786f2e719870e8b Mon Sep 17 00:00:00 2001 From: Moshe Kolodny Date: Tue, 9 Jun 2015 21:15:18 -0400 Subject: [PATCH] inital commit --- .editorconfig | 12 ++++++++++++ .gitignore | 2 ++ .npmignore | 3 +++ .travis.yml | 9 +++++++++ README.md | 29 +++++++++++++++++++++++++++++ index.js | 1 + lib/index.js | 7 +++++++ package.json | 26 ++++++++++++++++++++++++++ test/simple.js | 8 ++++++++ 9 files changed, 97 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .npmignore create mode 100644 .travis.yml create mode 100644 README.md create mode 100644 index.js create mode 100644 lib/index.js create mode 100644 package.json create mode 100644 test/simple.js diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..9165c78 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# http://editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 2 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..25fbf5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +coverage/ diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..281491b --- /dev/null +++ b/.npmignore @@ -0,0 +1,3 @@ +node_modules/ +test/ +coverage/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..92f97f9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,9 @@ +language: node_js +node_js: + - "0.10" + - "0.11" + - "0.12" + - "iojs" +script: "npm run-script test-travis" +# Send coverage data to Coveralls +after_script: "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js" diff --git a/README.md b/README.md new file mode 100644 index 0000000..68c9614 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +node-sample-plugin +=== + +[![Gitter][gitter-image]][gitter-url] +[![NPM version][npm-image]][npm-url] +[![Build status][travis-image]][travis-url] +[![Test coverage][coveralls-image]][coveralls-url] +[![Downloads][downloads-image]][downloads-url] + +Does awesome stuff + +#### Usage + +```js +var nodeSamplePlugin = require('node-sample-plugin'); +console.log( nodeSamplePlugin('yay!') ); +``` + + +[npm-image]: https://img.shields.io/npm/v/node-sample-plugin.svg?style=flat-square +[npm-url]: https://npmjs.org/package/node-sample-plugin +[travis-image]: https://img.shields.io/travis/kolodny/node-sample-plugin.svg?style=flat-square +[travis-url]: https://travis-ci.org/kolodny/node-sample-plugin +[coveralls-image]: https://img.shields.io/coveralls/kolodny/node-sample-plugin.svg?style=flat-square +[coveralls-url]: https://coveralls.io/r/kolodny/node-sample-plugin +[downloads-image]: http://img.shields.io/npm/dm/node-sample-plugin.svg?style=flat-square +[downloads-url]: https://npmjs.org/package/node-sample-plugin +[gitter-image]: https://badges.gitter.im/Join%20Chat.svg +[gitter-url]: https://gitter.im/kolodny/node-sample-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge diff --git a/index.js b/index.js new file mode 100644 index 0000000..bb0a047 --- /dev/null +++ b/index.js @@ -0,0 +1 @@ +module.exports = require('./lib'); diff --git a/lib/index.js b/lib/index.js new file mode 100644 index 0000000..e04bbea --- /dev/null +++ b/lib/index.js @@ -0,0 +1,7 @@ +// var fs = require('fs'); + +module.exports = nodeSamplePlugin; + +function nodeSamplePlugin(str) { + return str.toString().toUpperCase(); +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..7aed9fb --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "node-sample-plugin", + "version": "0.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "mocha", + "test-cov": "node ./node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- --reporter dot", + "test-travis": "node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- --reporter spec" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/kolodny/node-sample-plugin.git" + }, + "author": "Moshe Kolodny", + "license": "MIT", + "bugs": { + "url": "https://github.com/kolodny/node-sample-plugin/issues" + }, + "homepage": "https://github.com/kolodny/node-sample-plugin#readme", + "devDependencies": { + "coveralls": "^2.11.2", + "istanbul": "^0.3.15", + "mocha": "^2.2.5" + } +} diff --git a/test/simple.js b/test/simple.js new file mode 100644 index 0000000..5fa9e60 --- /dev/null +++ b/test/simple.js @@ -0,0 +1,8 @@ +var assert = require('assert'); +var nodeSamplePlugin = require('..'); + +describe('node-sample-plugin', function() { + it('does awesome stuff', function() { + assert.equal( nodeSamplePlugin('yay!'), 'YAY!' ); + }); +});