https://github.com/verticalsoftware/vertical-csdependencies
Project that outputs CSharp projects in dependency order
https://github.com/verticalsoftware/vertical-csdependencies
Last synced: over 1 year ago
JSON representation
Project that outputs CSharp projects in dependency order
- Host: GitHub
- URL: https://github.com/verticalsoftware/vertical-csdependencies
- Owner: verticalsoftware
- License: mit
- Created: 2019-11-29T19:12:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-30T22:23:49.000Z (over 6 years ago)
- Last Synced: 2025-03-08T21:40:03.093Z (over 1 year ago)
- Language: C#
- Size: 368 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# vertical-csdependencies
[](https://dev.azure.com/vertical-software/vertical-csdependencies/_build/latest?definitionId=3&branchName=master)
Finds all C# projects in a directory, and displays them in dependency order.
## Installation
```
dotnet tool install -g vertical-csdependencies
```
## Quick Start
Given you are positioned in the root of a multi-project directory, and your sources are in a folder called 'src', the following example lists the full paths to each project in *dependency* order.
```
$ csdeps ./src
```
## Use Case
This tool was designed to aggregate projects that have relationships with each other via package references (not P2P references), and display them in the order in which they should be built, given one is a dependency of another.
For example, say we have the following project structure:
/src/vertical.core/vertical.core.csproj:
```xml
true
vertical.core
```
/src/vertical.logging.abstractions/vertical.logging.abstractions.csproj:
```xml
true
vertical.logging.abstractions
```
/src/vertical.diagostics.abstractions/vertical.diagnostics.abstractions.csproj:
```xml
true
vertical.diagnostics.abstractions
```
/src/vertical.diagostics/vertical.diagnostics.csproj:
```xml
true
vertical.diagnostics
```
If we ran the utility and pointed it at `/src`, we would see the following output:
```
$ csdeps ./src
/src/vertical.core/vertical.core.csproj
/src/vertical.logging.abstractions/vertical.logging.abstractions.csproj
/src/vertical.diagostics.abstractions/vertical.diagnostics.abstractions.csproj
/src/vertical.diagostics/vertical.diagnostics.csproj
```
We could take this output and feed it to a build script...
```PS
foreach ($project in (& csdeps .\src)) {
dotnet pack $project -c Release
}
```
## Particulars
### How dependency names are resolved
The utility resolves package identifiers using the following order of precedence:
1. element text within the element
2. element text within the element
3. Project name - which is the name of project file excluding the extension
### Command line usage
```
$ csdeps [OPTIONS]
```
#### Arguments
path - One or more source directories to look for project files. Paths are rooted to the current working directory
#### Options
--debug - Display diagnostic information
-h, --help - Displays the help file
-i, --include <pattern> - A glob pattern that matches the files to include. Defaults to **/*.csproj is not specified.
-o, --output <option> - Specifies which nomenclature of the project should be used in the output. Choices are: assemblyName, directory, fileName, projectFile, projectName
--tree - Display the output as a tree
-x, --exclude <pattern> - One or more glob patterns used to match files that should be excluded from aggregation.
## Contributing
Yes! Help from the community is highly appreciated. Please [create an issue](https://github.com/verticalsoftware/vertical-csdependencies/issues/new) though so we can discuss the bug or feature.