ReviewProjectConfig class final

Project-level configuration for review_comments_cli storage, prompts, and source file resolution.

Constructors

ReviewProjectConfig({String reviewDirectoryName = defaultReviewDirectoryName, String cliResolveCommand = defaultCliResolveCommand, String defaultSite = '', List<String>? allowedSites, String? contentRoot, List<String>? sourceRoots, Map<String, ReviewSiteConfig> sites = const <String, ReviewSiteConfig>{}})
const
ReviewProjectConfig.flutterWebsite({String reviewDirectoryName = '.dash_review', String cliResolveCommand = 'dart run dash_site review resolve', String defaultSite = 'docs'})
Preset matching the flutter/website (docs + www) monorepo layout.
factory
ReviewProjectConfig.load(String repoRoot, {String configFileName = defaultReviewConfigFileName})
Loads ReviewProjectConfig from review_comments.yaml inside repoRoot if present and safely confined within repoRoot, or returns defaults.
factory
ReviewProjectConfig.parseYaml(String yamlContent)
Parses a review_comments.yaml document into a ReviewProjectConfig.
factory

Properties

allowedSites → List<String>?
Optional allowlist of valid site names (for example, ['docs', 'www']).
final
cliResolveCommand → String
CLI command prefix rendered in feedback.md and prompt instructions.
final
contentRoot → String?
Optional content directory prefix for single-site content repositories.
final
defaultSite → String
Default site name used when requests do not specify one.
final
hashCode → int
The hash code for this object.
no setterinherited
reviewDirectoryName → String
Repository-relative directory storing comments.json and feedback.md.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sites → Map<String, ReviewSiteConfig>
Optional per-site source layout overrides keyed by site identifier.
final
sourceRoots → List<String>?
Optional list of secondary source directories to search when the primary sourceFile does not match or is omitted.
final

Methods

commentsRelativePathFor(String repoRoot) → String
Repository-relative POSIX path to comments.json.
copyWith({String? reviewDirectoryName, String? cliResolveCommand, String? defaultSite, List<String>? allowedSites, String? contentRoot, List<String>? sourceRoots, Map<String, ReviewSiteConfig>? sites}) → ReviewProjectConfig
Creates a copy of this configuration with selected fields overridden.
feedbackRelativePathFor(String repoRoot) → String
Repository-relative POSIX path to feedback.md.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
safeReviewDirectoryRelativePath(String repoRoot) → String
Resolves reviewDirectoryName safely within repoRoot, falling back to defaultReviewDirectoryName if the configured value attempts to escape repoRoot.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited