nebula-plugins / nebula-plugins/nebula-archrules-plugin

Fine-grained rule exclusions

Open
#91 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Kotlin
Stars
22
Forks
3
Avg merge
1h 30m
Merged PRs (30d)
3

Description

In some cases, it is desirable to disable specific rules for certain classes. When using ArchUnit regularly, this would typically be achieved by filtering the JavaClasses before checking the rule.

It would be nice if the plugin would expose a DSL to replicate such exceptions on (at least) a per-rule basis. Ideally, this would tie into a general mechanism for per-sourceset configuration (See also #90).

While covering the entire expressiveness of ArchUnit in a DSL is probably not feasible, it would be nice a nice start if we could ignore targets by name or when they have certain annotations.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the plugin currently declares and evaluates ArchUnit rules, then compare that with the per-sourceset configuration proposed in #90. Define the scope of a per-rule exclusion DSL, including target names and annotations, and confirm that exclusions can be applied independently to each rule. Done means the supported exclusions are configurable and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.