Open
Conversation
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.
To install madge:
Run npm install --save-dev madge
Run npx madge --circular . > madge-output.txt
madge-output.txt is a text file containing the output from the tool.
Pros:
Can detect circular dependencies between modules, which can make code harder to maintain and reason about
Provides insight into the dependency structure of the project, helping developers understand relationships between files
Fast to run and produces output quickly even on larger JavaScript projects
Does not require writing tests
Cons:
Focuses only on module dependency structure and therefore does not detect logic errors
For large projects like NodeBB, the dependency graph can become large and difficult to interpret without additional filtering, configuration, or visualization tools
May report circular dependencies that are intentional in the project, requiring manual review to determine whether they are actually problematic