HoneyDrunk.Standards 0.2.9

HoneyDrunk.Standards

Build-transitive standards package enforcing shared conventions, analyzers, and deterministic builds across HoneyDrunk Studios repositories.

📦 What Is This?

HoneyDrunk.Standards is a zero-configuration NuGet package that automatically applies:

• ✅ StyleCop Analyzers - Consistent naming and ordering conventions
• ✅ Roslyn Analyzers - Performance, reliability, and security checks
• ✅ EditorConfig - IDE-agnostic formatting rules
• ✅ Deterministic Builds - Reproducible builds across machines
• ✅ Nullable Reference Types - Enforced null safety
• ✅ Warnings as Errors - Quality gate in CI/CD
• ✅ ADR-0047 Test Stack - xUnit v2, NSubstitute, AwesomeAssertions, and coverlet for *.Tests.* projects
• ✅ Coverage Templates - Tiered coverlet runsettings for ADR-0047 / ADR-0036 coverage targets
• ✅ Test Flake Guardrail - Thread.Sleep is banned in test projects via HD0051

All of this happens automatically when you add the package. No manual configuration needed.

🚀 Quick Start

Installation

Add the package to your project:

<ItemGroup>
  <PackageReference Include="HoneyDrunk.Standards" Version="0.1.0" PrivateAssets="all" />
</ItemGroup>

Important: Always include PrivateAssets="all" to prevent transitive dependencies.

Verify It Works

dotnet build

You should see:

• ✅ Analyzer warnings/errors if code violates standards
• ✅ StyleCop rules enforced
• ✅ EditorConfig formatting applied

📚 Documentation

🎯 Features

🔍 Analyzers Included

📝 Enforced Standards

• File-scoped namespaces - namespace MyApp; (C# 10+)
• Private field prefixes - _fieldName convention
• var usage - Prefer var everywhere
• Minimal braces - Only required for multi-line blocks
• Async suffix - GetUserAsync naming
• XML documentation - Required for public APIs
• Nullable annotations - Explicit ? for nullability

⚙️ Build-Time Features

• Deterministic builds - Same source = same binary
• CI mode auto-detection - Optimized for GitHub Actions, Azure Pipelines
• Warnings as errors - Fail builds on analyzer warnings
• Nullable reference types - Catch null bugs at compile time

🧪 ADR-0047 Test Defaults

Test projects should reference both packages:

<ItemGroup>
  <PackageReference Include="HoneyDrunk.Standards" Version="0.2.9" PrivateAssets="all" />
  <PackageReference Include="HoneyDrunk.Standards.Tests" Version="0.2.9" PrivateAssets="all" />
</ItemGroup>

HoneyDrunk.Standards.Tests carries the NuGet dependencies because package buildTransitive props cannot reliably add PackageReference items during restore. Keep the reference simple: use PrivateAssets="all", but do not copy the analyzer-package IncludeAssets pattern onto this metapackage because consumers need compile/runtime assets from the test-stack dependencies. Projects whose names match the Grid test convention (*.Tests.Unit, *.Tests.Integration, *.Tests.Integration.Containers, *.Tests.E2E, *.Tests.Benchmarks) receive:

• IsPackable=false
• IsTestProject=true
• xUnit 2.9.3
• xunit.runner.visualstudio 2.8.2
• Microsoft.NET.Test.Sdk 18.5.1
• NSubstitute 5.3.0
• AwesomeAssertions 9.4.0
• coverlet.collector 10.0.1

Runtime projects must reference only HoneyDrunk.Standards, so they do not receive these test packages. Moq and FluentAssertions are intentionally absent per ADR-0047 D2.

📊 Coverage Runsettings Templates

Copy the matching template from the package's buildTransitive assets to the Node repo root as coverlet.runsettings, then run:

dotnet test --settings coverlet.runsettings

Tier 2 omits coverlet thresholds because coverlet thresholds fail the test run; the CI job owns the warning posture. All first adoptions have ADR-0047's 30-day advisory grace period before hard gates become blocking. Forward-declared Nodes such as Notify Cloud, Memory, Knowledge, Flow, and Evals use the template for their tier when scaffolded.

🚫 Test Thread.Sleep Ban

Thread.Sleep is forbidden in *.Tests.* projects by the HoneyDrunk analyzer rule HD0051. The rule is build-breaking for test projects only and covers both Thread.Sleep(int) and Thread.Sleep(TimeSpan).

Use one of these instead:

• await the async operation
• polling primitives with explicit timeouts
• synchronously-completing fakes

Runtime projects are not flagged by this rule.

🛠️ Configuration

Opt-Out of Features

All behavior can be customized via MSBuild properties:

<PropertyGroup>
  
  <HD_EnableAnalyzers>false</HD_EnableAnalyzers>
  
  
  <HD_UseStyleCop>false</HD_UseStyleCop>
  
  
  <HD_TreatWarningsAsErrors>false</HD_TreatWarningsAsErrors>
</PropertyGroup>

Suppress Specific Rules

<PropertyGroup>
  
  <NoWarn>$(NoWarn);CA1062;SA1633</NoWarn>
</PropertyGroup>

Override Language Features

<PropertyGroup>
  
  <LangVersion>12.0</LangVersion>
  
  
  <Nullable>disable</Nullable>
</PropertyGroup>

📋 Included Rules

Enabled by Default

Disabled Rules (With Rationale)

See CONVENTIONS.md for full rationale.

🧪 Testing & Validation

Sample Project

The Consumer.Sample project demonstrates:

• ✅ Compliant code examples
• ❌ Commented-out violations you can uncomment to test
• 📖 README with step-by-step testing instructions

Local Testing

# Clone the repository
git clone https://github.com/HoneyDrunkStudios/HoneyDrunk.Standards.git
cd HoneyDrunk.Standards/HoneyDrunk.Standards

# Build and pack
dotnet pack -c Release -o ./artifacts

# Test in your project
dotnet add package HoneyDrunk.Standards --source ./artifacts --version 0.1.0

🔄 CI/CD Integration

GitHub Actions

The package auto-detects CI environments:

- name: Build with standards
  run: dotnet build -c Release
  # ContinuousIntegrationBuild=true automatically enabled
  # TreatWarningsAsErrors=true enforced

Explicit CI Mode

Force CI mode locally:

dotnet build /p:ContinuousIntegrationBuild=true /p:TreatWarningsAsErrors=true

🤝 Contributing

Contributions are welcome! Please:

1. Read CONVENTIONS.md for coding standards
2. Open an issue for discussion before major changes
3. Include tests for new rules or features
4. Update documentation

Development Workflow

# Restore dependencies
dotnet restore HoneyDrunk.Standards.sln

# Build
dotnet build HoneyDrunk.Standards.sln -c Release

# Pack
dotnet pack HoneyDrunk.Standards/HoneyDrunk.Standards.csproj -c Release -o ./artifacts

# Test in Consumer.Sample
cd Consumer.Sample
dotnet build

📄 License

This project is licensed under the MIT License.

🐝 About HoneyDrunk Studios

HoneyDrunk.Standards is part of the Hive ecosystem - a collection of tools, libraries, and standards for building high-quality .NET applications.

Other Projects:

• 🚧 HoneyDrunk.Build (coming soon) - Build tooling and SourceLink automation
• 🚧 HoneyDrunk.GitHooks (coming soon) - Git hooks for commit message validation

📞 Support

• Questions: Email us at contact@honeydrunkstudios.com
• Bugs: File an issue
• Feature Requests: Open an issue with the enhancement label

<div align="center">

Built with 🍯 by HoneyDrunk Studios

Documentation • Sample Project • Issues • Contact

</div>