xtofs.editorconfig 1.0.0

xtofs.editorconfig

A source code only NuGet package that installs an .editorconfig file with C# coding standards to your project.

Installation

Install via NuGet:

dotnet add package xtofs.editorconfig

Or via NuGet Package Manager:

Install-Package xtofs.editorconfig

Usage

Once installed, the .editorconfig file will be placed in the root of your project. This file defines coding standards for C# files in your solution.

Configuration

The .editorconfig file includes settings for:

• Code formatting (indentation, spacing, line breaks)
• Naming conventions (PascalCase, camelCase, interfaces, etc.)
• C# language preferences (var usage, pattern matching, expressions)
• Analyzer rules and severity levels

You can override these settings by creating an .editorconfig file in your project directory with the settings you prefer.

Deployment

Deploy to NuGet as a Private Package

To publish this package to a private NuGet feed:

1. Build the Package

dotnet pack -c Release

The .nupkg file will be generated in bin/Release/.

2. Set Up NuGet Credentials

Configure your NuGet source with credentials. Edit or create ~/.nuget/NuGet/NuGet.Config:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="MyPrivateFeed" value="https://your-nuget-server.com/api/v2" />
  </packageSources>
  <packageSourceCredentials>
    <MyPrivateFeed>
      <add key="Username" value="your-username" />
      <add key="ClearTextPassword" value="your-api-key" />
    </MyPrivateFeed>
  </packageSourceCredentials>
</configuration>

Or use your API key directly:

dotnet nuget add source "https://your-nuget-server.com/api/v2" -n MyPrivateFeed -u username -p your-api-key

3. Push the Package

dotnet nuget push bin/Release/xtofs.editorconfig.1.0.0.nupkg --source MyPrivateFeed --api-key your-api-key

4. Consume from Your Private Feed

In the consuming project, add the package source to your NuGet configuration or specify it directly:

dotnet add package xtofs.editorconfig --source MyPrivateFeed

Using GitHub Packages

If hosting on GitHub:

1. Create a Personal Access Token (PAT) with write:packages scope
2. Configure the source:

dotnet nuget add source "https://nuget.pkg.github.com/yourusername/index.json" -n github -u yourusername -p YOUR_PAT

3. Push the package:

dotnet nuget push bin/Release/xtofs.editorconfig.1.0.0.nupkg --source github

License

MIT License