Node Dev Guideline

This page is for discussing about how to make Node Dev Guideline.

You can check the original contents at HERE.

• Introduction
  • Purpose of node development and correspondence of this guideline
  • Terms
• Designing
  • Policy for designing original nodes
• Coding
  • Official documentation of Node-RED
  • Procedure of development
  • Describing code
• Style
  • Official documentation of Node-RED
  • Naming rule
  • Design
• Improving quality
  • Test
  • How to run the test
  • Static analysis
  • Manual test with operatig Node-RED
  • Automated test with test code
  • Original test items of node development
• Security and anonymity
  • How to write credential information
  • How to code obfuscation
• Appendix
  • Tips and Notes
  • Creating node definitions for Node-RED (node generator)

Introduction

There is possiblity that standard nodes of Node-RED can not deal with every use case. Node-RED allows users to develop their own original nodes. This guideline explains guideline and precautions for developing nodes.

Purpose of node development and correspondence of this guideline

Reuse and share general-purpose processing logic

How to use the system by Node-RED

Terms

Designing

This chapter explain the policy of designing nodes for developers who make original node.

Policy for designing original nodes

Designing related group of nodes

Node definition

Node setting

Designing node functions

Design of non-functional requirement

Coding

Official documentation of Node-RED

Firstly, there are documents about how to create a new node in the Node-RED official site. Therefore, the page should be given preference.

Procedure of development

1. Designing interface
2. Writing code
3. Test
4. Multilingualization
5. Packaging

Writing a code

Packaging

HTML code

JavaScript code

node-generator

Creating a simple node or template of node could be easy for using node-generator.

Style

The appearance of the node is explained in Node appearance.

Official documentation of Node-RED

Naming rule

Design

Improving quality

Test

How to run the test

Static analysis

Manual test with operatig Node-RED

Automated test with test code

Original test items of node development

Security and anonymity

How to write credential information

How to code obfuscation

Appendix

Tips and Notes

Creating node definitions for Node-RED (node generator)

Flow for developing an original node from a Swagger file

1. Generate an original node by using a node generator command.

Module name

Node name

Version

Keyword

Category

2. Add a node description, test cases, etc.

Information about the nodes displayed in the information tab, and README

README

Test case

Support for multiple languages