Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codehex/ref-restrict
Allows you to restrict what references can be added to projects in Visual Studio
https://github.com/codehex/ref-restrict
Last synced: about 14 hours ago
JSON representation
Allows you to restrict what references can be added to projects in Visual Studio
- Host: GitHub
- URL: https://github.com/codehex/ref-restrict
- Owner: CodeHex
- License: mit
- Created: 2014-08-30T09:06:24.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-02-22T18:22:31.000Z (over 5 years ago)
- Last Synced: 2024-10-03T09:06:42.664Z (about 1 month ago)
- Language: C#
- Size: 676 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ref-Restrict
============
Allows you to restrict what references can be added to projects in Visual Studio. See my blog post [here](http://www.benibinson.com/blog/2014/8/31/restrict-project-references-with-ref-restrict) on how Ref-Restrict can help you maintain a clean project structure.
Installation guide
------------------
The easiest way to install Ref-Restrict is to use the Nuget package which can be found [here](https://www.nuget.org/packages/RefRestrict/). Installing the nuget the package to a project will do the following...
- Ensures that the `RefRestrict.exe` is copied into the solution folder.
- If this is the first project the package is installed to, it will create a blank `RefRestrict.config.xml` config file in the solution folder.
- Ensures that there is a reference to the `RefRestrict.config.xml` config file in the `Solution Items` folder available in the solution of the project.
- Adds an empty `` node to the config file ready to add your custom restrictions.
- Adds an addition pre-build step for the project which will check your custom restrictions and stop the build if any of them are violated.
Using Ref-Restrict Manually
---------------------------
The reference checks can be execute manually by running the RefRestrict binary in the command line for an individual project. Any violations will be reported to the console
```bash
RefRestrict.exe RefRestrict.config.xml YourProjectFile.csproj
```
Configuring Ref-Restrict for your Project
---------------------------------------------
The reference restrictions are defined in the `RefRestrict.config.xml` config file. There is one config file for all the projects in your solution and should be located in the Solution Folder.
```xml
```
Ref Restrict Rules
------------------
**No local references** - Check that the project has no references to any other projects in the solution.
```xml
```
**Only local references** - Check that the project only references the specified projects, and no other projects in the solutions.
```xml
Project A
Project B
```
**Include** - The project **must** include the specified reference
```xml
System.Threading
```
**Exclude** - The project **must not** include the specified reference
```xml
System.Timer
```
Configuration Examples
----------------------
Imagine a Visual studio solution containing the following projects, which are used for a Calculator app.
- **CalcGraphics** - A graphics driver used to render the calculator graphics
- **CalcMaths** - A low level custom maths library used to perform some of the calculator operations and graphics calculations
- **CalcUI** - Contains the UI for the application
The following restrictions need to be applied
- The graphics driver should only reference the maths library and not the UI project. It should also be the only project that uses the Graphics.API third party library
- The maths library must not be referenced by any other projects in the solution (have no local dependacies so it can be used in other solutions).
- The UI project must include the graphics driver to render the UI, but may or may not reference maths library.
This config file will ensure these restrictions are enforced every time the projects are built.
```xml
CalcMaths
Graphics.API
Graphics.API
CalcGraphics
Graphics.API
```
For a more advanced example and to see how the restriction violations are displayed in Visual Studio, please download the RefRestrictDemo solution.