Skip to content

Commit

Permalink
docs: Minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
javierbrea committed Dec 1, 2023
1 parent 394f821 commit b52107e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In words of Robert C. Martin, _"Software architecture is the art of drawing line

__This plugin ensures that your architecture boundaries are respected by the elements in your project__ checking the folders and files structure and the dependencies between them. __It is not a replacement for [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import), on the contrary, the combination of both plugins is recommended.__

By default, the plugin works by checking `import` statements, but it is also able to analyze exports, dynamic imports, and can be configured to check any other [AST nodes](https://eslint.org/docs/latest/extend/selectors). (_Read the [main rules overview](#main-rules-overview) and [configuration](#configuration) chapters for better comprehension_)
By default, __the plugin works by checking `import` statements, but it is also able to analyze exports, dynamic imports, and can be configured to check any other [AST nodes](https://eslint.org/docs/latest/extend/selectors)__. (_Read the [main rules overview](#main-rules-overview) and [configuration](#configuration) chapters for better comprehension_)

## Table of Contents

Expand Down Expand Up @@ -66,7 +66,7 @@ Activate the plugin and one of the canned configs in your `.eslintrc.(yml|json|j

All of the plugin rules need to be able to identify the elements in the project, so, first of all you have to define your project element types by using the `boundaries/elements` setting.

The plugin will use the provided patterns to identify each file as one of the element types. It will also assign a type to each dependency detected in the [dependency nodes (`import` or other statements)](#boundariesdependency-nodes), and will check if the relationship between the dependent element and the dependency is allowed or not.
The plugin will use the provided patterns to identify each file as one of the element types. It will also assign a type to each dependency detected in the [dependency nodes (`import` or other statements)](#boundariesdependency-nodes), and it will check if the relationship between the dependent element and the dependency is allowed or not.

```json
{
Expand Down

0 comments on commit b52107e

Please sign in to comment.