pochade-node-red 0.1.4 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/template/AGENTS.md +26 -3
package/package.json
CHANGED
package/template/AGENTS.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
# Node-RED Plugin Implementation Guide for AI Agents
|
|
2
2
|
|
|
3
3
|
This document provides a comprehensive guide for Large Language Models (LLMs) on how to implement Node-RED plugins (nodes).
|
|
4
|
+
## Priorities
|
|
4
5
|
|
|
6
|
+
Every node should have extensive documentation describing its functionality.
|
|
5
7
|
## Project Structure
|
|
6
8
|
|
|
7
9
|
A Node-RED node module typically has the following structure:
|
|
@@ -135,6 +137,27 @@ The HTML file defines the node's appearance in the Node-RED editor, its configur
|
|
|
135
137
|
|
|
136
138
|
## Development Cycle
|
|
137
139
|
|
|
138
|
-
1. **Install**: `npm install` in your node directory.
|
|
139
|
-
2. **Link**: `npm
|
|
140
|
-
3. **Restart**:
|
|
140
|
+
1. **Install**: `npm run install-plugin` in your node directory.
|
|
141
|
+
2. **Link**: `npm run watch` to make it available to Node-RED.
|
|
142
|
+
3. **Restart**: the watch.sh script automatically restarts node-red when there is a change in thenode
|
|
143
|
+
|
|
144
|
+
## Scripts
|
|
145
|
+
|
|
146
|
+
This project has two npm commands that are helpful for development:
|
|
147
|
+
|
|
148
|
+
```sh
|
|
149
|
+
npm run install-plugin
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
installs th enode-red plugin in the user's .node-red directory
|
|
153
|
+
|
|
154
|
+
```sh
|
|
155
|
+
npm run watch
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
triggers the `watch.sh` script, watches for changes and cycles the node-red server on and off when there are changes.
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
## Documentation
|
|
162
|
+
|
|
163
|
+
Please make sure to extensively document the plugin, including comments in the javascript and also in the plugin's HTML component. Please update documentation at the end of every change. Please be sure to detail all inputs, outputs and messages. Please use examples of what the input should look like and what the output will look like.
|