build: 3.0.0

Author: CarlosCarmona

.eslintignore

@@ -3,5 +3,6 @@ api
 node_modules
 samples
 *.md
-*.json
-LICENSE
+*.spec.js
+LICENSE
+.DS_Store

.eslintrc.json

@@ -1,6 +1,5 @@
 {
   "env": {
-    "browser": true,
     "node": true
   },
   "extends": ["plugin:prettier/recommended"],
@@ -9,7 +8,7 @@
     "global": true
   },
   "parserOptions": {
-    "ecmaVersion": 2018,
+    "ecmaVersion": 2021,
     "sourceType": "module",
     "ecmaFeatures": {
       "jsx": true
@@ -19,6 +18,16 @@
     "indent": ["error", 2, { "SwitchCase": 1 }],
     "default-case": "error",
     "linebreak-style": ["error", "unix"],
-    "semi": ["error", "always"]
+    "semi": ["error", "always"],
+    "no-console": "error",
+    "no-undef": "error",
+    "no-var": "error",
+    "no-caller": "error",
+    "no-throw-literal": "error",
+    "no-unneeded-ternary": "error",
+    "prefer-const": "error",
+    "comma-spacing": ["error", { "before": false, "after": true }],
+    "comma-style": ["error", "last"],
+    "handle-callback-err": ["error", "^(err|error)$"]
   }
 }

.prettierignore

@@ -1,12 +1,11 @@
 node_modules
-.all-contributorsrc
 .eslintignore
 .gitignore
 .prettierignore
+*.spec.js
+.npmignore
 LICENSE
 *.png
 *.txt
 TODO
-docs/functions.md
-*.md
-test.log
+.DS_Store

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Coderty S.L.
+Copyright (c) 2021 Runnerty Tech S.L.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,22 +2,42 @@
   <a href="http://runnerty.io">
     <img height="257" src="https://runnerty.io/assets/header/logo-stroked.png">
   </a>
-  <p align="center">A new way for processes managing</p>
+  <p align="center">Smart Processes Management</p>
 </p>
 
-[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url] 
+[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]
 <a href="#badge">
-  <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
+<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
 </a>
 
 # Executor for [Runnerty]: JSON2CSV
 
 ### Installation:
+
+Through NPM
+
 ```bash
 npm i @runnerty/executor-json2csv
 ```
 
+You can also add modules to your project with [runnerty-cli]
+
+```bash
+npx runnerty-cli add @runnerty/executor-json2csv
+```
+
+This command installs the module in your project, adds example configuration in your `config.json` and creates an example plan of use.
+
+If you have installed [runnerty-cli] globally you can include the module with this command:
+
+```bash
+rty add @runnerty/executor-json2csv
+```
+
 ### Configuration sample:
+
+Add in [config.json]:
+
 ```json
 {
   "id": "json2csv_default",
@@ -27,7 +47,10 @@ npm i @runnerty/executor-json2csv
 
 ### Plan sample:
 
+Add in [plan.json]:
+
 #### JSON Example
+
 ```json
 [
   {
@@ -62,32 +85,37 @@ npm i @runnerty/executor-json2csv
 ```json
 {
   "id": "json2csv_default",
-  "inputPath":"./planets.json",
+  "inputPath": "./planets.json",
   "outputPath": "./planets.csv"
 }
 ```
+
 ##### CSV Output
+
 ```
 "planet","radius","satellites"
 "Earth",6371,"[{""name"":""moon"",""radius"":1737}]"
 "Mars",3389,"[{""name"":""phobos"",""radius"":11267},{""name"":""deimos"",""radius"":6.2}]"
 ```
+
 #### Example 2:
+
 ```json
 {
   "id": "json2csv_default",
-  "inputPath":"./planets.json",
+  "inputPath": "./planets.json",
   "outputPath": "./planets.csv",
-  "options":{
+  "options": {
     "fields": ["planet", "radius", "satellites.name", "satellites.radius"]
   },
-  "transforms":{
+  "transforms": {
     "unwind": { "paths": ["satellites"] }
   }
 }
 ```
 
 ##### CSV Ouput
+
 ```
 "planet","radius","satellites.name","satellites.radius"
 "Earth",6371,"moon",1737
@@ -100,10 +128,10 @@ npm i @runnerty/executor-json2csv
 ```json
 {
   "id": "json2csv_default",
-  "inputPath": "./input.json", 
+  "inputPath": "./input.json",
   "input": "@GV(MY_JSON)",
   "outputPath": "./output.csv",
-  "options":{
+  "options": {
     "fields": ["field1", "field2", "field3"],
     "defaultValue": "NULL",
     "header": true,
@@ -114,45 +142,54 @@ npm i @runnerty/executor-json2csv
     "includeEmptyRows": true,
     "withBOM": true
   },
-  "transforms":{
-    "unwind":{ "paths": ["items", "items.items"], "blankOut": true },
-    "flatten":{ "objects": true, "arrays": true, "separator": "_" }
+  "transforms": {
+    "unwind": { "paths": ["items", "items.items"], "blankOut": true },
+    "flatten": { "objects": true, "arrays": true, "separator": "_" }
   }
 }
 ```
+
 ### Params
+
 #### Options
-```
-  fields            List of fields to process. Defaults to field auto-detection.
-  defaultValue      Default value to use for missing fields.
-  quote             Character(s) to use as quote mark. Defaults to '"'.
-  escapedQuote      Character(s) to use as a escaped quote. Defaults to a double `quote`, '""'.
-  delimiter         Character(s) to use as delimiter. Defaults to ','. (default: ",")
-  eol               Character(s) to use as End-of-Line for separating rows. Defaults to '\n'. (default: "\n")
-  excelStrings      Wraps string data to force Excel to interpret it as string even if it contains a number.
-  header            Boolean to Enable/Disable the column name header. (Enabled by defaults)
-  includeEmptyRows  Boolean to Includes empty rows in the resulting CSV output.
-  withBOM           Boolean to Includes BOM character at the beginning of the CSV.
-```
+
+| Option           | Description                                                                               |
+| ---------------- | ----------------------------------------------------------------------------------------- |
+| fields           | List of fields to process. Defaults to field auto-detection.                              |
+| defaultValue     | Default value to use for missing fields.                                                  |
+| quote            | Character(s) to use as quote mark. Defaults to '"'.                                       |
+| delimiter        | Character(s) to use as delimiter. Defaults to ','. (default: ",")                         |
+| escapedQuote     | Character(s) to use as a escaped quote. Defaults to a double `quote`, '""'.               |
+| eol              | Character(s) to use as End-of-Line for separating rows. Defaults to '\n'. (default: "\n") |
+| excelStrings     | Wraps string data to force Excel to interpret it as string even if it contains a number.  |
+| header           | Boolean to Enable/Disable the column name header. (Enabled by defaults)                   |
+| includeEmptyRows | Boolean to Includes empty rows in the resulting CSV output.                               |
+| withBOM          | Boolean to Includes BOM character at the beginning of the CSV.                            |
+
 #### Transforms
-```
-  unwind            Creates multiple rows from a single JSON document similar to MongoDB unwind.
-    paths           Unwind fields path.
-    blankOut        When unwinding, blank out instead of repeating data. Defaults to false. (default: false)
-  flatten           Nested javascript objects into a single level object.
-    object          Flatten nested objects. Defaults to false. (default: false)
-    arrays          Flatten nested arrays. Defaults to false. (default: false)
-    separator       Flattened keys separator. Defaults to '.'. (default: ".")
-```
+
+| Option      | Description                                                                              |
+| ----------- | ---------------------------------------------------------------------------------------- |
+| unwind      | Creates multiple rows from a single JSON document similar to MongoDB unwind.             |
+| - paths     | Unwind fields path.                                                                      |
+| - blankOut  | When unwinding, blank out instead of repeating data. Defaults to false. (default: false) |
+| flatten     | Nested javascript objects into a single level object.                                    |
+| - object    | Flatten nested objects. Defaults to false. (default: false)                              |
+| - arrays    | Flatten nested arrays. Defaults to false. (default: false)                               |
+| - separator | Flattened keys separator. Defaults to '.'. (default: ".")                                |
 
 ### More information:
-This executor is a wrapper of the module json2csv (zemirco), for more information consult the website of the [json2csv].
 
+This executor is a wrapper of the module json2csv (zemirco), for more information consult the website of the [json2csv].
 
-[Runnerty]: http://www.runnerty.io
+[runnerty]: http://www.runnerty.io
 [downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-json2csv.svg
 [npm-url]: https://www.npmjs.com/package/@runnerty/executor-json2csv
 [npm-image]: https://img.shields.io/npm/v/@runnerty/executor-json2csv.svg
 [david-badge]: https://david-dm.org/runnerty/executor-json2csv.svg
 [david-badge-url]: https://david-dm.org/runnerty/executor-json2csv
+[config.json]: http://docs.runnerty.io/config/
+[plan.json]: http://docs.runnerty.io/plan/
+[ejs]: https://ejs.co
+[runnerty-cli]: https://www.npmjs.com/package/runnerty-cli
 [json2csv]: https://github.com/zemirco/json2csv

index.js

@@ -6,9 +6,9 @@ const {
   transforms: { unwind, flatten }
 } = require('json2csv');
 
-const Execution = global.ExecutionClass;
+const Executor = require('@runnerty/module-core').Executor;
 
-class json2csvExecutor extends Execution {
+class json2csvExecutor extends Executor {
   constructor(process) {
     super(process);
     this.endOptions = { end: 'end' };
@@ -48,7 +48,7 @@ class json2csvExecutor extends Execution {
       this.endOptions.end = 'error';
       this.endOptions.messageLog = err;
       this.endOptions.err_output = err;
-      this.end(endOptions);
+      this.end(this.endOptions);
     }
   }
 }