Question 1

How do I set up Sheriff in an existing TypeScript project?

Accepted Answer

Install the Sheriff core and ESLint plugin via npm, then run 'npx sheriff init' to generate configuration files. This sets up tagging and dependency rules based on your project structure, with options for customization.

Question 2

Can Sheriff handle monorepos with multiple packages?

Accepted Answer

Yes, Sheriff supports monorepos by allowing you to define module boundaries and dependency rules across different packages. You need to configure tagging appropriately for each package to enforce clean architecture.

Question 3

Sheriff vs Lerna: what's the difference for dependency management?

Accepted Answer

Sheriff focuses on enforcing internal module boundaries and dependency rules within TypeScript code, while Lerna manages versioning and publishing across packages in a monorepo. They can complement each other, with Sheriff handling architectural constraints.

Question 4

How does Sheriff compare to ESLint plugins for import/export rules?

Accepted Answer

Sheriff's ESLint plugin provides specialized rules for architectural enforcement, such as controlling public APIs via index.ts files, whereas generic ESLint plugins focus on syntax or style. Sheriff offers more targeted checks for clean architecture.

Question 5

Is Sheriff suitable for frontend frameworks like React or Angular?

Accepted Answer

Sheriff works with any TypeScript project, including React or Angular apps, but you may need to adjust tagging rules to fit framework-specific patterns, such as component hierarchies or service layers.

Question 6

How to visualize dependencies with Sheriff's CLI?

Accepted Answer

Use the 'sheriff graph' command to export dependency graphs in formats like DOT or JSON, which can be visualized with tools like Graphviz. This helps in understanding and auditing module relationships.

Sheriff

What is Sheriff?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions