nuxt-processor 0.0.2 → 0.0.3

package/README.md

@@ -3,6 +3,7 @@
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![License][license-src]][license-href]
+[![Known Vulnerabilities](https://snyk.io/test/github/aidanhibbard/nuxt-processor/badge.svg)](https://snyk.io/test/github/aidanhibbard/nuxt-processor)
 
 Background job processing for Nuxt using BullMQ with a dedicated workers process.
 
@@ -40,7 +41,7 @@ Add the module in `nuxt.config.ts` and set your Redis connection.
 // nuxt.config.ts
 export default defineNuxtConfig({
   modules: ['nuxt-processor'],
-  workers: {
+  processor: {
     redis: {
       host: process.env.NUXT_REDIS_HOST ?? '127.0.0.1', // defaults '127.0.0.1'
       port: Number(process.env.NUXT_REDIS_PORT ?? 6379), // defaults 6379
@@ -55,7 +56,7 @@ export default defineNuxtConfig({
 Create `server/queues/index.ts`:
 
 ```ts
-import { defineQueue } from '#workers'
+import { defineQueue } from '#processor'
 
 export default defineQueue({
   name: 'hello',
@@ -67,7 +68,7 @@ export default defineQueue({
 Create `server/workers/index.ts`:
 
 ```ts
-import { defineWorker } from '#workers'
+import { defineWorker } from '#processor'
 import type { Job } from '#bullmq'
 
 export default defineWorker({
@@ -83,8 +84,15 @@ export default defineWorker({
 
 ## Running
 
-- Start your Nuxt app normally (dev or build). This module generates a dedicated workers entry.
-- Start workers explicitly in a separate terminal:
+- Start your Nuxt app normally. This module generates a dedicated workers entry.
+- In development, run workers from `.nuxt/dev/workers/index.mjs` in a separate terminal:
+
+```bash
+nuxi dev
+node .nuxt/dev/workers/index.mjs
+```
+
+- After building for production, run workers from `.output/server/workers/index.mjs`:
 
 ```bash
 nuxi build

package/dist/module.d.mts

@@ -3,8 +3,12 @@ import { RedisOptions } from 'bullmq';
 
 interface ModuleOptions {
     redis: RedisOptions;
-    queues: string[];
-    workers: string[];
+    /**
+     * The folder containing the worker files
+     * Scans for {ts,js,mjs}
+     * @default 'server/workers'
+     */
+    workers: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-processor",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "compatibility": {
     "nuxt": "^4.0.0"
   },

package/dist/module.mjs

@@ -1,14 +1,28 @@
-import { defineNuxtModule, createResolver, addTemplate, logger } from '@nuxt/kit';
-import { readdir } from 'node:fs/promises';
+import { useNuxt, createResolver, defineNuxtModule, addTemplate } from '@nuxt/kit';
 import { relative } from 'node:path';
+import fg from 'fast-glob';
 
 const name = "nuxt-processor";
-const version = "0.0.2";
+const version = "0.0.3";
 const configKey = "processor";
 const compatibility = {
 	nuxt: "^4.0.0"
 };
 
+const scanFolder = async (path) => {
+  const nuxt = useNuxt();
+  const { resolve } = createResolver(import.meta.url);
+  const resolvedPath = resolve(nuxt.options.rootDir, path);
+  const files = [];
+  const updatedFiles = await fg("**/*.{ts,js,mjs}", {
+    cwd: resolvedPath,
+    absolute: true,
+    onlyFiles: true
+  });
+  files.push(...new Set(updatedFiles));
+  return files;
+};
+
 const module = defineNuxtModule({
   meta: {
     name,
@@ -23,40 +37,11 @@ const module = defineNuxtModule({
       port: Number(process.env.NUXT_REDIS_PORT ?? 6379),
       password: process.env.NUXT_REDIS_PASSWORD ?? ""
     },
-    queues: [],
-    workers: []
+    workers: "server/workers"
   },
-  setup(_options, _nuxt) {
+  async setup(_options, _nuxt) {
     const { resolve } = createResolver(import.meta.url);
     const buildDir = _nuxt.options.buildDir;
-    const srcDir = _nuxt.options.srcDir;
-    const allowedExtensions = /* @__PURE__ */ new Set([".ts", ".js", ".mjs", ".mts", ".cjs", ".cts"]);
-    async function collectFiles(fromDir) {
-      const results = [];
-      async function walk(dir) {
-        let entries = [];
-        try {
-          entries = await readdir(dir, { withFileTypes: true });
-        } catch (err) {
-          logger.withTag("nuxt-processor").warn("failed to read directory", dir, err);
-          return;
-        }
-        await Promise.all(entries.map(async (entry) => {
-          const fullPath = resolve(dir, entry.name);
-          if (entry.isDirectory()) {
-            await walk(fullPath);
-          } else {
-            const dotIndex = fullPath.lastIndexOf(".");
-            const ext = dotIndex >= 0 ? fullPath.slice(dotIndex) : "";
-            if (allowedExtensions.has(ext)) {
-              results.push(fullPath);
-            }
-          }
-        }));
-      }
-      await walk(fromDir);
-      return results;
-    }
     function generateWorkersEntryContent(workerFiles) {
       const redisInline = JSON.stringify(_options.redis ?? {});
       const toImportArray = workerFiles.map((id) => `() => import(${JSON.stringify(id)})`).join(",\n    ");
@@ -64,7 +49,7 @@ const module = defineNuxtModule({
 import { fileURLToPath } from 'node:url'
 import { resolve as resolvePath } from 'node:path'
 import { consola } from 'consola'
-import { $workers } from '#workers-utils'
+import { $workers } from '#processor-utils'
 
 // Initialize connection as early as possible so any imports that register
 // workers/queues have a valid connection available.
@@ -149,11 +134,10 @@ if (isMain) {
 export default { createWorkersApp }
 `;
     }
-    const { resolve: r } = createResolver(import.meta.url);
-    _nuxt.options.alias = _nuxt.options.alias || {};
-    _nuxt.options.alias["nuxt-processor"] = r("./runtime/server/handlers");
-    _nuxt.options.alias["#workers"] = r("./runtime/server/handlers");
-    _nuxt.options.alias["#workers-utils"] = r("./runtime/server/utils/workers");
+    _nuxt.options.alias = _nuxt.options.alias ?? {};
+    _nuxt.options.alias["nuxt-processor"] = resolve("./runtime/server/handlers");
+    _nuxt.options.alias["#processor"] = resolve("./runtime/server/handlers");
+    _nuxt.options.alias["#processor-utils"] = resolve("./runtime/server/utils/workers");
     if (!_nuxt.options.alias["#bullmq"]) {
       _nuxt.options.alias["#bullmq"] = "bullmq";
     }
@@ -162,17 +146,17 @@ export default { createWorkersApp }
       write: true,
       getContents: () => `
 declare module 'nuxt-processor' {
-  export { defineQueue } from '${r("./runtime/server/handlers/defineQueue")}'
-  export { defineWorker } from '${r("./runtime/server/handlers/defineWorker")}'
+  export { defineQueue } from '${resolve("./runtime/server/handlers/defineQueue")}'
+  export { defineWorker } from '${resolve("./runtime/server/handlers/defineWorker")}'
 }
 
-declare module '#workers' {
-  export { defineQueue } from '${r("./runtime/server/handlers/defineQueue")}'
-  export { defineWorker } from '${r("./runtime/server/handlers/defineWorker")}'
+declare module '#processor' {
+  export { defineQueue } from '${resolve("./runtime/server/handlers/defineQueue")}'
+  export { defineWorker } from '${resolve("./runtime/server/handlers/defineWorker")}'
 }
 
-declare module '#workers-utils' {
-  export { $workers } from '${r("./runtime/server/utils/workers")}'
+declare module '#processor-utils' {
+  export { $workers } from '${resolve("./runtime/server/utils/workers")}'
 }
 
 declare module '#bullmq' {
@@ -191,7 +175,7 @@ declare module '#bullmq' {
       return {
         name: "nuxt-processor-emit",
         async buildStart() {
-          const workerFiles = await collectFiles(resolve(srcDir, "server/workers"));
+          const workerFiles = await scanFolder(_options.workers);
           if (workerFiles.length === 0) {
             virtualCode = "";
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-processor",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Nuxt Processor",
   "repository": "https://github.com/aidanhibbard/nuxt-processor",
   "license": "MIT",
@@ -43,6 +43,7 @@
   "dependencies": {
     "@nuxt/kit": "^4.0.3",
     "bullmq": "^5.58.2",
+    "fast-glob": "^3.3.3",
     "ioredis": "^5.7.0"
   },
   "devDependencies": {