Question 1

How do I set up ArchUnitTS with Vitest?

Accepted Answer

You must configure Vitest with `globals: true` in your `vitest.config.ts` file, as specified in the README. Then, use the `toPassAsync()` matcher for seamless integration, similar to Jest.

Question 2

ArchUnitTS vs ts-arch: which is better for layer dependency rules?

Accepted Answer

ArchUnitTS offers more advanced patterns, code metrics, and custom rules, while ts-arch has limited testing framework support and no metrics analysis. The comparison table shows ArchUnitTS is more comprehensive for architectural validation.

Question 3

Can ArchUnitTS validate architecture against PlantUML diagrams?

Accepted Answer

Yes, it supports UML diagram validation for component, package, and class diagrams using `adhereToDiagram()`. You can define diagrams inline or from files to enforce architectural designs automatically.

Question 4

How to create a custom metric in ArchUnitTS?

Accepted Answer

Use the `customMetric()` method in the metrics API, providing a name, description, and calculation function. The README includes an example for method-to-field ratio tailored to specific class patterns.

Question 5

Does ArchUnitTS work with JavaScript projects, or is it TypeScript only?

Accepted Answer

It works with JavaScript projects, but TypeScript projects benefit more due to better static analysis capabilities. The library analyzes import statements and code structure regardless of language, though some features like AST analysis are optimized for TypeScript.

Question 6

What's the performance impact of running ArchUnitTS on a large codebase?

Accepted Answer

ArchUnitTS uses caching and parallel processing to optimize performance, but for very large projects, test runs might be slower. Enabling debug logging can add overhead, so it's recommended only for troubleshooting.

ArchUnitTS

What is ArchUnitTS?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions