Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NeVeSpl authored Nov 21, 2023
1 parent 1d92758 commit 1612b4d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,5 +190,24 @@ var result = Types.InCurrentDomain()

## Options

User options allows to configure how NetArchTest engine works.

```csharp
var result = Types.InCurrentDomain()
.That()
.ResideInNamespace("NetArchTest.TestStructure.NameMatching.Namespace3")
.Should()
.HaveNameStartingWith("Some")
.GetResult(Options.Default with { Comparer = StringComparison.Ordinal});

Assert.True(result.IsSuccessful);
```

Available options:
- Comparer - allows to specify how strings will be compared (right now it only affects: Predicate.HaveName, Predicate.HaveNameStartingWith, Predicate.HaveNameEndingWith)


## Limitations

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.:
- BenMorris/NetArchTest#81 - NetArchTest ignores a nameof expression

0 comments on commit 1612b4d

Please sign in to comment.