node-red-contrib-nodegen/README.md

make function node for node-red

nodegen NodeRED Node
=====================

Installing with npm
-------

`npm install node-red-contrib-nodegen`

Adding nodes to the palette
-------
Using the Editor
You can install nodes directly within the editor by selecting the Manage Palette option from the main menu to open the Palette Manager.

The ‘Nodes’ tab lists all of the modules you have installed. It shows which you are using and whether updates are available for any of them.

The ‘Install’ tab lets you search the catalogue of available node modules and install them.


- inspired by nodegen
- make function node for node-red

Example
------
https://flows.nodered.org/add/node

### Parameters

- prefix : Prefix of npm module (default: "node-red-contrib-")
- fname : Node name (default: name defined in source)
- module : Module name (default: "node-red-contrib-<node name>")
- version : Node version (format: "number.number.number" like "4.5.1")
- keywords : Additional keywords (format: comma separated string, default: "node-red-nodegen")
- category : Node category (default: "function")
- icon : PNG file for node appearance (image size should be 10x20)
- color : Color for node appearance (format: color hexadecimal numbers like "A6BBCF")
- dst : Destination folder to be created (default: node-red execution location)
- template : Template folder location required to create (default: /home/server/.node-red/node_modules/node-red-contrib-nodegen/templates/function
- lang : Language negotiation information when retrieve a Thing Description
- content : function contents 

```javascript
msg = {};
msg.prefix = 'node-red-contrib-';
msg.fname = 'lower-case';
msg.module = '';
msg.version = '1.0.0';
msg.keywords = 'lower-case';
msg.category = '';
msg.icon = '';
msg.color = '';
// if OS is linux, MAC
msg.dst = '$HOME/.node-red/node_modules/';
// if OS is Window
msg.dst = 'C:/Users/gagag/.node-red/node_modules/';
msg.lang = '';
msg.content = '// name: lower-case\n';
msg.content += '// outputs: 1\n';
msg.content += 'msg.payload = msg.payload.toLowerCase();\n';
msg.content += 'return msg;\n';

return msg;
```

### Results
```text
Success: node-red-contrib-test-module
```

Sample Flow
------
```json
[
  {
    "id": "6d3e3068.04443",
    "type": "inject",
    "z": "c49414ec.9c4508",
    "name": "",
    "props": [
      {
        "p": "payload"
      },
      {
        "p": "topic",
        "vt": "str"
      }
    ],
    "repeat": "",
    "crontab": "",
    "once": false,
    "onceDelay": 0.1,
    "topic": "",
    "payload": "",
    "payloadType": "date",
    "x": 130,
    "y": 60,
    "wires": [
      [
        "fa546363.caa9f"
      ]
    ]
  },
  {
    "id": "fa546363.caa9f",
    "type": "function",
    "z": "c49414ec.9c4508",
    "name": "",
    "func": "msg = {};\nmsg.prefix = 'node-red-contrib-';\nmsg.fname = 'lower-case';\nmsg.module = '';\nmsg.version = '1.0.0';\nmsg.keywords = 'lower-case';\nmsg.category = '';\nmsg.icon = '';\nmsg.color = '';\n// if OS is linux, MAC\nmsg.dst = '/home/server/.node-red/node_modules/';\n// if OS is Window\n// msg.dst = 'C:/Users/user/.node-red/node_modules/';\nmsg.lang = '';\nmsg.content = '// name: lower-case\\n';\nmsg.content += '// outputs: 1\\n';\nmsg.content += 'msg.payload = msg.payload.toLowerCase();\\n';\nmsg.content += 'return msg;\\n';\n\nreturn msg;",
    "outputs": 1,
    "noerr": 0,
    "initialize": "",
    "finalize": "",
    "x": 310,
    "y": 60,
    "wires": [
      [
        "268809eb.cbceb6"
      ]
    ]
  },
  {
    "id": "fa48932.8d7ee7",
    "type": "debug",
    "z": "c49414ec.9c4508",
    "name": "",
    "active": true,
    "tosidebar": true,
    "console": false,
    "tostatus": false,
    "complete": "true",
    "targetType": "full",
    "statusVal": "",
    "statusType": "auto",
    "x": 640,
    "y": 60,
    "wires": []
  },
  {
    "id": "268809eb.cbceb6",
    "type": "nodegen",
    "z": "c49414ec.9c4508",
    "prefix": "",
    "fname": "",
    "module": "",
    "version": "",
    "keywords": "",
    "category": "",
    "icon": "",
    "color": "",
    "dst": "",
    "lang": "",
    "name": "nodegen",
    "x": 490,
    "y": 60,
    "wires": [
      [
        "fa48932.8d7ee7"
      ]
    ]
  }
]

```