arch_guard 1.10.0
arch_guard: ^1.10.0 copied to clipboard
A CLI tool and Dart library for static architecture analysis, Clean Architecture layer governance, circular dependency metrics, and graph visualization.
1.10.0 #
- Layer rules see through barrels. When a layered file imports a file in no layer that re-exports another layer (
lib/exports.dartwithexport 'data/dto.dart';), the import is now checked against what the barrel re-exports. Chains of such barrels are followed. Before, the barrel was skipped, sodomain -> exports.dart -> datapassed. The violation reads... -> [data] lib/data/dto.dart (via lib/exports.dart). With--since, a change to the barrel also reports it. Library:LayerViolation.via,viaSuffix;LayerValidator.checkertakesvia. - Platform-specific cycles. A cycle that exists only through conditional imports is now marked
Platform-specific (only through conditional imports: if (dart.library.io))in the terminal, Markdown, SARIF and JSON (platformConditions). It still counts as a cycle. Edges from conditional imports carry theirconditionin the JSON export. Library:GraphEdge.condition,ExtractedDirective.condition,Cycle.platformConditions,isPlatformSpecific,platformNote.
1.9.2 #
- Baseline flags improvements to lock in. A known cycle group that lost files or split, or a known metric value that dropped, is now reported as
N cycle group(s) shrank/N metric value(s) dropped since the baseline. Run with --update-baseline to lock this in.in the terminal and Markdown report. Before, only problems that disappeared entirely were reported, so a shrunk cycle could quietly grow back to its saved size. Library:BaselineComparison.shrunkCycleCount,improvedMetricCount,improvements. - Docs: updating the baseline is manual; "no regression" is measured against the saved baseline, not the last passing run.
1.9.1 #
- Baseline says why a cycle is new. Each new cycle in the terminal and Markdown report now ends with a reason:
grew from a known 3-file cycle, adding lib/d.dart,merges 2 known cycles, ornone of its files is in a baseline cycle. Library:BaselineComparison.newCycleReasons. - Docs: the cycle rule is spelled out. The baseline compares cycle membership, not the imports inside a cycle. With a baseline cycle
a -> b -> c -> a, addinga -> cstill passes. A test pins this down.
1.9.0 #
inithandles hybrid layouts. When it picksriverpodorclean_architectureand also findsbloc/orcubit/folders, the generated config adds abloclayer that may import whatpresentationmay, and letspresentationimport it. A bloc that imports UI code is still a violation. Library:LayoutDetection.blocFolders.
1.8.0 #
- New:
ProjectScanner.scanSources(). Builds aScanResultfrom in-memory file contents instead of the file system. Thearch_guard_lint0.2.0 plugin uses it for live cycle warnings that include unsaved editor changes.
1.7.1 #
--sinceoutput:- The "Only problems touching N file(s)…" note now comes before the report, so "No circular dependencies found!" reads as "none in the changed files".
- N counts only scanned files (not
pubspec.yaml, assets…).ArchAnalysis.changedFilesitself now holds only scanned files too, so deleted and non-Dart files are no longer in it. Filtering is unchanged.
- JSON export: with
--since, the export now recordssinceandchangedFiles. - Errors and warnings:
- With git older than 2.30,
--sincenow says it needs git 2.30+ instead of showing git's raw error. --no-workspacewithworkspace_rulesnow says the rules are ignored because of the flag, not that the project isn't a workspace.
- With git older than 2.30,
- Cycle hints: when two files are joined by both an import and an export, the hint points at the first of those lines.
metrics: hotspotsalone: a config with onlyhotspots(no limits) now lists the most coupled files in the terminal. New:ArchGuardConfig.metricsConfigured.workspace_rules: a rule whoseallowedentries are all invalid globs is now skipped with a warning, so that member is unrestricted until the globs are fixed. Before, it silently forbade every import. An explicitallowed: []still means "no other members".- Unreadable files: warnings about files that couldn't be read are listed in a stable order.
1.7.0 #
- New: cycle-breaking hints. Each circular-dependency group now names the one import whose removal breaks it (or shrinks it most), in the terminal, Markdown, SARIF and JSON (
scc.suggestedBreak). Library:CycleBreaker,CycleBreak. - New:
--since <git-ref>. Reports (and fails on) only problems touching files changed since the merge base with a ref, plus uncommitted and untracked files, while still analysing the whole project. Baseline "fixed" counts stay accurate. Also available asexpectArchitecture(since:)andArchAnalysis.run(since:). Needs full history in CI (fetch-depth: 0). - Docs: an example project for every feature.
example/example.md(pub.dev's Example tab) links to small projects inexample/cases/: cycles, layers, presets, forbidden packages, metrics, workspace rules, baselines,--since, architecture tests and reports. Each README has the config, the command and its real output.example/example.dartcovers the library API. The CLI and testing docs gain--sinceand cycle-fix recipes.
1.6.0 #
- New: metric limits.
metrics: max_fan_out / max_fan_infail the run when a file imports, or is imported by, too many project files. Baselines ratchet: a known file that gets worse fails again. Reports list the most coupled files (hotspots, default 10) in Markdown and JSON, and in the terminal when limits are set. SARIF rulemetric-limit. Library:FileMetrics,MetricValidator. - New:
workspace_rules. In a Dart workspace orpackages//apps/monorepo, declare which members may import which (apps/*→packages/*, never the reverse). Violations point at the import line, fail the run, and work with baselines, SARIF (workspace-dependency), Markdown and JSON. Library:WorkspaceValidator,WorkspaceViolation,ScanResult.packages. - Fixed: unstable cycle order. Files and edges are now sorted, so cycle numbering and every report are identical between runs.
- Baseline files gain
metricViolationsandworkspaceViolationslists. Older baselines still load.
1.5.0 #
- New:
forbidden_packages. Rule out packages and core libraries for the whole project (top-level key) or per layer (e.g.domainmay not importflutterordart:io). Entries are package names or globs (firebase_*). Violations fail the run, point at the import line, and work with baselines, SARIF (forbidden-packagerule), Markdown and JSON reports. - Library:
PackageValidator,PackageViolation,PackageImportandScanResult.packageImports;LayerValidator.layerResolver()is now public. - Baseline files gain a
packageViolationslist. Older baselines still load. - Invalid globs in
arch_guard.yaml(ignore, layerpatterns,forbidden_packages) are reported as warnings and skipped instead of crashing the run.defaultExcludePatternsis now exported. - New:
expectArchitecture()inpackage:arch_guard/testing.dartruns the same checks as the CLI insidedart test/flutter testand fails with a readable list of problems. Works with any test runner; no extra dependencies. - Library:
ArchAnalysis.run()runs a full analysis (scan, cycles, layer and package rules, baseline) in one call; the CLI now uses it. - Library:
ArchGuardConfig.loadWith()loads configuration through a custom file reader, andLayerValidator.checker()checks a single import. Both are used by the newarch_guard_lintanalyzer plugin.
1.4.1 #
- Fixed: empty graph in the HTML report. The page layout could let the graph canvas grow taller than the window, drawing the nodes out of view. The report header now says
arch_guardinstead of the old "Dependency Graph Visualizer" name. - New: documentation site at creatorpiyush.github.io/arch_guard, with a recipe per preset, the configuration reference, CI and git hook guides, and the CLI reference. The README is shorter, with screenshots and a comparison with similar tools.
- Every public API member now has a doc comment, and
pubspec.yamllinks the documentation and issue tracker. - Contributor guide, security policy, and issue and pull request templates.
1.4.0 #
- New:
arch_guard init. Detects the project layout (Clean Architecture, Riverpod, Bloc or feature-first folders), writes a starterarch_guard.yaml, and previews the first scan: files per layer, violations, cycles, and the suggested next step. Options:--preset <name|auto|none>,--dry-run,--force. - New: Layer presets.
preset: clean_architecture | feature_first | bloc | riverpodin the config expands to predefined layers. Entries underlayers:override a preset layer key by key (for example onlyallowed_imports) or add new layers.feature_firstdiscovers features fromlib/features/*(orlib/modules/*) on every run, so each feature may import only itself and shared code. - Improved: Actionable layer violations. Each violation now shows the rule it broke (
Rule: `presentation` may only import `core`, `domain`, `presentation`.) and the output ends with how to fix it. SARIF and Markdown reports include the rule too;LayerViolationgainsallowedImports,ruleandsuggestion, and the JSON report includesallowedImports. - Preset layers that match no files no longer produce "matched no scanned files" warnings.
- Library:
ArchGuardConfig.parse()reads configuration from a string;LayerCoverage.layerFileCountscounts files per layer;LayerPresetsandLayoutDetectorare exported. - A bad option to
arch_guard initnow prints theinitusage instead of the main one.
1.3.0 #
- New: Baselines for legacy projects.
--update-baselinerecords today's circular dependencies and layer violations inarch_guard_baseline.json. When that file exists, later runs fail only on new problems: a known cycle may shrink, but one that grows or merges with another counts as new. Fixed entries are reported so the baseline can be tightened. Use--baseline <path>for a different location. Library users getBaselineandBaselineComparison. - New: SARIF output (
-f sarif) writesarch_guard.sarif(SARIF 2.1.0) for GitHub Code Scanning, Azure DevOps and SARIF viewers in IDEs. Results point at the offending import line, use paths relative to the git repository root, and carrybaselineStatewhen a baseline is in use. - New: Markdown summary (
-f markdown) writesarch_guard_report.md: new problems first, then a collapsible Mermaid graph of the cycles. Ready for PR comments and CI job summaries. - New: GitHub Action.
uses: creatorpiyush/arch_guard@v1.3.0downloads the checksum-verified release binary, writes the Markdown summary to the job summary, keeps one up-to-date PR comment, and can upload SARIF to Code Scanning. - New: pre-commit hook. The repository ships a
.pre-commit-hooks.yaml, and the README has recipes for pre-commit, lefthook and plain git hooks. - New:
--versionflag and thepackageVersionconstant. - Layer violations, graph edges and directives now record the source line (
LayerViolation.line,GraphEdge.line,ExtractedDirective.line); the JSON report includes it. -f allnow also writes the SARIF and Markdown reports.- Local-only files (
plan.md, IDE files,build/) are no longer included in the published package.
1.2.1 #
- Wider compatibility: minimum Dart SDK lowered from 3.11 to 3.8 (Flutter 3.32+), so projects on older toolchains can add
arch_guardas a dev dependency. - New: Standalone binaries: every GitHub Release now includes prebuilt executables for Linux (x64, arm64), macOS (Apple Silicon) and Windows (x64) plus a
SHA256SUMS.txt, so CI pipelines can runarch_guardwithout installing the Dart SDK. - CI: Tests run on Linux, macOS and Windows against both the minimum supported SDK (3.8) and the latest stable SDK.
- Fix: Publish workflow ran twice per release: publishing to pub.dev is now triggered by version tags only.
- Removed the Flutter
.metadatafile from the repository.
1.2.0 #
- Fix:
--scan-dirwas ignored whenever workspace discovery was on (the default). A single-package project is no longer treated as a workspace, and in workspace mode the root package honours--scan-dir. - Fix: Over-eager workspace auto-discovery: without a
workspace:list, onlypackages/andapps/are searched, andexample/,test/andtool/packages are skipped. Previouslyexample/apps and test fixtures were scanned and could report false cycles. Monorepos with other layouts should declare aworkspace:list. - Fix: Phantom graph nodes: edges are only kept when their target file was actually scanned.
- New:
max_scc_sizeis enforced: any circular-dependency group larger than the limit fails the run (exit code1), even with--no-fail-on-cycle. - New: Configuration warnings: unparseable YAML, unknown keys, wrongly typed values,
allowed_importsnaming unknown layers, layers that match no files, files that belong to no layer, and unreadable source files are now reported on stderr instead of being silently ignored.LayerValidator.coverage(),ArchGuardConfig.warningsandScanResult.skippedFilesexpose the same data to library users. - New:
partdirectives producelibrary -> partedges (typepart, drawn dotted in DOT/Mermaid/HTML);FileNode.partslists them. - Improved: Directive parser now reads the directive section token by token, so
//or/*inside URIs or comments, nested block comments, annotations and import-like text inside later string literals no longer cause wrong results. - Security: HTML report escapes file paths before inserting them into the page and escapes
<,>and&in the embedded JSON. - Rename:
DepGraphConfigis nowArchGuardConfig(the old name remains as a deprecated alias). The legacydep_graph.yamlfile anddep_graph_visualizer:pubspec key still work but emit a deprecation warning; the example now usesarch_guard.yaml. - Tests write CLI output to a temporary directory instead of
example/sample_project/build/.
1.1.3 #
- Fix: Layer validator now works correctly in workspace/monorepo mode (
LayerValidator): Layer glob patterns such aslib/domain/**were silently never matching workspace-prefixed file paths (e.g.packages/auth_pkg/lib/domain/entity.dart). The validator now also tests thelib/…suffix of each path, making single-package and workspacearch_guard.yamlconfigs interchangeable with no user-side changes required. - Fix: Cross-package edge resolution path separator on Windows (
ImportReader.resolveUri):p.normalize(p.join(…))could produce backslash-separated paths on Windows, causing all resolved edge targets to silently miss the forward-slash-keyedfilesMapand disappear from the graph. All three return paths now force/separators. - Fix: Missing space in workspace summary line (
TextReporter): TheWorkspace Pkgs:line was missing a space before the count, producing misaligned output (e.g.Workspace Pkgs:3instead ofWorkspace Pkgs: 3).
1.1.2 #
- True
--offlineHTML Support: Inlined Base64-encodedvis-network.min.js(v10.1.0 UMD) asset and system font fallbacks when--offlineflag is specified. - Physics Stabilization Freeze: Added
stabilizationIterationsDoneevent listener to freeze Vis-Network force calculation after stabilization to eliminate CPU background spin. - Mermaid Exporter Disambiguation: Added shared ID map with numeric suffix disambiguation for colliding file paths (e.g.
a-b.dartvsa_b.dart) and quote label sanitization (#quot;). - Attribution & Notices: Added
THIRD_PARTY_NOTICES.mdfor bundledvis-networkApache-2.0/MIT software licensing.
1.1.1 #
- Refined
dep_graph.yamlconfiguration examples and updated example application layout. - Cleaned up maintainer CI documentation in
README.md.
1.1.0 #
- Strongly Connected Component (SCC) Severity Metrics: Calculate internal edges, average fan-in, average fan-out, instability metric ($I$), graph coupling density ($D$), and bottleneck dependency hub files (
SccComponent). - Clean Architecture & Layer Boundary Checker: Configurable layer rules in
dep_graph.yamlorpubspec.yamlwith glob pattern matching (LayerValidator). - Targeted File Dependency Explainer: Detailed file-level dependency path and cycle analysis via
--explain <file>. - New Export Formats: Machine-readable JSON report (
JsonExporter) and GitHub/GitLab markdown flowchart diagram export (MermaidExporter). - High-Throughput Parallel Scanning: Bounded parallel file reader queue (batch size 64) in
ProjectScanner. - Scope & Offline Control: Added
--scope cycles|allgraph scope trimming and--offlineHTML asset inlining.
1.0.1 #
- Updated License to MIT
1.0.0 #
- Initial release of
dep_graph_visualizer. - Monorepo & Dart 3.6+ Workspace auto-discovery (
pubspec.yamlworkspace:entries and Melos sub-package structures). - Cross-package import resolution (
package:<member_pkg>/...) and inter-package circular dependency detection. - Project scanner with regex directive parser.
- Circular dependency detector using Tarjan's SCC algorithm.
- Terminal text reporter with ANSI colors.
- Graphviz
.dotexporter. - Interactive single-file centerpiece HTML graph visualizer.
- Full CLI supporting repeatable
-f,-o,--scan-dir,--exclude, and--[no-]workspaceflags. - Added conditional import/export support by treating every quoted URI in a directive as a potential dependency edge.
- Added a Flutter-style fixture and tests covering circular dependency detection through conditional imports.