miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

docs(misc): update conformance rule options (#31183)

Browse Source 
This PR updates our conformance rule that enforces module boundaries.
See here for more details: https://github.com/nrwl/ocean/pull/7377
This commit is contained in:
Jack Hsu 2025-05-13 11:59:27 -04:00 committed by GitHub
parent cd59a6678e
commit a31226437e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/external-generated/packages/conformance/documents/overview.md
View File

@ -116,9 +116,7 @@ Set the `rule` property to: `@nx/conformance/enforce-project-boundaries`
// Optional // Optional
"notDependOnProjectsWithTags": [] "notDependOnProjectsWithTags": []
} }
], ]
// Optional
"checkDynamicDependenciesExceptions": []
} }
} }
] ]
@ -131,7 +129,6 @@ Set the `rule` property to: `@nx/conformance/enforce-project-boundaries`
| Property | Type | Default | Description | | Property | Type | Default | Description |
| ------------------------------------------------ | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------ | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ignoredCircularDependencies | _Array<[string, string]>_ | _[]_ | List of project pairs that should be skipped from `Circular dependencies` checks, including the self-circular dependency check. E.g. `['feature-project-a', 'myapp']`. Project name can be replaced by catch all `*` for more generic matches. | | ignoredCircularDependencies | _Array<[string, string]>_ | _[]_ | List of project pairs that should be skipped from `Circular dependencies` checks, including the self-circular dependency check. E.g. `['feature-project-a', 'myapp']`. Project name can be replaced by catch all `*` for more generic matches. |
| checkDynamicDependenciesExceptions | _Array<string>_ | _[]_ | List of imports that should be skipped for `Imports of lazy-loaded libraries forbidden` checks. E.g. `['@myorg/lazy-project/component/*', '@myorg/other-project']` |
| requireBuildableDependenciesForBuildableProjects | _boolean_ | _false_ | Enable to restrict the buildable projects from importing non-buildable libraries | | requireBuildableDependenciesForBuildableProjects | _boolean_ | _false_ | Enable to restrict the buildable projects from importing non-buildable libraries |
| depConstraints | _Array<object>_ | _[]_ | List of dependency constraints between projects | | depConstraints | _Array<object>_ | _[]_ | List of dependency constraints between projects |

5
docs/shared/packages/conformance/conformance-plugin.md
View File

@ -116,9 +116,7 @@ Set the `rule` property to: `@nx/conformance/enforce-project-boundaries`
// Optional // Optional
"notDependOnProjectsWithTags": [] "notDependOnProjectsWithTags": []
} }
], ]
// Optional
"checkDynamicDependenciesExceptions": []
} }
} }
] ]
@ -131,7 +129,6 @@ Set the `rule` property to: `@nx/conformance/enforce-project-boundaries`
| Property | Type | Default | Description | | Property | Type | Default | Description |
| ------------------------------------------------ | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------ | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ignoredCircularDependencies | _Array<[string, string]>_ | _[]_ | List of project pairs that should be skipped from `Circular dependencies` checks, including the self-circular dependency check. E.g. `['feature-project-a', 'myapp']`. Project name can be replaced by catch all `*` for more generic matches. | | ignoredCircularDependencies | _Array<[string, string]>_ | _[]_ | List of project pairs that should be skipped from `Circular dependencies` checks, including the self-circular dependency check. E.g. `['feature-project-a', 'myapp']`. Project name can be replaced by catch all `*` for more generic matches. |
| checkDynamicDependenciesExceptions | _Array<string>_ | _[]_ | List of imports that should be skipped for `Imports of lazy-loaded libraries forbidden` checks. E.g. `['@myorg/lazy-project/component/*', '@myorg/other-project']` |
| requireBuildableDependenciesForBuildableProjects | _boolean_ | _false_ | Enable to restrict the buildable projects from importing non-buildable libraries | | requireBuildableDependenciesForBuildableProjects | _boolean_ | _false_ | Enable to restrict the buildable projects from importing non-buildable libraries |
| depConstraints | _Array<object>_ | _[]_ | List of dependency constraints between projects | | depConstraints | _Array<object>_ | _[]_ | List of dependency constraints between projects |