@nrwl/eslint-plugin-nx
Advanced tools
The eslint-plugin-nx package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.
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.
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/**"]
}
]
}
}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.
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.
@nrwl/eslint-plugin-nx has been renamed to @nx/eslint-plugin. Please use that instead.
@nrwl/eslint-plugin-nx will no longer be published in the future.
Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.
FAQs
The eslint-plugin-nx package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.
The npm package @nrwl/eslint-plugin-nx receives a total of 1,008,328 weekly downloads. As such, @nrwl/eslint-plugin-nx popularity was classified as popular.
We found that @nrwl/eslint-plugin-nx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.