Skip to content

Update readme with correct file name + intendations #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olstakh merged 2 commits into from
Sep 21, 2025
Merged

Update readme with correct file name + intendations #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f97e24c
Indentation and file name
olstakh Sep 20, 2025
37d8f8e
update info about package dependencies
olstakh Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 51 additions & 49 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,38 +33,40 @@ Schema of the rules file is as follows:
```json
{
"ProjectDependencies": [
{
"From": "",
"To": "",
"Policy": "",
"LinkType": "",
"Description": "",
"Exceptions": [
{
"From": "",
"To": "",
"Justification": ""
},
// ...
]
},
{
"From": "",
"To": "",
"Policy": "",
"LinkType": "",
"Description": "",
"Exceptions": [
{
"From": "",
"To": "",
"Justification": ""
},
// ...
]
},
// ...
]
"PackageDependencies": [
{
"From": "",
"To": "",
"Policy": "",
// "LinkType": "", Only direct package references are analyzed, so LinkType is not needed in this section
"Description": "",
"Exceptions": [
{
"From": "",
"To": "",
"Justification": ""
},
// ...
]
},
// ...
{
"From": "",
"To": "",
"Policy": "",
// "LinkType": "", Only direct package references are analyzed, so LinkType is not needed in this section
"Description": "",
"Exceptions": [
{
"From": "",
"To": "",
"Justification": ""
},
// ...
]
},
// ...
]
}
```
Expand All @@ -80,12 +82,12 @@ Top `ProjectDependencies` object will contain a list of rules to validate agains
Top `PackageDependences` object will have the same format as `ProjectDependencies` with `LinkType` omitted, since only direct package references will be considered. Also, `Description` section will be part of `RP0005` warning (as opposed to `RP0004`)

## Matching logic
Each reference between the projects during the build is evaluated against provided list of policies. First each pair of dependent projects is evaluated against `From` and `To` patterns, based on their full path. If the match is successful - their link type is evaluated: if current pair has a direct dependency on each other and `LinkType` value is `Direct` or `DirectOrTransient` - the match is successful, otherwise (the dependency is transient) - `LinkType` should be `Transient` or `DirectOrTransient` for the match to be successful. Then we exceptions are evaluated using the same pattern matching logic with `From` and `To` fields.
Each reference between the projects / packages during the build is evaluated against provided list of policies. First each pair of dependencies is evaluated against `From` and `To` patterns, based on their full path. For project dependencies - if the match is successful - their link type is evaluated: if current pair has a direct dependency on each other and `LinkType` value is `Direct` or `DirectOrTransient` - the match is successful, otherwise (the dependency is transient) - `LinkType` should be `Transient` or `DirectOrTransient` for the match to be successful. Package dependencies are only viewed as direct references. Then the exceptions are evaluated using the same pattern matching logic with `From` and `To` fields.
The decision logic is as follows
- If current `Policy` value is `Forbidden` - the rule is considered violated if no exceptions were matched
- If current `Policy` value is `Allowed` - the rule is considered violated if there are any matched exceptions

Violations of the rule will produce `RT0004` warning during build.
Violations of the rule will produce `RP0004` (for projects) and `RP0005` (for packages) warning during build.

Note: in regex matches - `*` is substituted with `.*` for proper regex, and `$` is added at the end.
```
Expand All @@ -106,21 +108,21 @@ Below are few examples of potential rules
"from": "*\\Infrastructure\\*",
"to": "*",
"exceptions": [
{
"from": "*\\Infrastructure\\*",
"to": "*\\Infrastructure\\*",
"justification": "Infrastructure projects can reference each other"
},
{
"from": "*Tests.csproj",
"to": "*",
"justification": "tech debt <work item link>"
},
{
"from": "*",
"to": "LegacyDependency.csproj",
"justification": "tech debt <work item link>"
}
{
"from": "*\\Infrastructure\\*",
"to": "*\\Infrastructure\\*",
"justification": "Infrastructure projects can reference each other"
},
{
"from": "*Tests.csproj",
"to": "*",
"justification": "tech debt <work item link>"
},
{
"from": "*",
"to": "LegacyDependency.csproj",
"justification": "tech debt <work item link>"
}
]
},
```
Expand Down Expand Up @@ -155,7 +157,7 @@ Below are few examples of potential rules
```

## How it works
First - MSBuild task with gather all direct / indirect project references and dump them into a file (typically in `obj/Debug/` folder), named `references.tsv` (inspired by [ReferenceTrimmer](https://github.com/dfederm/ReferenceTrimmer) implementation). During the second stage - Roslyn analyzer will read this file and match it against the dependency rules, defined in a file from `<DependencyRulesFile>` property. Corresponding diagnostics will be produced if violations are found.
First - MSBuild task with gather all direct / indirect project references and dump them into a file (typically in `obj/Debug/` folder), named `_ReferenceProtector_DeclaredReferences.tsv` (inspired by [ReferenceTrimmer](https://github.com/dfederm/ReferenceTrimmer) implementation). During the second stage - Roslyn analyzer will read this file and match it against the dependency rules, defined in a file from `<DependencyRulesFile>` property. Corresponding diagnostics will be produced if violations are found.

## How to disable
Easiest way is to set `EnableReferenceProtector` variable to false (either in command line or in a project file, like `<EnableReferenceProtector>false</EnableReferenceProtector>`)
Loading