NxRocks

NxRocks is a collection of Nx plugins and custom CLIs designed to enhance Nx workspaces by providing first-class support for various frameworks and tools.

Available Nx Plugins

These plugins allow you to generate, run, package, and build specific framework projects within an existing Nx workspace:

• nx-spring-boot: Support for Spring Boot projects.
• nx-flutter: Support for Flutter projects.
• nx-quarkus: Support for Quarkus projects.
• nx-micronaut: Support for Micronaut projects.
• nx-melos: Support for Melos.
• nx-ktor: Support for Ktor projects.

Available Custom CLIs

These CLIs are used to bootstrap new Nx workspaces that come with built-in support for specific frameworks:

• create-nx-spring-boot: Creates Nx workspaces with Spring Boot support.
• create-nx-flutter: Creates Nx workspaces with Flutter support.
• create-nx-quarkus: Creates Nx workspaces with Quarkus support.
• create-nx-micronaut: Creates Nx workspaces with Micronaut support.
• create-nx-ktor: Creates Nx workspaces with Ktor support.

The @nxrocks/nx-spring-boot plugin provides the following capabilities for managing Spring Boot projects within an Nx workspace:

• Spring Initializr Integration: Generates Spring Boot applications and libraries based on the Spring Initializr API.
• Lifecycle Management: Supports building, packaging, testing, and more for Spring Boot projects.
• Multi-module Support: Built-in support for creating multi-module Spring Boot projects using either Maven or Gradle.
• Code Formatting: Integrated support for the Spotless plugin for both Maven and Gradle.
• Proxy Support: Supports corporate proxies via the --proxyUrl flag or standard environment variables (http_proxy, HTTP_PROXY, https_proxy, or HTTPS_PROXY).
• Nx Dependency Graph Integration: Integrates with Nx's dependency graph (e.g., nx graph or nx affected:graph), allowing you to visualize dependencies of Maven/Gradle Spring Boot applications and libraries just like native JS/TS projects.

Once a Flutter app is generated within an Nx workspace, you can manage it using executors. These executors are kebab-cased wrappers around standard flutter and dart commands.

To run an executor, you can use the nx <executor> <project> syntax or the more explicit nx run <project>:<executor> syntax.

Passing Arguments Executors accept the same additional arguments as the original underlying commands. You can pass them using the --option=value syntax. If an argument contains spaces (like an executable command), wrap it in quotes.

# Using the short syntax
$ nx gen-l10n your-flutterapp --header="/// my header"
$ nx pub-add your-flutterapp --package=build_runner
$ nx pub-run your-flutterapp --executable="build_runner build"

# Using the explicit 'run' syntax
$ nx run your-flutterapp:gen-l10n --header="/// my header"
$ nx run your-flutterapp:pub-add --package=build_runner
$ nx run your-flutterapp:pub-run --executable="build_runner build"

The @nxrocks/nx-micronaut plugin provides several executors to manage Micronaut applications and libraries within an Nx workspace. By default, these executors use the embedded ./mvnw or ./gradlew wrappers generated with your project.

To use a globally installed mvn or gradle instead of the wrapper (useful in CI or restricted environments), use the --ignoreWrapper option.

You can pass additional arguments to the underlying Maven or Gradle commands temporarily using the --args flag, or permanently by configuring the args array in your workspace.json (or project.json) file.

# Temporary arguments via CLI
nx run your-micronaut-app --args="-Dpackaging=docker-native"

// Permanent configuration in workspace.json
{
  "targets": {
    "dockerfile": {
      "executor": "@nxrocks/nx-micronaut:dockerfile",
      "options": {
        "root": "apps/your-micronaut-app",
        "args": ["-Dpackaging=docker-native"]
      }
    }
  }
}