@bonsae/create-nrg 0.5.0 → 0.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Allan Oricil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -5,6 +5,8 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/@bonsae/create-nrg"><img src="https://img.shields.io/npm/v/@bonsae/create-nrg.svg" alt="npm package"></a>
   <a href="https://github.com/bonsaedev/create-nrg/actions/workflows/ci.yaml"><img src="https://github.com/bonsaedev/create-nrg/actions/workflows/ci.yaml/badge.svg?branch=main" alt="build status"></a>
+  <a href="https://codecov.io/gh/bonsaedev/create-nrg"><img src="https://codecov.io/gh/bonsaedev/create-nrg/graph/badge.svg" alt="codecov"/></a>
+  <a href="https://socket.dev/npm/package/@bonsae/create-nrg"><img src="https://badge.socket.dev/npm/package/@bonsae/create-nrg" alt="Socket Badge"></a>
 </p>
 
 # create-nrg
@@ -42,8 +44,8 @@ my-project/
 ├── .husky/
 ├── .gitignore
 ├── .prettierrc.json
-├── eslint.config.js
-├── commitlint.config.js
+├── eslint.config.ts
+├── commitlint.config.ts
 ├── package.json
 ├── tsconfig.json
 ├── vite.config.ts

package/{dist/index.js → index.js}

@@ -6,7 +6,7 @@ import { fileURLToPath } from "node:url";
 import { dashCase, scaffoldProject } from "./scaffold.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-const TEMPLATES_DIR = path.resolve(__dirname, "../templates");
+const TEMPLATES_DIR = path.resolve(__dirname, "templates");
 export function parseArgs(argv) {
     const result = {};
     for (let i = 0; i < argv.length; i++) {
@@ -34,6 +34,7 @@ export function parseArgs(argv) {
     }
     return result;
 }
+/* v8 ignore start -- interactive CLI entry point, tested via cli.test.ts subprocess */
 async function main() {
     p.intro("Create a new NRG project");
     const args = process.argv.slice(2);

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@bonsae/create-nrg",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Scaffold a new NRG project for Node-RED",
   "author": "Allan Oricil <allanoricil@duck.com>",
   "license": "MIT",
   "type": "module",
   "bin": {
-    "create-nrg": "./dist/index.js"
+    "create-nrg": "./index.js"
   },
   "files": [
-    "dist/",
+    "index.js",
+    "scaffold.js",
     "templates/"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "directory": "dist"
   },
   "engines": {
     "node": ">=22"
@@ -30,14 +32,18 @@
     "bonsae"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && node -e \"const fs=require('fs');fs.cpSync('src/templates','dist/templates',{recursive:true});for(const f of['package.json','README.md','LICENSE'])fs.copyFileSync(f,'dist/'+f)\"",
     "dev": "tsc --watch",
-    "lint": "eslint src/",
+    "validate": "pnpm validate:lint && pnpm validate:format",
+    "validate:lint": "eslint src/",
+    "validate:format": "prettier --check \"src/**/*.ts\"",
     "lint:fix": "eslint src/ --fix",
     "format": "prettier --write \"src/**/*.ts\"",
-    "format:check": "prettier --check \"src/**/*.ts\"",
-    "test": "vitest run",
-    "test:watch": "vitest",
+    "test": "pnpm test:unit",
+    "test:unit": "vitest run --config vitest.unit.config.ts",
+    "test:unit:watch": "vitest --config vitest.unit.config.ts",
+    "test:e2e": "vitest run --config vitest.e2e.config.ts",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
     "prepare": "husky"
   },
   "dependencies": {
@@ -54,6 +60,7 @@
     "@types/node": "^22.15.18",
     "@typescript-eslint/eslint-plugin": "^8.32.1",
     "@typescript-eslint/parser": "^8.32.1",
+    "@vitest/coverage-v8": "^4.1.5",
     "eslint": "^9.27.0",
     "eslint-config-prettier": "^10.1.8",
     "husky": "^9.1.7",

package/{dist/scaffold.js → scaffold.js}

@@ -15,7 +15,7 @@ export function pascalCase(str) {
 }
 export function renderTemplate(content, vars) {
     const template = Handlebars.compile(content, { noEscape: true });
-    return template(vars);
+    return template(vars).replace(/\r\n/g, "\n");
 }
 export function copyTemplateDir(srcDir, destDir, vars) {
     const entries = fs.readdirSync(srcDir, { withFileTypes: true });

package/templates/node/schema.ts.hbs

@@ -55,4 +55,19 @@ const SettingsSchema = defineSchema(
   },
 );
 
-export { ConfigsSchema, CredentialsSchema, {{#if hasInputs}}InputSchema, {{/if}}{{#if hasSingleOutput}}OutputSchema, {{/if}}{{#if hasMultipleOutputs}}{{#each outputPorts}}OutputPort{{index}}Schema, {{/each}}{{/if}}SettingsSchema };
+export {
+  ConfigsSchema,
+  CredentialsSchema,
+{{#if hasInputs}}
+  InputSchema,
+{{/if}}
+{{#if hasSingleOutput}}
+  OutputSchema,
+{{/if}}
+{{#if hasMultipleOutputs}}
+{{#each outputPorts}}
+  OutputPort{{index}}Schema,
+{{/each}}
+{{/if}}
+  SettingsSchema,
+};

package/templates/node/server-index.ts.hbs

@@ -1,5 +1,6 @@
+import { defineModule } from "@bonsae/nrg/server";
 import {{pascalCaseNodeName}} from "./nodes/{{dashCaseNodeName}}";
 
-export default {
+export default defineModule({
   nodes: [{{pascalCaseNodeName}}],
-};
+});

package/templates/project/.gitignore.hbs

@@ -3,5 +3,6 @@
 dist
 build
 node_modules
+coverage
 node-red*
 .node-red

package/templates/project/.husky/pre-push.hbs

@@ -0,0 +1 @@
+pnpm build && pnpm validate && pnpm test

package/templates/project/package.json.hbs

@@ -14,18 +14,20 @@
     "nrg"
   ],
   "scripts": {
-    "debug": "NODE_OPTIONS='--inspect-brk' NODE_ENV=development vite",
-    "dev": "NODE_ENV=development vite",
-    "build:dev": "NODE_ENV=development vite build",
-    "build": "NODE_ENV=production vite build",
-    "lint": "eslint src/",
+    "debug": "node --inspect-brk ./node_modules/vite/bin/vite.js --mode development",
+    "dev": "vite --mode development",
+    "build:dev": "vite build --mode development",
+    "build": "vite build --mode production",
+    "validate": "pnpm validate:tsc && pnpm validate:lint && pnpm validate:format",
+    "validate:tsc": "tsc -p src/server/tsconfig.json --noEmit",
+    "validate:lint": "eslint src/",
+    "validate:format": "prettier --check \"src/**/*.{ts,vue,json}\"",
     "lint:fix": "eslint src/ --fix",
     "format": "prettier --write \"src/**/*.{ts,vue,json}\"",
-    "format:check": "prettier --check \"src/**/*.{ts,vue,json}\"",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "tsc:client": "tsc -p src/client/tsconfig.json",
-    "tsc:server": "tsc -p src/server/tsconfig.json",
+    "test": "pnpm test:server",
+    "test:server": "pnpm test:server:unit",
+    "test:server:unit": "vitest run --config vitest.server.unit.config.ts",
+    "test:server:unit:watch": "vitest --config vitest.server.unit.config.ts",
     "prepare": "husky"
   },
   "lint-staged": {
@@ -33,6 +35,9 @@
       "eslint --fix",
       "prettier --write"
     ],
+    "tests/**/*.ts": [
+      "prettier --write"
+    ],
     "src/**/*.json": [
       "prettier --write"
     ]
@@ -53,11 +58,13 @@
     "globals": "^16.1.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.4.0",
+    "node-red": "latest",
     "prettier": "^3.5.3",
+    "tsx": "^4.22.4",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.32.1",
     "vite": "^6.3.4",
     "vitest": "^4.1.5",
-    "vue": "^3.5.14"
+    "vue": "^3.5.34"
   }
 }

package/templates/project/src/server/tsconfig.json.hbs

@@ -1,5 +1,5 @@
 {
-  "extends": "@bonsae/nrg/tsconfig/server.json",
+  "extends": "@bonsae/nrg/tsconfig/core/server.json",
   "compilerOptions": {
     "rootDir": "."
   },

package/templates/project/vitest.server.unit.config.ts.hbs

@@ -0,0 +1,11 @@
+import { defineConfig, mergeConfig } from "vitest/config";
+import { defaultConfig } from "@bonsae/nrg/test/server/unit/config";
+
+export default mergeConfig(
+  defaultConfig,
+  defineConfig({
+    test: {
+      include: ["tests/server/**/*.test.ts"],
+    },
+  }),
+);

package/templates/project/vitest.config.ts.hbs

@@ -1,7 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    include: ["tests/**/*.test.ts"],
-  },
-});