run-nx-generator

star 28.9k

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

nrwl By nrwl schedule Updated 5/5/2026

name: run-nx-generator description: Run Nx generators with prioritization for workspace-plugin generators. Use this when generating code, scaffolding new features, or automating repetitive tasks in the monorepo. allowed-tools: Bash, Read, Glob, Grep, mcp__nx-mcp__nx_generators, mcp__nx-mcp__nx_generator_schema

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:

    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:

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.

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
Install via CLI
npx skills add https://github.com/nrwl/nx --skill run-nx-generator
Repository Details
star Stars 28,942
call_split Forks 2,739
navigation Branch main
article Path SKILL.md
More from Creator