Merge pull request #71 from Kronos-Integration/template-sync-1

merge package template from Kronos-Tools/npm-package-template

Author: arlac77

.gitignore

@@ -1,4 +1,14 @@
-node_modules
 coverage
+node_modules
+build
+dist
+out
+*.log
+*.dump
+.DS_Store
+.nyc_output
+.test
+.tmp
+
 npm-debug.log
-gumbo.js
+gumbo.js

.travis.yml

@@ -1,10 +1,11 @@
 language: node_js
 node_js:
-  - 6.9.1
+  - 6.9.2
 sudo: false
 branches:
   only:
     - master
+    - /^greenkeeper-.*$/
 cache:
   directories:
     - node_modules
@@ -18,8 +19,10 @@ before_script:
   - npm prune
   - npm install -g codecov
 script:
-  - npm run-script cover
+  - npm run cover
 after_script:
   - codecov
+  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
+  - npm run docs
 after_success:
   - npm run semantic-release

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, darlenya & arlac77
+Copyright (c) 2016 darlenya & arlac77
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.adoc

@@ -0,0 +1,106 @@
+[![npm](https://img.shields.io/npm/v/kronos-interceptor-object-data-processor-chunk.svg)](https://www.npmjs.com/package/kronos-interceptor-object-data-processor-chunk)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Build Status](https://secure.travis-ci.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk.png)](http://travis-ci.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![bithound](https://www.bithound.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badges/score.svg)](https://www.bithound.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![codecov.io](http://codecov.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/coverage.svg?branch=master)](http://codecov.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk?branch=master)
+[![Coverage Status](https://coveralls.io/repos/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badge.svg)](https://coveralls.io/r/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Code Climate](https://codeclimate.com/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badges/gpa.svg)](https://codeclimate.com/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badge.svg)](https://snyk.io/test/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![GitHub Issues](https://img.shields.io/github/issues/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?style=flat-square)](https://github.com/Kronos-integration/kronos-interceptor-object-data-processor-chunk/issues)
+[![Stories in Ready](https://badge.waffle.io/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?label=ready&title=Ready)](http://waffle.io/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Dependency Status](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg)](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![devDependency Status](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk/dev-status.svg)](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk#info=devDependencies)
+[![docs](http://inch-ci.org/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?branch=master)](http://inch-ci.org/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![downloads](http://img.shields.io/npm/dm/kronos-interceptor-object-data-processor-chunk.svg?style=flat-square)](https://npmjs.org/package/kronos-interceptor-object-data-processor-chunk)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+
+kronos-interceptor-object-data-processor-chunk
+=====
+Splits a line by a sparator into tokens
+
+# API Reference
+
+* <a name="createFunctions"></a>
+
+## createFunctions(chunkDefinition)
+Creates the checks for checking boolean values
+
+**Kind**: global function  
+
+| Param | Description |
+| --- | --- |
+| chunkDefinition | The chunk definition for these records. |
+
+
+* <a name="createHashFunction"></a>
+
+## createHashFunction(hashFields, hashName)
+Creates a function which generates a hash from the given content and stores the generated Hash under the given name in the record
+
+**Kind**: global function  
+
+| Param | Description |
+| --- | --- |
+| hashFields | All the field names used to create the hash |
+| hashName | The name to be used to store the hash value back in the record |
+
+
+* <a name="addError"></a>
+
+## addError(data, error)
+Adds an error to the stream data
+
+**Kind**: global function  
+
+| Param | Description |
+| --- | --- |
+| data | The current stream data |
+| error | The error to be added. |
+
+
+* <a name="createTmpHashAction"></a>
+
+## createTmpHashAction()
+Creates a hash function to compute a content hash without the multirow fields
+
+**Kind**: global function  
+
+* <a name="DataProcessorChunk+addRowActions"></a>
+
+## dataProcessorChunk.addRowActions()
+Add custom actions to the rowActions.
+These actions will be executed per row
+
+**Kind**: instance method of <code>[DataProcessorChunk](#DataProcessorChunk)</code>  
+
+* <a name="DataProcessorChunk+_transform"></a>
+
+## dataProcessorChunk._transform()
+Reads the stream data and split it into lines.
+
+**Kind**: instance method of <code>[DataProcessorChunk](#DataProcessorChunk)</code>  
+
+* <a name="DataProcessorChunk+_flush"></a>
+
+## dataProcessorChunk._flush()
+Flushes the data.
+Only needed if there are multi row fields used
+
+**Kind**: instance method of <code>[DataProcessorChunk](#DataProcessorChunk)</code>  
+
+* * *
+
+install
+=======
+
+With [npm](http://npmjs.org) do:
+
+```shell
+npm install kronos-interceptor-object-data-processor-chunk
+```
+
+license
+=======
+
+BSD-2-Clause

README.md

@@ -0,0 +1,43 @@
+[![npm](https://img.shields.io/npm/v/kronos-interceptor-object-data-processor-chunk.svg)](https://www.npmjs.com/package/kronos-interceptor-object-data-processor-chunk)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Build Status](https://secure.travis-ci.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk.png)](http://travis-ci.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![bithound](https://www.bithound.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badges/score.svg)](https://www.bithound.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![codecov.io](http://codecov.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/coverage.svg?branch=master)](http://codecov.io/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk?branch=master)
+[![Coverage Status](https://coveralls.io/repos/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badge.svg)](https://coveralls.io/r/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Code Climate](https://codeclimate.com/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badges/gpa.svg)](https://codeclimate.com/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk/badge.svg)](https://snyk.io/test/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![GitHub Issues](https://img.shields.io/github/issues/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?style=flat-square)](https://github.com/Kronos-integration/kronos-interceptor-object-data-processor-chunk/issues)
+[![Stories in Ready](https://badge.waffle.io/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?label=ready&title=Ready)](http://waffle.io/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![Dependency Status](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg)](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![devDependency Status](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk/dev-status.svg)](https://david-dm.org/Kronos-integration/kronos-interceptor-object-data-processor-chunk#info=devDependencies)
+[![docs](http://inch-ci.org/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk.svg?branch=master)](http://inch-ci.org/github/Kronos-integration/kronos-interceptor-object-data-processor-chunk)
+[![downloads](http://img.shields.io/npm/dm/kronos-interceptor-object-data-processor-chunk.svg?style=flat-square)](https://npmjs.org/package/kronos-interceptor-object-data-processor-chunk)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+
+kronos-interceptor-object-data-processor-chunk
+=====
+Splits a line by a sparator into tokens
+
+# API Reference
+{{#modules~}}
+- {{name}}
+{{/modules}}
+
+{{#functions}}* {{>docs}}
+{{/functions}}
+* * *
+
+install
+=======
+
+With [npm](http://npmjs.org) do:
+
+```shell
+npm install kronos-interceptor-object-data-processor-chunk
+```
+
+license
+=======
+
+BSD-2-Clause

doc/README.hbs

@@ -2,12 +2,14 @@
   "name": "kronos-interceptor-object-data-processor-chunk",
   "version": "0.0.0-semantic-release",
   "description": "Splits a line by a sparator into tokens.",
-  "main": "index.js",
+  "module": "src/module.js",
+  "main": "dist/module.js",
   "scripts": {
-    "cover": "./node_modules/istanbul/lib/cli.js cover --hook-run-in-context ./node_modules/mocha/bin/_mocha -- --R spec --U exports tests/*_test.js",
-    "doc": "./node_modules/.bin/jsdoc lib/*.js",
-    "test": "./node_modules/.bin/mocha tests/*_test.js",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "cover": "npm run build && node_modules/.bin/istanbul cover node_modules/.bin/_mocha -- -u exports tests/*_test.js",
+    "test": "npm run build && node_modules/.bin/mocha tests/*_test.js && markdown-doctest",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post",
+    "build": "node_modules/rollup/bin/rollup --output=dist/module.js -c -- src/module.js",
+    "docs": "jsdoc2md -l off -t doc/README.hbs -f src/*.js > README.md"
   },
   "repository": {
     "type": "git",
@@ -23,29 +25,28 @@
     "z-schema": "3.18.2"
   },
   "devDependencies": {
-    "chai": "3.5.0",
+    "chai": "^3.5.0",
     "clone-deep": "0.2.4",
-    "cz-conventional-changelog": "1.2.0",
-    "istanbul": "0.4.5",
-    "jsdoc": "3.4.2",
+    "cz-conventional-changelog": "^1.2.0",
+    "istanbul": "^0.4.5",
     "kronos-test-interceptor": "2.0.5",
-    "mocha": "3.2.0",
-    "semantic-release": "6.3.2",
-    "underscore": "1.8.3"
+    "mocha": "^3.2.0",
+    "semantic-release": "^6.3.5",
+    "underscore": "1.8.3",
+    "jsdoc-to-markdown": "^2.0.1",
+    "markdown-doctest": "^0.9.1",
+    "rollup": "^0.38.2"
   },
-  "contributors": [
-    {
-      "name": "Torsten Link",
-      "email": "[email protected]"
-    },
-    {
-      "name": "Markus Felten",
-      "email": "[email protected]"
-    }
-  ],
+  "contributors": [{
+    "name": "Torsten Link",
+    "email": "[email protected]"
+  }, {
+    "name": "Markus Felten",
+    "email": "[email protected]"
+  }],
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">=6.9.1"
+    "node": ">=6.9.2"
   },
   "keywords": [
     "stream",

index.js

@@ -0,0 +1,7 @@
+/* jslint node: true, esnext: true */
+'use strict';
+
+export default {
+  format: 'cjs',
+  plugins: []
+};