Skip to content

Commit 97dfe0f

Browse files
authored
Update README.md
1 parent 9062afb commit 97dfe0f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ NetArchTest.eNhancedEdition is based on [NetArchTest v1.3.2](https://github.com/
99

1010
### Rationale
1111

12-
NetArchTest is well established mature library, but in order to push things forward, a few breaking changes had to be made, and that is how **eNhancedEdition** was born. eNhancedEdition uses almost identical Fluent API as a base library, but it is not 100% backward compatible, and it will never be.
12+
NetArchTest is a well-established mature library, but to push things forward, a few breaking changes had to be made, and that is how **eNhancedEdition** was born. eNhancedEdition uses almost identical Fluent API as a base library, but it is not 100% backwards compatible, and it will never be.
1313

1414
What **eNhancedEdition** has to offer, that is not available in the NetArchTest v1.3.2:
15-
- fixed all know bugs present in v1.3.2 :
15+
- fixed all known bugs present in v1.3.2 :
1616
- BenMorris/NetArchTest#98,
1717
- BenMorris/NetArchTest#101,
1818
- BenMorris/NetArchTest#120,
@@ -30,7 +30,7 @@ What **eNhancedEdition** has to offer, that is not available in the NetArchTest
3030
- BenMorris/NetArchTest#126 - added rules for structs, enums and delegates
3131
- BenMorris/NetArchTest#131 - added rules for all access modifiers: public, internal, private, protected, private protected, protected internal
3232
- BenMorris/NetArchTest#133 - added rules: AreInheritedByAnyType, AreNotInheritedByAnyType
33-
- added rules : AreUsedByAny, AreNotUsedByAny
33+
- added rules: AreUsedByAny, AreNotUsedByAny
3434
- at the end, you get more information which should make reasoning about tests easier:
3535

3636

@@ -143,14 +143,14 @@ Once you have loaded the types, you can filter them using one or more predicates
143143
```csharp
144144
types.That().ResideInNamespace("MyProject.Data");
145145
```
146-
Once the set of types have been filtered, you can apply a set of conditions using the `Should()` or `ShouldNot()` methods, e.g.
146+
Once the set of types has been filtered, you can apply a set of conditions using the `Should()` or `ShouldNot()` methods, e.g.
147147
```csharp
148148
types.That().ResideInNamespace("MyProject.Data").Should().BeSealed();
149149
```
150150
Finally, you obtain a result from the rule by using an executor, i.e. use `GetTypes()` to return the types that match the rule or `GetResult()` to determine whether the rule has been met.
151151

152152
Note that `GetResult()` returns [`TestResult`](documentation/api.md#testresult) which contains a few lists of types:
153-
- `LoadedTypes` - all types loded by [`Types`](documentation/api.md#types)
153+
- `LoadedTypes` - all types loaded by [`Types`](documentation/api.md#types)
154154
- `SelectedTypesForTesting` - types that passed [predicates](documentation/api.md#predicate)
155155
- `FailingTypes`- types that failed to meet the [conditions](documentation/api.md#condition)
156156

@@ -190,7 +190,7 @@ Dependency matrix:
190190
| 2N | [NotHaveDependencyOnAll(D1, D2)](documentation/api.md#conditionnothavedependencyonall) | not all | yes | a, b, c, d, e, f | g, h |
191191
| 3N | [HaveDependencyOtherThan(D1, D2)](documentation/api.md#conditionhavedependencyotherthan) | >=0 | yes | b, d, f, h, | a, c, e, g |
192192

193-
Explnation why a type fails dependecy search test is available on the failing type: [IType.Explanation](documentation/api.md#itypeexplanation)
193+
An explanation of why a type fails the dependency search test is available on the failing type: [IType.Explanation](documentation/api.md#itypeexplanation)
194194

195195

196196
#### Reverse dependency search
@@ -249,14 +249,14 @@ var result = Types.InAssembly(typeof(ExampleDependency).Assembly)
249249

250250
There is only one way, at least for now, to divide types into slices `ByNamespacePrefix(string prefix)` and it works as follows:
251251

252-
1) Selects types which namespace starts with a given prefix, rest of the types are ignored.
252+
1) Select types which namespace starts with a given prefix, rest of the types are ignored.
253253
2) Slices are defined by the first part of the namespace that comes right after the prefix:
254254
`namespacePrefix.(sliceName).restOfNamespace`
255-
3) Types with the same `sliceName` part will be placed in the same slice. If `sliceName` is empty for a given type, the type will be also ignored (`BaseFeature` class from folowing image)
255+
3) Types with the same `sliceName` part will be placed in the same slice. If `sliceName` is empty for a given type, the type will also be ignored (`BaseFeature` class from the following image)
256256

257257
![Slices](https://raw.githubusercontent.com/NeVeSpl/NetArchTest.eNhancedEdition/main/documentation/slices/slices.png)
258258

259-
When we already have our types divided into slices, we can apply condition: `NotHaveDependenciesBetweenSlices()`. As the name suggest it detects if any dependency exists between slices. Dependency from slice to type that is not part of any other slice is allowed.
259+
When our types are divided into slices, we can apply the condition: `NotHaveDependenciesBetweenSlices()`. As the name suggests it detects if any dependency exists between slices. Dependency from slice to type that is not part of any other slice is allowed.
260260

261261
passing | failing
262262
--|---
@@ -302,6 +302,6 @@ Available options:
302302

303303
## Limitations
304304

305-
NetArchTest is build on top of [jbevain/cecil](https://github.com/jbevain/cecil) thus it works on CLI level. Unfortunately not every feature of C# language is represented in CLI, thus some things will never be available in NetArchTest, e.g.:
305+
NetArchTest is built on top of [jbevain/cecil](https://github.com/jbevain/cecil) thus it works on CIL level. Unfortunately, not every feature of C# language is represented in CIL, thus some things will never be available in NetArchTest, e.g.:
306306
- BenMorris/NetArchTest#81 - NetArchTest ignores a nameof expression
307307

0 commit comments

Comments
 (0)