@bonsae/create-nrg 0.6.1 → 0.7.0

package/README.md

@@ -55,11 +55,12 @@ my-project/
     │   ├── nodes/<node>.ts
     │   ├── schemas/<node>.ts
     │   └── tsconfig.json
-    ├── locales/
-    │   ├── labels/<node>/en-US.json
-    │   └── docs/<node>/en-US.md
-    ├── icons/
-    └── examples/
+    └── resources/
+        ├── locales/
+        │   ├── labels/<node>/en-US.json
+        │   └── docs/<node>/en-US.md
+        ├── icons/
+        └── examples/
 ```
 
 ## License

package/index.js

@@ -112,7 +112,13 @@ async function main() {
     const nodeCategory = project.nodeCategory;
     const nodeColor = project.nodeColor;
     const hasInputs = project.hasInputs;
+    // Validate here too: the --outputs flag path bypasses the prompt's validator,
+    // so a non-numeric/negative flag would otherwise scaffold a node with 0 ports.
     const nodeOutputs = parseInt(project.nodeOutputs, 10);
+    if (Number.isNaN(nodeOutputs) || nodeOutputs < 0) {
+        p.cancel("--outputs must be an integer >= 0.");
+        process.exit(1);
+    }
     const projectDir = path.resolve(process.cwd(), dashCase(projectName));
     if (fs.existsSync(projectDir)) {
         p.cancel(`Directory "${dashCase(projectName)}" already exists.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonsae/create-nrg",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Scaffold a new NRG project for Node-RED",
   "author": "Allan Oricil <allanoricil@duck.com>",
   "license": "MIT",
@@ -32,7 +32,7 @@
     "bonsae"
   ],
   "scripts": {
-    "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)\"",
+    "build": "tsc && node -e \"const fs=require('fs');fs.rmSync('dist/templates',{recursive:true,force:true});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",
     "validate": "pnpm validate:lint && pnpm validate:format",
     "validate:lint": "eslint src/",

package/scaffold.js

@@ -72,6 +72,6 @@ export function scaffoldProject(destDir, templatesDir, options) {
     renderTemplateFile(path.join(nodeTemplatesDir, "server-node.ts.hbs"), path.join(srcDir, "server", "nodes", `${dashCaseNodeName}.ts`), vars);
     renderTemplateFile(path.join(nodeTemplatesDir, "schema.ts.hbs"), path.join(srcDir, "server", "schemas", `${dashCaseNodeName}.ts`), vars);
     renderTemplateFile(path.join(nodeTemplatesDir, "server-index.ts.hbs"), path.join(srcDir, "server", "index.ts"), vars);
-    renderTemplateFile(path.join(nodeTemplatesDir, "labels.json.hbs"), path.join(srcDir, "locales", "labels", dashCaseNodeName, "en-US.json"), vars);
-    renderTemplateFile(path.join(nodeTemplatesDir, "docs.md.hbs"), path.join(srcDir, "locales", "docs", dashCaseNodeName, "en-US.md"), vars);
+    renderTemplateFile(path.join(nodeTemplatesDir, "labels.json.hbs"), path.join(srcDir, "resources", "locales", "labels", dashCaseNodeName, "en-US.json"), vars);
+    renderTemplateFile(path.join(nodeTemplatesDir, "docs.md.hbs"), path.join(srcDir, "resources", "locales", "docs", dashCaseNodeName, "en-US.md"), vars);
 }

package/templates/project/.gitignore.hbs

@@ -1,6 +1,7 @@
 .DS_Store
 *.log
 dist
+.nrg
 build
 node_modules
 coverage

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

@@ -3,6 +3,7 @@ import eslintConfigPrettier from "eslint-config-prettier";
 import eslintPluginVue from "eslint-plugin-vue";
 import globals from "globals";
 import typescriptEslint from "typescript-eslint";
+import { nrgConventions } from "@bonsae/nrg/eslint";
 
 export default typescriptEslint.config(
   {
@@ -34,5 +35,42 @@ export default typescriptEslint.config(
       ],
     },
   },
+  // Boundary: browser/client code must never VALUE-import the node runtime. The
+  // server (io-node, node:async_hooks, and anything under src/server/**) is
+  // server-only. Schemas reach the client as serialized data — the nrg vite
+  // plugin in production, the @bonsae/nrg/test/client/component/schemas node
+  // globalSetup in component tests — and as types via `import type` (erased).
+  {
+    files: ["src/client/**/*.ts", "tests/client/**/*.ts"],
+    plugins: { "@typescript-eslint": typescriptEslint.plugin },
+    languageOptions: { parser: typescriptEslint.parser },
+    rules: {
+      "@typescript-eslint/no-restricted-imports": [
+        "error",
+        {
+          paths: [
+            {
+              name: "@bonsae/nrg/server",
+              allowTypeImports: true,
+              message:
+                "Browser/client code must not import the node runtime. Use `import type` for schema types; in tests, name the node type via createNode({ type }) — the schemas globalSetup provides serialized schemas.",
+            },
+          ],
+          patterns: [
+            {
+              group: ["**/server/**"],
+              allowTypeImports: true,
+              message:
+                "Browser/client code must not value-import server modules — they pull in the node runtime. Use `import type`, or createNode({ type }) in tests.",
+            },
+          ],
+        },
+      ],
+    },
+  },
+  // nrg node conventions (shared from the toolkit so they can't drift): a node's
+  // static `type` must match its filename in src/server/nodes — the type string
+  // keys the node's schema, component, icon and locale folder.
+  nrgConventions,
   eslintConfigPrettier,
 );

package/templates/project/package.json.hbs

@@ -16,7 +16,6 @@
   "scripts": {
     "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",
@@ -42,10 +41,9 @@
       "prettier --write"
     ]
   },
-  "dependencies": {
-    "@bonsae/nrg": "latest"
-  },
+  "dependencies": {},
   "devDependencies": {
+    "@bonsae/nrg": "latest",
     "@commitlint/cli": "^20.5.0",
     "@commitlint/config-conventional": "^20.5.0",
     "@eslint/js": "^9.27.0",

package/templates/project/src/resources/README.md

@@ -0,0 +1,8 @@
+# resources
+
+Drop resource folders here and the build handles each by name — no config needed:
+
+- `icons/` — node icons (`{type}.svg/.png`); inlined into the node definitions.
+- `locales/labels/{node}/{lang}.json` — editor labels & descriptions (i18n).
+- `locales/docs/{node}/{lang}.md|.html` — manual help for the Node-RED info panel.
+- any other folder (e.g. `examples/`) — copied verbatim to `dist/<folder>`.