v5 changes - see changelog

Author: TotallyInformation

CHANGELOG.md

@@ -1,14 +1,32 @@
 # Change Log
 
-All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+## 5.0.0
 
-alternate-node-red-installer adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+[Code commits since last release](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v3.0.2...v5.0.0).
 
-## [Unreleased](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v2.0.2...master)
+### Breaking changes
 
-None
+Node.js v20 is now the minimum supported version.
 
-## [3.0.2](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v3.0.0...v4.0.0)
+The npm package name has changed from alternate-node-red-installer to @totallyinformation/nrinstall to allow easier running from `npx`. The old published package has now be deprecated.
+
+### Other changes
+
+* **MAJOR**: You can now run the installer directly with npx without installing globally: `npx @totallyinformation/nrinstall -f <root folder name>`.
+* **MAJOR**: The command line command is now `nrinstall` (if you install globally) or `npx @totallyinformation/nrinstall` (if you don't install globally).
+* Dependencies updated.
+* **MAJOR**: Changed name from alternate-node-red-installer to @totallyinformation/nrinstall to allow easier running from `npx`.
+* **MAJOR**: Updated the template example-settings.js file to be current with at least v4.1.8 of Node-RED.
+* Changed to ESM modules.
+* Updated the dependencies to the latest versions.
+
+## [4.0.0](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v3.0.2...v4.0.0)
+
+**Node.js v18** is now the minimum version supported.
+
+Dependencies updated as far as possible. Some dependencies are ESM only in their latest versions which will require significant rework.
+
+## [3.0.2](https://github.com/TotallyInformation/alternate-node-red-installer/compare/v3.0.0...v3.0.2)
 
 **WARNING**: Although this has the same major version number as the previous release, it is a breaking release. This is to allow the major versions to be aligned to Node-RED itself.
 
@@ -17,12 +35,12 @@ None
 * Minimum version of Node.js supported is now v14 in alignment with Node-RED v3.
 * Update to node-red v3.0.2 as minimum - the latest version of node-red will always be installed when `nrinstall` is run.
 
-## Fixed
+### Fixed
 
 * Changes to the systemd service file - removing spurious quote characters.
 * Changes to the `data/envfile.ini` file - removing spurious quote characters.
 
-## Changed
+### Changed
 
 * Update `example-settings.js` to a newer version - aligned to node-red v3.0.2 with enhancements & additional help
 * Removed `.eslintrc.js`/`.eslintrc.json` - not required

README.md

@@ -1,33 +1,40 @@
-# alternate-node-red-installer
-An alternative installer for Node-RED. Avoids global installs, no admin rights required for new Node-RED instances.
+# @totallyinformation/nrinstall
+
+An alternative installer for Node-RED. Avoids global installs, no admin rights required for new Node-RED instances. Local install allows full control and even multiple different versions of Node-RED running in parallel. Works on any platform supported by Node.JS. It also includes an enhanced settings.js example file and some additional utility scripts.
 
 > This solution is particularly suited for development environments and anywhere that you don't want to install global NodeJS scripts. Also when you need to have different versions of Node-RED running in parallel.
 
+> [!NOTE]
+> That the npm package name for this repository has changed from [`alternate-node-red-installer`](https://www.npmjs.com/package/alternate-node-red-installer) to [`@totallyinformation/nrinstall`](https://www.npmjs.com/package/@totallyinformation/nrinstall) to allow easier running from `npx`. The old published package has now be deprecated.
+
 ## Getting Started
 
 1. Make sure that you have Node.JS correctly installed. Check that you can run it manually from the command line with `node --version && npm --version`.
-2. Make sure that Node.js is at least at version 8.16.0 (LTS) or above.
-3. For ease of use, install this package globally with `npm install -g alternate-node-red-installer`. You may need to use a command line with elevated rights (`sudo` on Linux).
-
-Now, from any command line, you should be able to run the following:
-
-```
-alternate-node-red-installer -f <root folder name>
-```
+2. Make sure that Node.js is at least at version 20 (LTS) or above.
+3. Run the installer directly with npx:
+   
+   ```
+   npx @totallyinformation/nrinstall -f <root folder name>
+   ```
+   
+    Where <root folder name>` is a relative or absolute folder path that you want to be the root of your new Node-RED installation.
 
-Where <root folder name>` is a relative or absolute folder path that you want to be the root of your new Node-RED installation.
+4. Optional: install globally with `npm install -g @totallyinformation/nrinstall`. You may need to use a command line with elevated rights (`sudo` on Linux). Then run as:
 
-Instead of the long-winded executable name, you can also use `nrinstall`
+   ```
+   nrinstall -f <root folder name>
+   ```
 
 Example (for Mac, Linux or Windows PowerShell):
 
 ```
+mkdir ~/nrtest
 nrinstall -f ~/nrtest
 ```
 
 Once the install has completed (it may take some time), you can navigate to the data sub-folder and work with Node-RED as normal (e.g. `cd ~/nrtest/data`).
 
-You may wish to adjust the `settings.js` file and install any required Nodes at this point.
+You may wish to adjust the `./data/settings.js` file. See the `./data/example-settings.js` file for an example enhanced settings file.
 
 Run `npm run` to see the run commands available for your convenience. They are detailed in the README.md file installed in the data subfolder.
 
@@ -37,18 +44,20 @@ These instructions should work on any platform supported by Node.JS.
 
 <!-- TOC -->
 
-* [alternate-node-red-installer](#alternate-node-red-installer)
-  * [Getting Started](#getting-started)
-  * [Table of Contents](#table-of-contents)
-  * [Introduction](#introduction)
-  * [The issue](#the-issue)
-  * [The solution](#the-solution)
-  * [The advamtages](#the-advamtages)
-  * [Starting Node-RED](#starting-node-red)
-  * [Updating Node-RED and installed nodes](#updating-node-red-and-installed-nodes)
-  * [Changes](#changes)
-  * [To Do](#to-do)
-  * [Prerequisites](#prerequisites)
+- [@totallyinformation/nrinstall](#totallyinformationnrinstall)
+  - [Getting Started](#getting-started)
+  - [Table of Contents](#table-of-contents)
+  - [Introduction](#introduction)
+  - [The issue](#the-issue)
+  - [The solution](#the-solution)
+  - [The advamtages](#the-advamtages)
+  - [Starting Node-RED](#starting-node-red)
+  - [Updating Node-RED and installed nodes](#updating-node-red-and-installed-nodes)
+  - [Changes](#changes)
+  - [To Do](#to-do)
+  - [Prerequisites](#prerequisites)
+  - [Sponsorship](#sponsorship)
+  - [Other links](#other-links)
 
 <!-- /TOC -->
 
@@ -142,4 +151,40 @@ Please see the [TODO](./TODO.md) file.
 
 ## Prerequisites
 
-* NodeJS. v10 is the minimum supported version.
+* NodeJS. v20 is the minimum supported version.
+
+## Sponsorship
+
+If you find value in my work, please consider a small sponsorship or other contribution to help me continue to provide free, open source software.
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A3PPMRJ)
+
+[GitHub Sponsorship](https://github.com/sponsors/TotallyInformation), 
+[PayPal Sponsorship](https://paypal.me/TotallyInformation),
+[Patreon Sponsorship](https://patreon.com/TotallyInformation?utm_medium=github&utm_source=join_link&utm_campaign=creatorshare_creator&utm_content=copyLink)
+
+## Other links
+
+Here are some other links to my work that you may find interesting:
+
+- ![uib](https://github.com/TotallyInformation/node-red-contrib-uibuilder/raw/main/front-end/images/node-blue.ico) [UIBUILDER for Node-RED](https://github.com/TotallyInformation/node-red-contrib-uibuilder)
+  - ❓ [Ideas, questions & general help](https://discourse.nodered.org/tag/node-red-contrib-uibuilder) - Ask your question on the Node-RED forum using the node-red-contrib-uibuilder tag.
+  - 📁 [Documentation](https://totallyinformation.github.io/node-red-contrib-uibuilder) - Go to the latest documentation.
+  - 🧑‍💻 [Flows](https://flows.nodered.org/search?term=uibuilder) - Example flows, nodes and collections related to UIBUILDER.
+  - ℹ️ [WIKI](https://github.com/TotallyInformation/node-red-contrib-uibuilder/wiki) - More documentation and examples.
+  - 📂 [Example Svelte External Template](https://github.com/TotallyInformation/uib-template-svelte-simple) - In case you want to build your own svelte app.
+  - 📂 [Example Simple External Template](https://github.com/TotallyInformation/uib-template-test) - In case you want to build your own external template.
+  - 📊 [uPlot UIBUILDER extension](https://github.com/TotallyInformation/nr-uibuilder-uplot) - Useful charts but also demonstrates how to build your own extension.
+
+- 🧪 [Web Components Library](https://github.com/TotallyInformation/web-components) - A growing library of useful HTML Web Components. Useable with or without Node-RED & UIBUILDER. Some having specific enhancements for Node-RED but will still work well stand-alone. These now have their own dedicated documentation, demo and test website at https://wc.totallyinformation.net. Please check them out there.
+
+- 🔨 [ui library module used by UIBUILDER](https://github.com/TotallyInformation/ui.js) - Can be used stand-alone for turning UI standard config JSON into HTML.
+
+- 🕜 [node-red-contrib-moment](https://github.com/TotallyInformation/node-red-contrib-moment) - Nodes to make use of the MomentJS date/time handling library in Node-RED.
+
+- 🧪 [Testbed for Node-RED custom nodes](https://github.com/TotallyInformation/Node-RED-Testbed) - Embodying more up-to-date thinking than the test nodes, a blank playground.
+- 🧪 [Test Nodes for Node-RED](https://github.com/TotallyInformation/uib-template-test) - Some test nodes for Node-RED that help you understand how everything works.
+
+- 🚤 [HotNipi Gauge Web Component](https://github.com/TotallyInformation/gauge-hotnipi) - A really nice looking gauge component. Works with Node-RED, UIBUILDER, or stand-alone.
+
+- 🧪 [Array Grouper](https://github.com/TotallyInformation/groupit) - Stand-alone function to reshape an array of objects.

TODO.md

@@ -1,4 +1,4 @@
-# Alternate Node-RED Installer: To Do
+# Alternate Node-RED Installer: To Do (Maybe)
 
 https://discourse.nodered.org/t/advice-setting-up-node-red-for-a-class/16650
 

bin/install-node-red.js bin/install-node-red.mjsbin/install-node-red.js renamed to bin/install-node-red.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-'use strict'
 // @ts-nocheck
 
+
 /**
  * Install the Node-RED alternate installation template
  *
@@ -22,32 +22,38 @@
  * -- Job Done! --
  */
 
-const chalk = require('chalk')
-const boxen = require('boxen')
-const yargs = require('yargs')
-const fs = require('fs-extra')
-const path = require('path')
-//const exec = require('child_process').exec
-const util = require('util');
-const exec = util.promisify(require('child_process').exec)
-const tilib = require('../tilib')
-const ora = require('ora') // console spinner
-const replace = require('replace-in-file')
+import chalk from 'chalk'
+import chalkTemplate from 'chalk-template'
+import boxen from 'boxen'
+import yargs from 'yargs/yargs'
+import { hideBin } from 'yargs/helpers'
+import fs from 'fs-extra'
+import path from 'node:path'
+import util from 'node:util'
+import { exec as execCb } from 'node:child_process'
+import { fileURLToPath } from 'node:url'
+import tilib from '../tilib.js'
+import ora from 'ora' // console spinner
+import { replaceInFile } from 'replace-in-file'
 
 /** Parameters from command line
  * @type {Object} options
  * @property {string} [folder] - Root folder that will contain the Node-RED installation.
  * @property {boolean} [no-color] - Turn off ANSI color output.
  */
-const options = yargs
-    .usage('Usage: -f <root-folder-name>')
+const options = yargs(hideBin(process.argv))
+    .usage('Usage: npx @totallyinformation/nrinstall -f <root-folder-name>\n  or if installed globally: nrinstall -f <root-folder-name>')
     .option('f', {
         alias: 'folder', describe: 'Root folder, Node-RED will be installed here', type: 'string', demandOption: true
     })
     .option('no-color', {
         describe: 'Turn off ANSI color output', type: 'boolean', demandOption: false
     })
-    .argv
+    .parse()
+
+const exec = util.promisify(execCb)
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
 const boxenOptions = {
     padding: 1,
@@ -69,7 +75,7 @@ spinner.color = 'yellow'
 const folder = path.resolve(options.folder)
 const templatesFolder = path.join(__dirname, '..', 'templates')
 
-var msg = chalk`{cyan.bold.underline Alternate Installer for Node-RED}
+var msg = chalkTemplate`{cyan.bold.underline Alternate Installer for Node-RED}
 
 {white Root Folder . . :} {green.bold.underline ${folder}}
 {white Templates Folder:} {green.bold.underline ${templatesFolder}}
@@ -84,11 +90,11 @@ async function installer(pkgFolder, folder='') {
     /** npm commands behave dreadfully. Many will error out even though they actually succeed. */
     console.log({folder})
     try{
-        const { stdout, stderr } = await exec('npm install --production --unsafe-perm', {'cwd': folder})
+        const { stdout, stderr } = await exec('npm install --omit=dev', {'cwd': folder})
         out.stdout = stdout
         out.stderr = stderr
     } catch(err) {
-        //msg += chalk`\n{red CMD ERROR}\n`
+        //msg += chalkTemplate`\n{red CMD ERROR}\n`
         //console.log(err)
         out.stdout = err.stdout
         out.stderr = err.stderr
@@ -97,9 +103,9 @@ async function installer(pkgFolder, folder='') {
             pkgFolder = tilib.findPackage('node-red', folder)
             if ( pkgFolder !== null ) {
                 const nrPkg = tilib.readPackageJson(pkgFolder) || {'version':'N/A'}
-                msg += chalk`{green Node-RED v{bold ${nrPkg.version}} successfully installed}\n`
+                msg += chalkTemplate`{green Node-RED v{bold ${nrPkg.version}} successfully installed}\n`
             } else {
-                msg += chalk`{red.bold Node-RED failed to install}\n`
+                msg += chalkTemplate`{red.bold Node-RED failed to install}\n`
             }
         }
     }
@@ -119,9 +125,9 @@ async function copyDataTemplate(pkgFolder, folder) {
                 'errorOnExist': true,
             }
         )
-        msg += chalk`{green Copied template data (userDir) folder to ${fldrData}}\n`
+        msg += chalkTemplate`{green Copied template data (userDir) folder to ${fldrData}}\n`
     } catch(err) {
-        msg += chalk`{red.bold Data (userDir) folder already exists or cannot be created - NOT COPIED - Please use a folder name that does not exist. ${fldrData}}\n`
+        msg += chalkTemplate`{red.bold Data (userDir) folder already exists or cannot be created - NOT COPIED - Please use a folder name that does not exist. ${fldrData}}\n`
         return
     }
 
@@ -131,10 +137,10 @@ async function copyDataTemplate(pkgFolder, folder) {
         to: folder,
     }
     try {
-        const results = await replace(fileReplaceOpts)
+        const results = await replaceInFile(fileReplaceOpts)
         console.log(`Replaced "<root-folder-name>" with ${folder}`, results)
     } catch (error) {
-        console.error(`FAILED to Replace "<root-folder-name>" with ${folder} - change manually before use`, error)
+        console.error(`FAILED to Replace "<root-folder-name>" with ${folder} - change manually before use. `, error)
     }
 }
 
@@ -149,9 +155,9 @@ async function copyMasterTemplate(pkgFolder, folder) {
                 'errorOnExist': true,
             }
         )
-        msg += chalk`{green Copied template master folder from templates to root folder: ${folder}}\n`
+        msg += chalkTemplate`{green Copied template master folder from templates to root folder: ${folder}}\n`
     } catch(err) {
-        msg += chalk`{red.bold Root folder already exists or cannot be created - NOT COPIED - Please use a folder name that does not exist. ${folder}}\n`
+        msg += chalkTemplate`{red.bold Root folder already exists or cannot be created - NOT COPIED - Please use a folder name that does not exist. ${folder}}\n`
         return
     }
 
@@ -161,10 +167,10 @@ async function copyMasterTemplate(pkgFolder, folder) {
         to: folder,
     }
     try {
-        const results = await replace(fileReplaceOpts)
+        const results = await replaceInFile(fileReplaceOpts)
         console.log(`Replaced "<root-folder-name>" with ${folder}`, results)
     } catch (error) {
-        console.error(`FAILED to Replace "<root-folder-name>" with ${folder} - change manually before use`, error)
+        console.error(`FAILED to Replace "<root-folder-name>" with ${folder} - change manually before use. `, error)
     }
 }
 
@@ -178,7 +184,7 @@ async function copySettings(pkgFolder, folder) {
 
     if (pkgFolder === null) pkgFolder = tilib.findPackage('node-red', folder)
     if ( pkgFolder !== null ) {
-        //msg += chalk`{blue \nNode-RED package folder found: ${pkgFolder}\n}`
+        //msg += chalkTemplate`{blue \nNode-RED package folder found: ${pkgFolder}\n}`
 
         try {
             await fs.copy(
@@ -189,13 +195,13 @@ async function copySettings(pkgFolder, folder) {
                     'errorOnExist': true,
                 }
             )
-            msg += chalk`{green Copied master settings.js}\n`
-            msg += 'Check `example-settings.js` if you want an enhanced settings file.\n'
+            msg += chalkTemplate`{green Copied template settings.js to data folder: ${userDirSettings}}\n`
+            msg += 'Check `data/example-settings.js` if you want an enhanced settings file.\n'
         } catch(err) {
-            msg += chalk`{red.bold Master settings.js already exists - NOT COPIED}\n`
+            msg += chalkTemplate`{red.bold Master \`data/settings.js\` already exists - template NOT COPIED}\n`
         }
     } else {
-        msg += chalk`\n{bgRed.bold.yellow  Node-RED package folder not found }\n`
+        msg += chalkTemplate`\n{bgRed.bold.yellow  Node-RED package folder not found }\n`
     }
 
 }
@@ -228,9 +234,9 @@ main(pkgFolder, folder)
     .then( () => {
         spinner.stop()
 
-        console.log(chalk`{cyan.bold NPM COMMAND OUTPUT}`)
+        console.log(chalkTemplate`{cyan.bold NPM COMMAND OUTPUT}`)
         console.log(out.stdout)
-        console.log(chalk`{magenta.bold NPM COMMAND ERROR OUTPUT}`)
+        console.log(chalkTemplate`{magenta.bold NPM COMMAND ERROR OUTPUT}`)
         console.log(out.stderr)
     })
     .catch( (err) => { // belt & braces