@nrwl/eslint-plugin-nx

What is @nrwl/eslint-plugin-nx?

The @nrwl/eslint-plugin-nx package provides a set of ESLint rules and configurations specifically designed for Nx workspaces. Nx is a suite of powerful, extensible dev tools to help you architect, test, and build at any scale — integrating seamlessly with modern technologies and libraries while providing a robust CLI, caching, dependency management, and more. This ESLint plugin helps enforce best practices and consistent code standards within an Nx workspace.

What are @nrwl/eslint-plugin-nx's main functionalities?

Enforce Module Boundaries

This rule helps to maintain module boundaries by restricting imports between libraries in an Nx workspace. It can enforce that libraries can only depend on other libraries that are tagged to be dependencies, preventing circular dependencies and ensuring a proper project structure.

{
  "rules": {
    "@nrwl/nx/enforce-module-boundaries": [
      "error",
      {
        "enforceBuildableLibDependency": true,
        "allow": [],
        "depConstraints": [
          { "sourceTag": "*", "onlyDependOnLibsWithTags": ["*"] }
        ]
      }
    ]
  }
}

Ban Project Import

This rule prevents importing from specific projects within the workspace. It's useful for large workspaces where you want to enforce strict boundaries between projects, such as not allowing imports from a specific library or application.

{
  "rules": {
    "@nrwl/nx/ban-project-import": [
      "error",
      {
        "allow": ["my-app/**"]
      }
    ]
  }
}

Other packages similar to @nrwl/eslint-plugin-nx

eslint-plugin-import

This package provides a set of rules that help validate proper imports. It includes features like ensuring imports point to a file/module that can be resolved, or ensuring named imports correspond to a named export in the remote file. While it offers similar functionality to @nrwl/eslint-plugin-nx, it is not specific to Nx workspaces and does not have rules tailored to the specific structure and best practices of an Nx workspace.

eslint-plugin-module-resolver

This plugin integrates with eslint-plugin-import to help resolve imports using custom module resolution strategies. It's useful for projects that have custom aliases or directory structures. However, unlike @nrwl/eslint-plugin-nx, it does not provide rules specific to Nx workspaces and their architectural best practices.

README

The README file is missing