diff --git a/README.md b/README.md index 68912a5..d83c5cd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # FlashOWare.Tool A .NET tool that facilitates development workflows. + +![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) diff --git a/docs/Index.md b/docs/Index.md index 09bc3d3..e0a9d15 100644 --- a/docs/Index.md +++ b/docs/Index.md @@ -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 diff --git a/docs/commands/flashoware-using-count.md b/docs/commands/flashoware-using-count.md new file mode 100644 index 0000000..5419718 --- /dev/null +++ b/docs/commands/flashoware-using-count.md @@ -0,0 +1,29 @@ +# flashoware using count + +Available since [v1.0.0]. + +## Synopsis +```console +flashoware using count [...] [--proj|--project ] + +flashoware using count -?|-h|--help +``` + +## Description + +Count and list the top-level using directives of a C# project. + +## Arguments + +`` +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 ` +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 diff --git a/docs/commands/flashoware-using-globalize.md b/docs/commands/flashoware-using-globalize.md new file mode 100644 index 0000000..e2b08f6 --- /dev/null +++ b/docs/commands/flashoware-using-globalize.md @@ -0,0 +1,32 @@ +# flashoware using globalize + +Available since [v1.0.0]. + +## Synopsis +```console +flashoware using globalize [...] [--proj|--project ] [--force] + +flashoware using globalize -?|-h|--help +``` + +## Description + +Move top-level using directives to global using directives in a C# project. + +## Arguments + +`` +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 ` +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 diff --git a/docs/commands/flashoware-using.md b/docs/commands/flashoware-using.md new file mode 100644 index 0000000..6b958ec --- /dev/null +++ b/docs/commands/flashoware-using.md @@ -0,0 +1,28 @@ +# flashoware using + +Available since [v1.0.0]. + +## Synopsis +```console +flashoware using [-?|-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 diff --git a/docs/commands/flashoware.md b/docs/commands/flashoware.md new file mode 100644 index 0000000..40b6d5a --- /dev/null +++ b/docs/commands/flashoware.md @@ -0,0 +1,38 @@ +# flashoware + +Available since [v1.0.0]. + +## Synopsis +```console +flashoware [-?|-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 diff --git a/resources/FlashOWare.Tool-Dark.png b/resources/FlashOWare.Tool-Dark.png new file mode 100644 index 0000000..5d6e141 Binary files /dev/null and b/resources/FlashOWare.Tool-Dark.png differ diff --git a/resources/FlashOWare.Tool-Light.png b/resources/FlashOWare.Tool-Light.png new file mode 100644 index 0000000..97f5fdb Binary files /dev/null and b/resources/FlashOWare.Tool-Light.png differ diff --git a/resources/README.md b/resources/README.md index 4382fee..4c400d0 100644 --- a/resources/README.md +++ b/resources/README.md @@ -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)