-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
180 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,38 @@ | ||
# FlashOWare.Tool | ||
A .NET tool that facilitates development workflows. | ||
|
||
![Icon-Light](https://raw.githubusercontent.com/FlashOWare/FlashOWare.Tool/docs/add-documentation/resources/FlashOWare.Tool-Light.png#gh-light-mode-only)![Icon-Dark](https://raw.githubusercontent.com/FlashOWare/FlashOWare.Tool/docs/add-documentation/resources/FlashOWare.Tool-Dark.png#gh-dark-mode-only) | ||
![Icon-Light](https://raw.githubusercontent.com/FlashOWare/FlashOWare.Tool/main/resources/FlashOWare.Tool-Light.png#gh-light-mode-only)![Icon-Dark](https://raw.githubusercontent.com/FlashOWare/FlashOWare.Tool/main/resources/FlashOWare.Tool-Dark.png#gh-dark-mode-only) | ||
|
||
## NuGet package | ||
[FlashOWare.Tool](https://www.nuget.org/packages/FlashOWare.Tool) | ||
|
||
## Installation | ||
Install the latest pre-release version as a global tool | ||
```console | ||
dotnet tool install --global FlashOWare.Tool --prerelease | ||
``` | ||
|
||
## Compatibility | ||
- requires the [.NET 6.0](https://dotnet.microsoft.com/download/dotnet/6.0) SDK | ||
- supports the [.NET 7.0](https://dotnet.microsoft.com/download/dotnet/7.0) SDK | ||
|
||
## Documentation | ||
[Index.md](./docs/Index.md) | ||
|
||
## Changelogs | ||
- [Release Changelog](./docs/CHANGELOG.md) | ||
- [Prerelease Changelog](./docs/CHANGELOG-Prerelease.md) | ||
|
||
## Dependencies | ||
### Runtime dependencies (tool) | ||
- [.NET](https://github.com/dotnet/runtime) | ||
- [Microsoft.Build.Locator](https://github.com/microsoft/MSBuildLocator) | ||
- [Roslyn](https://github.com/dotnet/roslyn) | ||
- [System.CommandLine](https://github.com/dotnet/command-line-api) | ||
### Development dependencies (build and test) | ||
- [Basic.Reference.Assemblies](https://github.com/jaredpar/basic-reference-assemblies) | ||
- [Coverlet](https://github.com/coverlet-coverage/coverlet) | ||
- [DiffPlex](https://github.com/mmanela/diffplex) | ||
- [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) | ||
- [NUKE](https://nuke.build) | ||
- [xUnit.net](https://xunit.net) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,16 @@ | ||
# FlashOWare.Tool | ||
Documentation | ||
|
||
## Documentation | ||
TODO | ||
## Commands | ||
- [flashoware](./commands/flashoware.md) | ||
- [flashoware using](./commands/flashoware-using.md) | ||
- [flashoware using count](./commands/flashoware-using-count.md) | ||
- [flashoware using globalize](./commands/flashoware-using-globalize.md) | ||
|
||
## Changelogs | ||
- [Release Changelog](./CHANGELOG.md) | ||
- [Prerelease Changelog](./CHANGELOG-Prerelease.md) | ||
|
||
## Compatibility | ||
- requires the [.NET 6.0](https://dotnet.microsoft.com/download/dotnet/6.0) SDK | ||
- supports the [.NET 7.0](https://dotnet.microsoft.com/download/dotnet/7.0) SDK |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# flashoware using count | ||
|
||
Available since [v1.0.0]. | ||
|
||
## Synopsis | ||
```console | ||
flashoware using count [<USINGS>...] [--proj|--project <project>] | ||
|
||
flashoware using count -?|-h|--help | ||
``` | ||
|
||
## Description | ||
|
||
Count and list the top-level using directives of a C# project. | ||
|
||
## Arguments | ||
|
||
`<USINGS>` | ||
The names of the top-level using directives to count. If usings are not specified, the command will list all top-level directives. | ||
|
||
## Options | ||
|
||
- `--proj|--project <project>` | ||
The path to the project file to operate on (defaults to the current directory if there is only one project). | ||
|
||
- `-?|-h|--help` | ||
Show help and usage information. | ||
|
||
[v1.0.0]: ../CHANGELOG.md#vNext |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# flashoware using globalize | ||
|
||
Available since [v1.0.0]. | ||
|
||
## Synopsis | ||
```console | ||
flashoware using globalize [<USINGS>...] [--proj|--project <project>] [--force] | ||
|
||
flashoware using globalize -?|-h|--help | ||
``` | ||
|
||
## Description | ||
|
||
Move top-level using directives to global using directives in a C# project. | ||
|
||
## Arguments | ||
|
||
`<USINGS>` | ||
The names of the top-level using directives to convert to global using directives. If usings are not specified, the command will globalize all top-level directives. | ||
|
||
## Options | ||
|
||
- `--proj|--project <project>` | ||
The path to the project file to operate on (defaults to the current directory if there is only one project). | ||
|
||
- `--force` | ||
Forces all top-level using directives to be globalized when no usings are specified. | ||
|
||
- `-?|-h|--help` | ||
Show help and usage information. | ||
|
||
[v1.0.0]: ../CHANGELOG.md#vNext |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# flashoware using | ||
|
||
Available since [v1.0.0]. | ||
|
||
## Synopsis | ||
```console | ||
flashoware using <COMMAND> [-?|-h|--help] | ||
|
||
flashoware using -?|-h|--help | ||
``` | ||
|
||
## Description | ||
|
||
Analyze or refactor C# using directives. | ||
|
||
## Options | ||
|
||
- `-?|-h|--help` | ||
Show help and usage information. | ||
|
||
## Commands | ||
|
||
| Command | Description | | ||
| --- | --- | | ||
| [flashoware using count](./flashoware-using-count.md) | Count and list the top-level using directives of a C# project. | | ||
| [flashoware using globalize](./flashoware-using-globalize.md) | Move top-level using directives to global using directives in a C# project. | | ||
|
||
[v1.0.0]: ../CHANGELOG.md#vNext |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# flashoware | ||
|
||
Available since [v1.0.0]. | ||
|
||
## Synopsis | ||
```console | ||
flashoware <COMMAND> [-?|-h|--help] | ||
|
||
flashoware [-!|-a|--about] [-#|-i|--info] [--version] | ||
|
||
flashoware -?|-h|--help | ||
``` | ||
|
||
## Description | ||
|
||
The tool's command name. | ||
|
||
## Options | ||
|
||
- `-!|-a|--about` | ||
Show application information. | ||
|
||
- `-#|-i|--info` | ||
Show environment information. | ||
|
||
- `--version` | ||
Show version information. | ||
|
||
- `-?|-h|--help` | ||
Show help and usage information. | ||
|
||
## Commands | ||
|
||
| Command | Description | | ||
| --- | --- | | ||
| [flashoware using](./flashoware-using.md) | Analyze or refactor C# using directives. | | ||
|
||
[v1.0.0]: ../CHANGELOG.md#vNext |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,10 @@ | ||
# About | ||
A .NET tool that facilitates development workflows. | ||
|
||
![Icon](https://raw.githubusercontent.com/FlashOWare/FlashOWare.Tool/main/resources/FlashOWare.Tool-Light.png) | ||
|
||
## Commands | ||
- [flashoware](https://github.com/FlashOWare/FlashOWare.Tool/blob/main/docs/commands/flashoware.md) | ||
- [flashoware using](https://github.com/FlashOWare/FlashOWare.Tool/blob/main/docs/commands/flashoware-using.md) | ||
- [flashoware using count](https://github.com/FlashOWare/FlashOWare.Tool/blob/main/docs/commands/flashoware-using-count.md) | ||
- [flashoware using globalize](https://github.com/FlashOWare/FlashOWare.Tool/blob/main/docs/commands/flashoware-using-globalize.md) |