Skip to content

feat: install and run madge#44

Open
Kendric285 wants to merge 1 commit intomainfrom
madge
Open

feat: install and run madge#44
Kendric285 wants to merge 1 commit intomainfrom
madge

Conversation

@Kendric285
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant