DressSharp.win-x64 0.1.0

DressSharp

DressSharp is a syntax-only, explicitly configured C# formatter distributed as one .NET tool package.

Install

dotnet tool install --global DressSharp
dotnet dress --version

For a repository-pinned install:

dotnet new tool-manifest
dotnet tool install DressSharp

Hooks

--staged and --changed select only the files Git reports as changed, so a hook formats what was touched instead of the repository. A pre-commit hook is one line; format --staged stages what it rewrites:

dotnet dress format --staged

For a hook that runs after an editor or agent writes, format everything changed since the last commit:

dotnet dress format --changed

Both require a repository-pinned or global install of the current version. This repository's .claude/settings.json and .codex/hooks.json run the second form from Claude Code and Codex after dotnet tool restore.

Development

Build, test, and format DressSharp from the current checkout:

./do test
./do format-self

To test the packed local tool:

dotnet tool restore
./do install-local
dotnet tool run dotnet-dress -- --version

The package installs one command: dotnet dress.

Releasing

./do prepare-release moves the Unreleased notes in CHANGELOG.md under the next version, chosen from their headings, and sets the package version to match. Review and commit the result, then tag it v<version> and push the tag. The Release workflow packs every platform package, publishes them to NuGet with trusted publishing, and creates the GitHub release from the changelog notes.

See Getting started, the command line reference and the compatibility policy.

Documentation site

./do build-docs builds the static site into dist/site with Astro Starlight under Bun. The site in site/ holds the hand-written pages; scripts/build-docs.cs adds a reference for every preference in the built-in rule catalog before each build. Each rule's example is formatted by the real formatter under every accepted value, so the reference cannot drift from the code. After one ./do build-docs, bun run site:dev serves the site with live reload. The Docs workflow publishes the same output to GitHub Pages on every push to master; enable Pages with the "GitHub Actions" source once in the repository settings.

Repository layout

The root package.json is a Bun workspace over DressSharp.Interactive and site, so bun install and bun run work from the root as ./do does.