@maz-ui/nuxt 5.0.1-beta.0 → 5.1.0-beta.1

package/README.md

@@ -209,6 +209,12 @@ export default defineNuxtConfig({
       vFullscreenImg: true,
       vZoomImg: true,
     },
+
+    // AI coding agents (default: { rules: false, mcp: true }, false to disable)
+    // In development, registers the maz-ui MCP server in the configs of the detected agents
+    // (.mcp.json, .cursor/mcp.json, .vscode/mcp.json), rules: true also writes .claude/rules/maz-ui.md and an AGENTS.md section
+    // In a monorepo, the files go to the root of the workspace (dir: '<folder>' to change it)
+    agents: { rules: false, mcp: true },
   },
 })
 ```

package/dist/module.d.mts

@@ -1,4 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { AgentTarget } from '@maz-ui/node';
 import { MazUiThemeOptions, ThemePreset, ThemePresetName } from '@maz-ui/themes';
 import { MazUiTranslationsOptions } from '@maz-ui/translations';
 import { MazUiDefaultsOptions } from 'maz-ui/composables/useGlobalConfig';
@@ -299,6 +300,23 @@ interface MazUiNuxtOptions {
          */
         vTooltip?: boolean | VTooltipOptions;
     };
+    /**
+     * AI coding agents integration
+     * @description Connects the AI coding agents detected in the project (Claude Code, Cursor, GitHub Copilot...) to maz-ui, in development only (never in CI or tests), version-matched with the installed maz-ui, without overwriting files you own.
+     * - `mcp`: registers the maz-ui MCP server in the agent configs (`.mcp.json`, `.cursor/mcp.json`, `.vscode/mcp.json`). Its instructions already give the maz-ui rules to the agents.
+     * - `rules`: also writes the maz-ui rules in `.claude/rules/maz-ui.md` and in a delimited section of `AGENTS.md` (for agents without MCP).
+     * - `targets`: agents to configure (`'claude'`, `'agents-md'`, `'cursor'`, `'vscode'`), default: the detected ones. Nothing is written when no agent is detected.
+     * - `dir`: folder where the agent files are written, relative to the Nuxt root. Default: the workspace root (`workspaceDir`), so that in a monorepo the files land where the agents start
+     * - `true`: `{ mcp: true, rules: true }`, `false`: disabled
+     * @example `agents: { rules: true }` or `agents: false`
+     * @default { rules: false, mcp: true }
+     */
+    agents?: boolean | {
+        targets?: AgentTarget[];
+        rules?: boolean;
+        mcp?: boolean;
+        dir?: string;
+    };
 }
 
 declare module 'nuxt/schema' {
@@ -309,7 +327,7 @@ declare module 'nuxt/schema' {
         mazUi: MazUiNuxtOptions;
     }
     interface PublicRuntimeConfig {
-        mazUi: Required<MazUiNuxtOptions>;
+        mazUi: Required<Omit<MazUiNuxtOptions, 'agents'>>;
     }
 }
 declare const _default: _nuxt_schema.NuxtModule<MazUiNuxtOptions, MazUiNuxtOptions, false>;

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=3.4.0 <5.0.0"
   },
-  "version": "5.0.1-beta.0",
+  "version": "5.1.0-beta.1",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,8 +1,11 @@
-import { dirname } from 'node:path';
+import { dirname, resolve, join } from 'node:path';
+import process from 'node:process';
 import { fileURLToPath } from 'node:url';
+import { detectAgentTargets, findProjectPackage, setupAgents } from '@maz-ui/node';
 import { capitalize } from '@maz-ui/utils/helpers/capitalize';
+import { getErrorMessage } from '@maz-ui/utils/helpers/getErrorMessage';
 import { addCustomTab } from '@nuxt/devtools-kit';
-import { defineNuxtModule, createResolver, addPlugin, addComponent, addImports } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addPlugin, addComponent, addImports, useLogger } from '@nuxt/kit';
 import { defu } from 'defu';
 
 const COMPONENT_NAMES = {
@@ -155,8 +158,46 @@ const defaults = {
     vClickOutside: false,
     vFullscreenImg: false,
     vTooltip: false
+  },
+  agents: {
+    rules: false,
+    mcp: true
   }
 };
+function syncAgents(agents, nuxt) {
+  if (!agents || !(nuxt.options.dev || nuxt.options._prepare) || process.env.CI || nuxt.options.test) {
+    return;
+  }
+  const logger = useLogger("maz-ui");
+  const isExplicit = nuxt.options.mazUi?.agents !== void 0;
+  try {
+    const { rootDir, workspaceDir } = nuxt.options;
+    const { targets: requestedTargets, rules = true, mcp = true, dir } = typeof agents === "object" ? agents : {};
+    const projectDir = dir ? resolve(rootDir, dir) : workspaceDir || rootDir;
+    const targets = requestedTargets ?? detectAgentTargets(projectDir);
+    if (targets.length === 0 || !rules && !mcp)
+      return;
+    const mazUiDir = findProjectPackage(rootDir, "maz-ui");
+    const { changes } = setupAgents({
+      rootDir: projectDir,
+      targets,
+      rules,
+      mcp,
+      ...mazUiDir ? { docsDir: join(mazUiDir, "docs") } : {}
+    });
+    const applied = changes.filter((change) => ["create", "update", "remove"].includes(change.action));
+    if (applied.length > 0) {
+      const files = applied.map((change) => [change.file, `(${change.action})`].join(" "));
+      logger.info(`AI agents configured for maz-ui: ${files.join(", ")}`);
+    }
+  } catch (error) {
+    const message = `Could not configure the AI agents for maz-ui: ${getErrorMessage(error)}`;
+    if (isExplicit)
+      logger.warn(message);
+    else
+      logger.debug(message);
+  }
+}
 function addMazUiComposableImport({
   name,
   from,
@@ -179,14 +220,15 @@ const module$1 = defineNuxtModule({
   defaults,
   /* eslint-disable complexity, sonarjs/cognitive-complexity */
   setup(options, nuxt) {
-    const { resolve } = createResolver(import.meta.url);
+    const { resolve: resolve2 } = createResolver(import.meta.url);
     nuxt.options.build.transpile.push("maz-ui", "@maz-ui/themes", "@maz-ui/translations");
-    const moduleOptions = defu(
+    const { agents, ...moduleOptions } = defu(
       nuxt.options.runtimeConfig.public.mazUi,
       options,
       defaults
     );
     nuxt.options.runtimeConfig.public.mazUi = moduleOptions;
+    syncAgents(agents, nuxt);
     if (moduleOptions.css.injectCss) {
       nuxt.options.css.unshift("maz-ui/style.css");
     }
@@ -197,9 +239,9 @@ const module$1 = defineNuxtModule({
       const current = typeof postcssPlugins.cssnano === "object" && postcssPlugins.cssnano !== null ? postcssPlugins.cssnano : {};
       postcssPlugins.cssnano = { ...current, preset: ["default", { calc: false }] };
     }
-    addPlugin(resolve(_dirname, "./runtime/plugins/theme"));
-    addPlugin(resolve(_dirname, "./runtime/plugins/translations"));
-    addPlugin(resolve(_dirname, "./runtime/plugins/maz-link-component"));
+    addPlugin(resolve2(_dirname, "./runtime/plugins/theme"));
+    addPlugin(resolve2(_dirname, "./runtime/plugins/translations"));
+    addPlugin(resolve2(_dirname, "./runtime/plugins/maz-link-component"));
     const flags = moduleOptions.flags;
     if (flags && flags !== "cdn" && flags !== "local") {
       moduleOptions.defaults = {
@@ -208,9 +250,9 @@ const module$1 = defineNuxtModule({
       };
     }
     if (flags === "local") {
-      addPlugin(resolve(_dirname, "./runtime/plugins/local-flags"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/local-flags"));
     } else if (Object.keys(moduleOptions.defaults).length > 0) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/defaults"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/defaults"));
     }
     if (moduleOptions.components.autoImport) {
       for (const name of Object.keys(COMPONENT_NAMES)) {
@@ -222,10 +264,10 @@ const module$1 = defineNuxtModule({
     }
     const autoImportPrefix = moduleOptions.general.autoImportPrefix;
     if (moduleOptions.plugins.aos) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/aos"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/aos"));
       addImports({
         name: "useAos",
-        from: resolve(_dirname, "./runtime/composables/useAos"),
+        from: resolve2(_dirname, "./runtime/composables/useAos"),
         as: `use${capitalize(autoImportPrefix)}Aos`
       });
       const injectAosCSS = typeof moduleOptions.plugins.aos === "object" && typeof moduleOptions.plugins.aos.injectCss === "boolean" ? moduleOptions.plugins.aos.injectCss : true;
@@ -234,43 +276,43 @@ const module$1 = defineNuxtModule({
       }
     }
     if (moduleOptions.plugins.toast) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/toast"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/toast"));
       addImports({
         name: "useToast",
-        from: resolve(_dirname, "./runtime/composables/useToast"),
+        from: resolve2(_dirname, "./runtime/composables/useToast"),
         as: `use${capitalize(autoImportPrefix)}Toast`
       });
     }
     if (moduleOptions.plugins.dialog) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/dialog"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/dialog"));
       addImports({
         name: "useDialog",
-        from: resolve(_dirname, "./runtime/composables/useDialog"),
+        from: resolve2(_dirname, "./runtime/composables/useDialog"),
         as: `use${capitalize(autoImportPrefix)}Dialog`
       });
     }
     if (moduleOptions.plugins.wait) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/wait"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/wait"));
       addImports({
         name: "useWait",
-        from: resolve(_dirname, "./runtime/composables/useWait"),
+        from: resolve2(_dirname, "./runtime/composables/useWait"),
         as: `use${capitalize(autoImportPrefix)}Wait`
       });
     }
     if (moduleOptions.directives.vZoomImg) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/v-zoom-img"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/v-zoom-img"));
     }
     if (moduleOptions.directives.vLazyImg) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/v-lazy-img"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/v-lazy-img"));
     }
     if (moduleOptions.directives.vClickOutside) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/v-click-outside"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/v-click-outside"));
     }
     if (moduleOptions.directives.vFullscreenImg) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/v-fullscreen-img"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/v-fullscreen-img"));
     }
     if (moduleOptions.directives.vTooltip) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/v-tooltip"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/v-tooltip"));
     }
     const allowedMazUiComposables = Object.keys(moduleOptions.composables).filter((composable) => mazUiComposables[composable]);
     for (const composable of allowedMazUiComposables) {
@@ -295,10 +337,10 @@ const module$1 = defineNuxtModule({
       });
     }
     if (moduleOptions.general.defaultMazIconPath) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/maz-icon-path"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/maz-icon-path"));
     }
     if (moduleOptions.general.preventIosInputZoom) {
-      addPlugin(resolve(_dirname, "./runtime/plugins/prevent-ios-input-zoom.client"));
+      addPlugin(resolve2(_dirname, "./runtime/plugins/prevent-ios-input-zoom.client"));
     }
     if (moduleOptions.general.devtools) {
       addCustomTab({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maz-ui/nuxt",
   "type": "module",
-  "version": "5.0.1-beta.0",
+  "version": "5.1.0-beta.1",
   "description": "Nuxt module for Maz-UI",
   "author": "Louis Mazel <me@loicmazuel.com>",
   "license": "MIT",
@@ -51,13 +51,14 @@
     "nuxt": ">=3.4.0 <5.0.0"
   },
   "dependencies": {
+    "@maz-ui/node": "5.1.0-beta.1",
     "@maz-ui/themes": "5.0.0",
     "@maz-ui/translations": "5.0.0",
     "@maz-ui/utils": "5.0.0",
     "@nuxt/devtools-kit": "^3.4.4",
     "@nuxt/kit": "^4.6.2",
     "defu": "^6.1.7",
-    "maz-ui": "5.0.1-beta.0"
+    "maz-ui": "5.1.0-beta.1"
   },
   "devDependencies": {
     "@maz-ui/eslint-config": "5.0.0",