@bonsae/nrg 0.27.0 → 0.28.0

package/eslint/index.js

@@ -0,0 +1,48 @@
+// src/eslint/index.ts
+var nodeTypeMatchesFilename = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "require a node's static `type` to equal its filename in server/nodes"
+    },
+    schema: [],
+    messages: {
+      mismatch: `Node static type "{{type}}" must match the filename "{{expected}}.ts" \u2014 the type string keys the node's schema, component, icon and locale folder.`
+    }
+  },
+  create(context) {
+    const match = /[\\/]server[\\/]nodes[\\/]([^\\/]+)\.ts$/.exec(
+      context.filename
+    );
+    if (!match) return {};
+    const expected = match[1];
+    return {
+      "PropertyDefinition[static=true]"(node) {
+        if (node.key?.type === "Identifier" && node.key.name === "type" && node.value?.type === "Literal" && typeof node.value.value === "string" && node.value.value !== expected) {
+          context.report({
+            node: node.value,
+            messageId: "mismatch",
+            data: { type: node.value.value, expected }
+          });
+        }
+      }
+    };
+  }
+};
+var plugin = {
+  meta: { name: "@bonsae/nrg" },
+  rules: { "node-type-matches-filename": nodeTypeMatchesFilename }
+};
+var nrgConventions = {
+  plugins: { "@bonsae/nrg": plugin },
+  rules: {
+    "@bonsae/nrg/node-type-matches-filename": "error"
+  }
+};
+var index_default = nrgConventions;
+export {
+  index_default as default,
+  nodeTypeMatchesFilename,
+  nrgConventions,
+  plugin
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonsae/nrg",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "NRG framework — build Node-RED nodes with Vue 3, TypeScript, and JSON Schema",
   "author": "Allan Oricil <allanoricil@duck.com>",
   "license": "MIT",
@@ -50,6 +50,7 @@
       "types": "./types/vite.d.ts",
       "default": "./vite/index.js"
     },
+    "./eslint": "./eslint/index.js",
     "./test/server/unit": {
       "types": "./types/test-server-unit.d.ts",
       "default": "./test/server/unit/index.js"

package/test/client/e2e/index.js

@@ -2306,12 +2306,12 @@ async function build2(clientBuildOptions, buildContext) {
     name = "NodeRedNodes",
     format = "es",
     licensePath = "./LICENSE",
-    locales,
-    staticDirs = {},
+    publicDir,
     external = [],
     globals = {},
     manualChunks
   } = clientBuildOptions;
+  const resourcesDir = buildContext.resourcesDir;
   const cacheDir = path10.resolve(
     "node_modules",
     ".nrg",
@@ -2332,9 +2332,7 @@ async function build2(clientBuildOptions, buildContext) {
     entryPath = cachedEntryPath;
     generatedEntry = true;
   }
-  const iconsDir = path10.resolve(
-    staticDirs.icons ?? path10.join(path10.dirname(path10.resolve(srcDir)), "icons")
-  );
+  const iconsDir = path10.join(resourcesDir, "icons");
   const plugins = [
     vue(),
     nodeDefinitionsInliner(
@@ -2353,33 +2351,31 @@ async function build2(clientBuildOptions, buildContext) {
       licensePath: licensePath ? path10.resolve(licensePath) : void 0
     })
   );
-  if (locales) {
-    const { docsDir = "./locales/docs", labelsDir = "./locales/labels" } = locales;
+  const localesDir = path10.join(resourcesDir, "locales");
+  if (fs10.existsSync(localesDir)) {
+    const docsDir = path10.join(localesDir, "docs");
+    const labelsDir = path10.join(localesDir, "labels");
     const localesOutDir = path10.join(buildContext.outDir, "locales");
     plugins.push(
-      localesGenerator({
-        outDir: localesOutDir,
-        docsDir: path10.resolve(docsDir),
-        labelsDir: path10.resolve(labelsDir)
-      })
+      localesGenerator({ outDir: localesOutDir, docsDir, labelsDir })
     );
     plugins.push(
       helpGenerator({
         outDir: buildContext.outDir,
         localesOutDir,
-        docsDir: path10.resolve(docsDir),
-        labelsDir: path10.resolve(labelsDir),
+        docsDir,
+        labelsDir,
         srcDir: buildContext.serverSrcDir
       })
     );
   }
   const copyTargets = [];
-  const publicDir = path10.resolve(
-    staticDirs.public ?? path10.join(srcDir, "public")
+  const resolvedPublicDir = path10.resolve(
+    publicDir ?? path10.join(srcDir, "public")
   );
-  if (fs10.existsSync(publicDir)) {
+  if (fs10.existsSync(resolvedPublicDir)) {
     copyTargets.push({
-      src: publicDir,
+      src: resolvedPublicDir,
       dest: path10.join(buildContext.outDir, "resources")
     });
   }
@@ -3061,7 +3057,8 @@ var NodeRedTestEnvironment = class {
     const buildContext = {
       outDir: this.outDir,
       packageName: this.options.packageName,
-      isDev: false
+      isDev: false,
+      resourcesDir: path13.join(this.projectDir, "src/resources")
     };
     const serverOpts = {
       srcDir: path13.join(this.projectDir, "src/server"),

package/types/test-client-e2e.d.ts

@@ -19,15 +19,8 @@ interface ClientBuildOptions {
 	base?: string;
 	/** Path to LICENSE file to include in the HTML output. @default "./LICENSE" */
 	licensePath?: string;
-	/** Internationalization options for labels and docs. */
-	locales?: LocalesOptions;
-	/** Directories for static assets (icons, public files). */
-	staticDirs?: {
-		/** Directory containing node icons ({type}.png). @default "./src/icons" */
-		icons?: string;
-		/** Directory for public static files copied to dist/resources/. @default "./src/client/public" */
-		public?: string;
-	};
+	/** Directory for the editor's public static files, copied to dist/resources/. @default "./src/client/public" */
+	publicDir?: string;
 	/** Modules to treat as external (not bundled). @default ["jquery", "node-red", "vue", "@bonsae/nrg/client"] */
 	external?: string[];
 	/** Global variable mappings for external modules. */
@@ -35,12 +28,6 @@ interface ClientBuildOptions {
 	/** Custom chunk splitting function for Rollup. */
 	manualChunks?: (id: string) => string | undefined;
 }
-interface LocalesOptions {
-	/** Directory containing documentation files ({type}/{lang}.md or .html). @default "./src/locales/docs" */
-	docsDir?: string;
-	/** Directory containing label files ({type}/{lang}.json). @default "./src/locales/labels" */
-	labelsDir?: string;
-}
 interface ServerBuildOptions {
 	/** Source directory for server code. @default "./src/server" */
 	srcDir?: string;

package/types/vite.d.ts

@@ -6,6 +6,12 @@ export interface BuildContext {
 	isDev: boolean;
 	/** Resolved server source dir, scanned to recover `Unsafe<T>()` types for docs. */
 	serverSrcDir?: string;
+	/**
+	 * Resolved resources dir (default ./src/resources). Its convention subfolders
+	 * are auto-handled: `icons/` and `locales/{docs,labels}/` run their pipelines,
+	 * every other folder is copied verbatim to `dist/<name>`. @default ./src/resources
+	 */
+	resourcesDir: string;
 }
 export interface BuildPluginOptions {
 	serverBuildOptions: ServerBuildOptions;
@@ -30,15 +36,8 @@ export interface ClientBuildOptions {
 	base?: string;
 	/** Path to LICENSE file to include in the HTML output. @default "./LICENSE" */
 	licensePath?: string;
-	/** Internationalization options for labels and docs. */
-	locales?: LocalesOptions;
-	/** Directories for static assets (icons, public files). */
-	staticDirs?: {
-		/** Directory containing node icons ({type}.png). @default "./src/icons" */
-		icons?: string;
-		/** Directory for public static files copied to dist/resources/. @default "./src/client/public" */
-		public?: string;
-	};
+	/** Directory for the editor's public static files, copied to dist/resources/. @default "./src/client/public" */
+	publicDir?: string;
 	/** Modules to treat as external (not bundled). @default ["jquery", "node-red", "vue", "@bonsae/nrg/client"] */
 	external?: string[];
 	/** Global variable mappings for external modules. */
@@ -52,12 +51,6 @@ export interface CopyTarget {
 	/** Destination path relative to the output directory. */
 	dest: string;
 }
-export interface LocalesOptions {
-	/** Directory containing documentation files ({type}/{lang}.md or .html). @default "./src/locales/docs" */
-	docsDir?: string;
-	/** Directory containing label files ({type}/{lang}.json). @default "./src/locales/labels" */
-	labelsDir?: string;
-}
 export interface LoggerOptions {
 	name: string;
 	prefix?: string;
@@ -93,8 +86,6 @@ export interface BuildOptions {
 	server?: ServerBuildOptions;
 	/** Options for building the client-side editor UI. */
 	client?: ClientBuildOptions;
-	/** Extra files to copy into the output directory (e.g., LICENSE, README). */
-	extraFilesCopyTargets?: CopyTarget[];
 }
 /**
  * Options for the `nrg()` Vite plugin.

package/vite/index.js

@@ -3,6 +3,7 @@ import path15 from "path";
 
 // src/vite/defaults.ts
 var DEFAULT_OUTPUT_DIR = "./dist";
+var DEFAULT_RESOURCES_DIR = "./src/resources";
 var DEFAULT_CLIENT_BUILD_OPTIONS = {
   srcDir: "./src/client",
   entry: "index.ts",
@@ -16,14 +17,7 @@ var DEFAULT_CLIENT_BUILD_OPTIONS = {
     "node-red": "RED",
     vue: "Vue"
   },
-  locales: {
-    docsDir: "./src/locales/docs",
-    labelsDir: "./src/locales/labels"
-  },
-  staticDirs: {
-    icons: "./src/icons",
-    public: "./src/client/public"
-  }
+  publicDir: "./src/client/public"
 };
 var DEFAULT_SERVER_BUILD_OPTIONS = {
   srcDir: "./src/server",
@@ -45,8 +39,7 @@ var DEFAULT_NODE_RED_LAUNCHER_OPTIONS = {
 };
 var DEFAULT_EXTRA_FILES_COPY_TARGETS = [
   { src: "./LICENSE", dest: "LICENSE" },
-  { src: "./README.md", dest: "README.md" },
-  { src: "./src/examples", dest: "examples" }
+  { src: "./README.md", dest: "README.md" }
 ];
 
 // src/vite/utils.ts
@@ -74,6 +67,16 @@ function copyFiles(targets, outDir) {
     }
   }
 }
+var RESOURCE_PIPELINE_FOLDERS = /* @__PURE__ */ new Set(["icons", "locales"]);
+function discoverResourceCopyTargets(resourcesDir) {
+  if (!fs.existsSync(resourcesDir)) return [];
+  return fs.readdirSync(resourcesDir, { withFileTypes: true }).filter(
+    (entry) => entry.isDirectory() && !RESOURCE_PIPELINE_FOLDERS.has(entry.name)
+  ).map((entry) => ({
+    src: path.join(resourcesDir, entry.name),
+    dest: entry.name
+  }));
+}
 function getPackageName() {
   const pkgPath = path.resolve("./package.json");
   if (fs.existsSync(pkgPath)) {
@@ -2963,12 +2966,12 @@ async function build2(clientBuildOptions, buildContext) {
     name = "NodeRedNodes",
     format = "es",
     licensePath = "./LICENSE",
-    locales,
-    staticDirs = {},
+    publicDir,
     external = [],
     globals = {},
     manualChunks
   } = clientBuildOptions;
+  const resourcesDir = buildContext.resourcesDir;
   const cacheDir = path13.resolve(
     "node_modules",
     ".nrg",
@@ -2989,9 +2992,7 @@ async function build2(clientBuildOptions, buildContext) {
     entryPath = cachedEntryPath;
     generatedEntry = true;
   }
-  const iconsDir = path13.resolve(
-    staticDirs.icons ?? path13.join(path13.dirname(path13.resolve(srcDir)), "icons")
-  );
+  const iconsDir = path13.join(resourcesDir, "icons");
   const plugins = [
     vue(),
     nodeDefinitionsInliner(
@@ -3010,33 +3011,31 @@ async function build2(clientBuildOptions, buildContext) {
       licensePath: licensePath ? path13.resolve(licensePath) : void 0
     })
   );
-  if (locales) {
-    const { docsDir = "./locales/docs", labelsDir = "./locales/labels" } = locales;
+  const localesDir = path13.join(resourcesDir, "locales");
+  if (fs14.existsSync(localesDir)) {
+    const docsDir = path13.join(localesDir, "docs");
+    const labelsDir = path13.join(localesDir, "labels");
     const localesOutDir = path13.join(buildContext.outDir, "locales");
     plugins.push(
-      localesGenerator({
-        outDir: localesOutDir,
-        docsDir: path13.resolve(docsDir),
-        labelsDir: path13.resolve(labelsDir)
-      })
+      localesGenerator({ outDir: localesOutDir, docsDir, labelsDir })
     );
     plugins.push(
       helpGenerator({
         outDir: buildContext.outDir,
         localesOutDir,
-        docsDir: path13.resolve(docsDir),
-        labelsDir: path13.resolve(labelsDir),
+        docsDir,
+        labelsDir,
         srcDir: buildContext.serverSrcDir
       })
     );
   }
   const copyTargets = [];
-  const publicDir = path13.resolve(
-    staticDirs.public ?? path13.join(srcDir, "public")
+  const resolvedPublicDir = path13.resolve(
+    publicDir ?? path13.join(srcDir, "public")
   );
-  if (fs14.existsSync(publicDir)) {
+  if (fs14.existsSync(resolvedPublicDir)) {
     copyTargets.push({
-      src: publicDir,
+      src: resolvedPublicDir,
       dest: path13.join(buildContext.outDir, "resources")
     });
   }
@@ -3294,21 +3293,10 @@ function serverPlugin(options) {
       const clientSrcDir = path14.resolve(
         clientBuildOptions.srcDir ?? "./client"
       );
-      const localesDocsDir = path14.resolve(
-        clientBuildOptions.locales?.docsDir ?? "./locales/docs"
-      );
-      const localesLabelsDir = path14.resolve(
-        clientBuildOptions.locales?.labelsDir ?? "./locales/labels"
-      );
-      const iconsDir = path14.resolve(
-        clientBuildOptions.staticDirs?.icons ?? path14.join(path14.dirname(clientSrcDir), "icons")
-      );
       const watchPaths = [
         serverSrcDir,
         clientSrcDir,
-        localesDocsDir,
-        localesLabelsDir,
-        iconsDir
+        buildContext.resourcesDir
       ];
       watcher = chokidar.watch(watchPaths, {
         ignoreInitial: true,
@@ -3414,13 +3402,18 @@ function nrg(options = {}) {
     DEFAULT_NODE_RED_LAUNCHER_OPTIONS,
     server.nodeRed
   );
-  const extraFilesCopyTargets = build3.extraFilesCopyTargets ?? DEFAULT_EXTRA_FILES_COPY_TARGETS;
+  const resourcesDir = path15.resolve(DEFAULT_RESOURCES_DIR);
+  const extraFilesCopyTargets = [
+    ...DEFAULT_EXTRA_FILES_COPY_TARGETS,
+    ...discoverResourceCopyTargets(resourcesDir)
+  ];
   const resolvedOutDir = path15.resolve(outDir);
   const buildContext = {
     outDir: resolvedOutDir,
     packageName: getPackageName(),
     isDev: process.env.NODE_ENV === "development",
-    serverSrcDir: path15.resolve(serverBuildOptions.srcDir ?? "./server")
+    serverSrcDir: path15.resolve(serverBuildOptions.srcDir ?? "./server"),
+    resourcesDir
   };
   const nodeRedLauncher = new NodeRedLauncher(
     resolvedOutDir,