Add violation level#64
Open
fabiodomingues wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a violation level mechanism to the dependency analyzer along with corresponding tests and documentation updates. Key changes include:
- Updating tests (in api_integration_test.clj) to expect a new violation level field.
- Modifying the internal API to attach the violation level from the configuration.
- Documenting the new :level configuration option.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/clj_depend/api_integration_test.clj | Updated tests to include the new :level field in violations. |
| src/clj_depend/internal_api.clj | Modified violation processing to associate a level from config. |
| src/clj_depend/config.clj | Added default :level configuration. |
| src/clj_depend/analyzers/layer.clj | Removed unused helper function. |
| docs/config.md | Documented the :level configuration option. |
Comments suppressed due to low confidence (1)
src/clj_depend/internal_api.clj:94
- The violation maps' :level field is unconditionally overridden with the config value. Verify that this behavior is intentional, particularly if individual violations might already specify a level.
violations (->> (snapshot/without-violations-present-in-snapshot-file! violations options)
| :violations [{:namespace 'sample.controller.foo | ||
| :dependency-namespace 'sample.logic.foo | ||
| :message "Circular dependency between \"sample.controller.foo\" and \"sample.logic.foo\""} | ||
| :message "Circular dependency between \"sample.controller.foo\" and \"sample.logic.foo\"" |
There was a problem hiding this comment.
[nitpick] Duplicate violation message strings appear across tests; consider extracting them into a shared constant to ease maintenance in case the message needs updating.
Suggested change
| :message "Circular dependency between \"sample.controller.foo\" and \"sample.logic.foo\"" | |
| :message circular-dependency-message |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new severity level configuration (
:level) for violations, updates the analyzer logic to include this level in violation results, and adjusts tests to account for the new functionality. Additionally, it removes unused code and simplifies namespace dependencies logic.Features and Configuration Updates:
docs/config.md: Added documentation for the new:levelconfiguration, which defines the severity of violations (:errorby default).src/clj_depend/config.clj: Updated the default configuration to include the:levelkey with a default value of:error.Analyzer Logic Enhancements:
src/clj_depend/internal_api.clj: Modified the violation analysis logic to associate each violation with its severity level (:level) and updated the result code logic to depend on the presence of:errorlevel violations.Codebase Simplification:
src/clj_depend/analyzers/layer.clj: Removed the unusednamespace-dependenciesfunction and simplified the namespace dependencies logic.src/clj_depend/analyzers/layer.clj: Removed theclojure.setdependency from the namespace declaration as it is no longer needed.Test Updates:
test/clj_depend/api_integration_test.clj: Updated tests to include the:levelkey in violation results and added new tests to validate behavior for different severity levels (:error,:warning,:info). [1] [2] [3] [4] [5]Checklist
docsfolder)