new api

Author: daningalla

.github/workflows/dev-release.yml .github/workflows/dev-build.yml.github/workflows/dev-release.yml renamed to .github/workflows/dev-build.yml

@@ -1,4 +1,4 @@
-name: Dev release
+name: Dev build
 
 on:
   push:
@@ -24,11 +24,7 @@ jobs:
         run: dotnet test --no-restore --collect:"XPlat Code Coverage"
       - name: Set build label
         run: echo "DEVLABEL=$(date +'%Y%m%d')" >> $GITHUB_ENV
-      - name: Build analyzers
-        run: dotnet build src/analyzers/ -c Release --no-restore -o analyzers        
       - name: Build source generator
-        run: dotnet build src/source-generator/ -c Release --no-restore -o analyzers
+        run: dotnet build src/generator/ -c Release --no-restore -o analyzers
       - name: Pack core library
-        run: dotnet pack src/lib -c Release --no-restore -p:VersionSuffix=dev.${{ env.DEVLABEL }}.${{ github.run_number }} -o ./pack
-      - name: Publish packages to NuGet
-        run: dotnet nuget push ./pack/*[^.symbols].nupkg -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_ORG_PUSH_KEY }}
+        run: dotnet build src/lib -c Release --no-restore

.gitignore

@@ -402,7 +402,7 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
-.idea
+.idea/
 
 ##
 ## Visual studio for Mac
@@ -426,7 +426,7 @@ test-results/
 *.dmg
 *.app
 
-# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
+# content below from: https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
 # General
 .DS_Store
 .AppleDouble
@@ -455,7 +455,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore
+# content below from: https://github.com/github/gitignore/blob/main/Global/Windows.gitignore
 # Windows thumbnail cache files
 Thumbs.db
 ehthumbs.db
@@ -482,6 +482,3 @@ $RECYCLE.BIN/
 
 # Vim temporary swap files
 *.swp
-
-# Verify artifacts
-*.received.*

LICENSE

@@ -17,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

README.md

@@ -1,65 +1,30 @@
 # vertical-cli
 
-Minimal, AOT friendly command line arguments parser.
+Fully featured command line argument parsing library.
 
-## Quick start
-
-### Install
-
-```shell
-dotnet add package vertical-cli --prerelease
-```
-### Configure and run
-
-```csharp
-// Define a model
-public record ZipOptions(FileInfo Source, FileInfo Destination, bool Overwrite);
-
-// Build an application with two commands
-var app = new CliApplicationBuilder("gzip")
-    .RouteAsync<ZipOptions>("gzip create", async (model, cancelToken) => {
-        if (model.Destination.Exists && !model.Overwrite){
-            Console.WriteLine("Target file already exists");
-            return -1;
-        }
-        await using var inputStream = File.OpenRead(model.Source);
-        await using var outputStream = File.OpenWrite(model.Destination);
-        await using var zipStream = new GZipStream(outputStream, CompressionMode.Compress);
-        await inputStream.CopyToAsync(zipStream, cancelToken);
+## Features
 
-        Console.WriteLine($"Compressed file {model.Destination} created.");
-    })
-    .RouteAsync<ZipOptions>("gzip extract", async (model, cancelToken) => {
-        if (model.Destination.Exists && !model.Overwrite){
-            Console.WriteLine("Target file already exists");
-            return -1;
-        }
-        await using var inputStream = File.OpenRead(model.Source);
-        await using var outputStream = File.OpenWrite(model.Destination);
-        await using var zipStream = new GZipStream(inputStream, CompressionMode.Decompress);
-        await zipStream.CopyToAsync(outputStream, cancelToken);
+- Built for complex CLI applications
+- Converts string arguments to types
+- Supports command hierachies
+- Binds arguments to any `IParsable<T>` and their `Nullable<T>` compliments, enums, strings, collections, and more
+- Leverages a source generator for a reflection free, AOT-trimmable application
+- Integrates a fully customizable help system
+- Supports response files and directives
+- Extensible with other add-ons
 
-        Console.WriteLine($"File {model.Source} extracted.");
-    })
-    .MapModel<ZipOptions>(map => map
-        .Argument(x => x.Source)
-        .Argument(x => x.Destination)
-        .Switch(x => x.Overwrite, ["--overwrite"]))
-    .Build();
+## Installation
 
-await app.InvokeAsync(args);
+Add the package to your application
 
-// Run:
-// $ gzip picture.png picture.gz --overwrite
+```bash
+> dotnet add package vertical-cli --prerelease
 ```
 
-## Features
+## Documentation
 
-- Binds command line arguments to strongly typed models
-- Configure positional arguments. options and switches using short and long form notations
-- Define a hierarchy of commands each with derived models
-- Uses a source generator to bind models removing the need for reflection (AOT friendly)
-- Uses analyzers to provide wranings and errors for common misconfiguration issues
-- Display generated help content
+- [Conceptual overview](https://github.com/verticalsoftware/vertical-cli/blob/main/docs/home.md)
+- [Configuration](https://github.com/verticalsoftware/vertical-cli/blob/main/docs/symbols.md)
+- [Advanced concepts](https://github.com/verticalsoftware/vertical-cli/blob/main/docs/models.md)
+- [Middleware](https://github.com/verticalsoftware/vertical-cli/blob/main/docs/middleware.md)
 
-See full [docs](https://github.com/verticalsoftware/vertical-cli/blob/main/assets/docs.md).