Skip to content

Commit

Permalink
Change name
Browse files Browse the repository at this point in the history
  • Loading branch information
pisolofin committed Aug 1, 2024
1 parent 2048ba4 commit 453601f
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 43 deletions.
2 changes: 1 addition & 1 deletion Nuget/Build.props
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Project>
<PropertyGroup>
<Version>0.0.6</Version>
<Version>0.0.2</Version>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryUrl>https://github.com/pisolofin/csharpier-editorconfig</RepositoryUrl>
<RepositoryType>git</RepositoryType>
Expand Down
47 changes: 10 additions & 37 deletions Nuget/README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,21 @@
CSharpier is an opinionated code formatter for c#. It uses Roslyn to parse your code and re-prints it using its own rules.
The printing process was ported from [prettier](https://github.com/prettier/prettier) but has evolved over time.

CSharpier provides a few basic options that affect formatting and has no plans to add more. It follows the [Option Philosophy](https://prettier.io/docs/en/option-philosophy.html) of prettier.
This is as non opinionated version of [csharpier](https://github.com/belav/csharpier) tool created to add EditorConfig file style guide, allowing users to define and apply custom styling options.

### Quick Start
Install CSharpier globally using the following command.
Install CSharpier-Config globally using the following command.
```bash
dotnet tool install csharpier -g
dotnet tool install csharpier-config -g
```
Then format the contents of a directory and its children with the following command.
```bash
dotnet csharpier .
dotnet csharpier-config .
```

CSharpier can also format [on save in your editor](https://csharpier.com/docs/Editors), as a [pre-commit hook](https://csharpier.com/docs/Pre-commit), as [part of your build](https://csharpier.com/docs/MSBuild) or even [programatically](https://csharpier.com/docs/API). Then you can ensure code was formatted with a [CI/CD tool](https://csharpier.com/docs/ContinuousIntegration).

---

[Read the documentation](https://csharpier.com)
**This is a work in progress project**

[Try it out](https://playground.csharpier.com)
In this branch, I will set up the project with new references in the documentation, as well as handle the deployment and naming of the executable program.

---
All documentation that you find about csharpier is also valid for csharpier-config, you have only to change command like
All documentation you find about `CSharpier` is also valid for `CSharpier-Config`. You only need to adjust the commands accordingly.

### Before
```c#
public class ClassName {
public void CallMethod() {
this.LongUglyMethod("1234567890", "abcdefghijklmnopqrstuvwxyz", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
}
}
```

### After
```c#
public class ClassName
{
public void CallMethod()
{
this.LongUglyMethod(
"1234567890",
"abcdefghijklmnopqrstuvwxyz",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
);
}
}
```
- `dotnet csharpier` -> `dotnet csharpier-config`
- `dotnet-csharpier` -> `dotnet-csharpier-config`
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

# csharpier-config

This is as non opinionated version of [csharpier](https://github.com/belav/csharpier) tool created to add EditorConfig file style guide,
allowing users to define and apply custom styling options.
This is as non opinionated version of [csharpier](https://github.com/belav/csharpier) tool created to add EditorConfig file style guide, allowing users to define and apply custom styling options.

I started implementing these options in a separate branch called [feature/brackets](https://github.com/pisolofin/csharpier-editorconfig/tree/feature/brackets).

Expand Down
2 changes: 1 addition & 1 deletion Src/CSharpier.Cli/CSharpier.Cli.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<Import Project="../../Nuget/Build.props" />
<PropertyGroup>
<OutputType>Exe</OutputType>
<PackageId>CSharpierConfig</PackageId>
<PackageId>CSharpier-Config</PackageId>
<AssemblyName>dotnet-csharpier-config</AssemblyName>
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
<PackAsTool>true</PackAsTool>
Expand Down
2 changes: 1 addition & 1 deletion Src/CSharpier.MsBuild/CSharpier.MsBuild.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<Import Project="../../Nuget/Build.props"/>
<PropertyGroup>
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
<PackageId>CSharpierConfig.MsBuild</PackageId>
<PackageId>CSharpier-Config.MsBuild</PackageId>
<DevelopmentDependency>true</DevelopmentDependency>
<CSharpierOutputDir>../CSharpier.Cli/bin/$(Configuration)/$(TargetFramework)</CSharpierOutputDir>
</PropertyGroup>
Expand Down
2 changes: 1 addition & 1 deletion Src/CSharpier/CSharpier.csproj
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">
<Import Project="../../Nuget/Build.props" />
<PropertyGroup>
<PackageId>CSharpierConfig.Core</PackageId>
<PackageId>CSharpier-Config.Core</PackageId>
<TargetFrameworks>net6.0;net7.0;net8.0;netstandard2.0</TargetFrameworks>
<RootNamespace>CSharpier</RootNamespace>
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
Expand Down

0 comments on commit 453601f

Please sign in to comment.