fossbrandon / dotnet-style Goto Github PK

Create version 1.0.0 of this .NET tool supporting the following features:

• Verify that C# code currently meets coding standards
• Format C# code to meet coding standards

The package needs a bit of character so let's add an icon image to make it easily identifiable. Choose a fun image with "style" in mind.

To better comply with guidelines listed in this guide, we should remove default flag values and instead show the help menu if no flags are specified.

To customize this tool per repo depending on individual or team needs, add configuration file support.

Considerations:

• The CLI tool needs a way of specifying a config file to look at
• The CLI should default to looking for a config file in the current repo

One of the best ways to evaluate a tool such as this is to see it in action. Let's create a sample project with code that intentionally does not comply with the configured style so a user can see the tool in action.

We might as well use the tool we've created on the repo itself!

Add the tool and run it to ensure all code complies with the defined style.

Create a CI pipeline to run during pull requests.

The pipeline should do the following:

• Lint code
• Run tests

To make packing and publishing new versions easier, create a script to automate the process for you.

The current tests are just unit tests of high level CLI functionality. The library could be improved by adding tests that ensure files are actually formatted/validated.