RideCompiler 1.0.0

RideCompiler Analyzers

This directory contains Roslyn analyzers which strictly enforce the architectural and coding conventions required by rIDE on all StarterKit-based projects. These analyzers ensure that repositories remain fully compatible with rIDE's automation, code generation, and collaborative tooling.

Note: These analyzers are developed and maintained exclusively for the official rIDE infrastructure. External contributions are not accepted. Their scope and rules are tightly coupled to rIDE product needs and may change as required.

Purpose

RideCompiler analyzers guarantee that all code in StarterKit-based projects adheres to rIDE's mandatory conventions for:

• Class and artifact roles (Managers, Engines, Accessors, Utilities)
• Data Transfer Objects (DTOs) structure and constraints
• Dependency injection structure
• Allowable code interdependencies

Strict enforcement ensures seamless integration with the rIDE ecosystem and reliable code automation.

Analyzer Rules

RIDE0001: Manager method input/output and interface enforcement

• Ensures:
  • Manager classes implement IManagerService.
  • Manager methods have zero or one parameter (must be a DTO if present).
  • Method return types are either void or a DTO (never collection, primitive, or nullable types).
  • Managers do not call other managers directly.

RIDE0002: Utility methods must be static

• Ensures: Utility classes (under App.*.Utilities) contain only static methods (except constructors).

RIDE0003: DTO field enforcement

• Ensures:

  • DTOs (Contracts.Dto.*) only have properties of explicitly allowed types -- see below for the updated allowed type set.

  Allowed:

  • int, long, short, float, double, decimal, bool, Guid, DateTime, void, string, object
  • Nullable (Foo?) for any allowed type
  • Arrays (Foo[]) and generic collections: List<T>, IEnumerable<T>, IList<T>, Dictionary<TKey, TValue> where key/value are allowed
  • Task, Task<T> (with T allowed)
  • Other DTOs and enums (from correct namespaces)

RIDE0004: Engine dependency enforcement

• Ensures: Engines cannot call other engines or managers.

RIDE0005: Accessor dependency and convention enforcement

• Ensures: Accessors cannot call managers, engines, or other accessors.

RIDE0006: Orphaned class or method warning

• Warns: Classes not referenced by any managers and not themselves managers.

RIDE0007: Dependency Injection Enforcement

• Ensures: All managers, engines, and accessors are registered in Program.cs for dependency injection.

Usage: StarterKit Project Compliance

1. Add the RideCompiler analyzer to your .NET solution (StarterKit projects managed by rIDE include this by default).
2. Violations appear as errors or warnings in your IDE/build output when any convention is broken.
3. Resolve all RIDE0001–RIDE0007 diagnostics to ensure rIDE compatibility.

Release Tracking

• AnalyzerReleases.Shipped.txt: List of released and enforced analyzers.
• AnalyzerReleases.Unshipped.txt: Diagnostics under active development.

Maintainers

• These analyzers are maintained by the rIDE team. Do not submit PRs or requests. All changes are driven by internal rIDE requirements.

License

Copyright © CodeBuddy Team