Agent skill

run-nx-generator

Run Nx generators with prioritization for workspace-plugin generators. Use this when generating code, scaffolding new features, or automating repetitive tasks in the monorepo.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/development/unknown-nrwl-nx

SKILL.md

Run Nx Generator

This skill helps you execute Nx generators efficiently, with special focus on workspace-plugin generators from your internal tooling.

Generator Priority List

Use the mcp__nx-mcp__nx_generator_schema tool to get more information about how to use the generator

Choose which generators to run in this priority order:

🔥 Workspace-Plugin Generators (High Priority)

These are your custom internal tools in tools/workspace-plugin/

📦 Core Nx Generators (Standard)

Only use these if workspace-plugin generators don't fit:

  • nx generate @nx/devkit:... - DevKit utilities
  • nx generate @nx/node:... - Node.js libraries
  • nx generate @nx/react:... - React components and apps
  • Framework-specific generators

How to Run Generators

  1. List available generators:

  2. Get generator schema (to see available options): Use the mcp__nx-mcp__nx_generator_schema tool to get more information about how to use the generator

  3. Run the generator:

    bash
    nx generate [generator-path] [options]
    
  4. Verify the changes:

    • Review generated files
    • Run tests: nx affected -t test
    • Format code: npx prettier --write [files]

Best Practices

  • ✅ Always check workspace-plugin first - it has your custom solutions
  • ✅ Use --dry-run flag to preview changes before applying
  • ✅ Format generated code immediately with Prettier
  • ✅ Test affected projects after generation
  • ✅ Commit generator changes separately from manual edits

Examples

Bumping Maven Version

When updating the Maven plugin version, use the workspace-plugin generator:

bash
nx generate @nx/workspace-plugin:bump-maven-version \
  --newVersion 0.0.10 \
  --nxVersion 22.1.0-beta.7

This automates all the version bumping instead of manual file edits.

Creating a New Plugin

For creating a new create-nodes plugin:

bash
nx generate @nx/workspace-plugin:create-nodes-plugin \
  --name my-custom-plugin

When to Use This Skill

Use this skill when you need to:

  • Generate new code or projects
  • Scaffold new features or libraries
  • Automate repetitive setup tasks
  • Update internal tools and configurations
  • Create migrations or version updates

Didn't find tool you were looking for?

Be as detailed as possible for better results