npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-red-contrib-multi-flows-storage

v0.3.1

Published

A Node-RED storage plugin that organize flows and subflows in folders as YAML or JSON for readability

Downloads

41

Readme

node-red-contrib-multi-flows-storage

A Node-RED storage plugin that organize flows and subflows in folders as YAML or JSON for readability

The problem

Node-RED stores flow files as JSON documents. While JSON is lightweight and universal, it is not the most human readable format. Node-RED stores various forms of code in function, comment and template nodes such as JavaScript, HTML, CSS, Markdown, etc. These code blocks are reprensented as a single line in a JSON structure which makes it hard to debug when reading the flow file and it makes diffs very difficult to read.

The solution

This storage module reads and saves flows and subflows as YAML or JSON files and organize they in multiple directories. The main advantage is readability and less merge conflicts since every tab/subflow is saved as individual file. Also, if you use the same Node-RED configuration/repository for a parametrized flowFile path in Node-RED settings this module organize each one in its own directory structure.

Installation

npm install node-red-contrib-multi-flows-storage

You will also need to modify your settings.js file and add the following:

storageModule: require("node-red-contrib-multi-flows-storage");

JSON or YAML

By default all the flows are saved in .yaml to change this behavior is possible to create a options file in yours Node-RED user dir.

  • Create a file named: multiflows-options.json
{
  "fileFormat": "json" | "yaml"
}

Example Directory Structure

Here is a comparation of directories structure.

Imagine you have a multi instance Node-RED that might use a different flow file parametrized on Node environment.

  • Instance 1: flows-app.json
  • Instance 2: flows-app2.json
export default {
    flowFile: process.env.NODERED_FLOW_FILE || 'flows-app.json'
}

Default repository structure:

--src
    --nodered
    flows-app.json
    flows-app2.json

Your new repository structure will be like this.

--src
    --nodered
        --flows-app
            --flows
                <<tab name>>.yaml    
                my tab name.yaml
            --subflows
                <<subflow name>>.yaml
                my other subflow.yaml
            config-nodes.yaml
        --flows-app2
            --flows
                <<tab name>>.yaml    
                my tab name.yaml
            --subflows
                <<subflow name>>.yaml
                my other subflow.yaml
            config-nodes.yaml