Allow for script to exit with code 0 even if circular dependencies are found

[louisscruz]

In some cases, one might aim to use madge to get a list of circular dependencies without necessarily exiting 1 in the case that some are found. This PR adds an --allow-circular flag that will allow for that.

[louisscruz]

@pahen would you consider adding this? Or, perhaps some variation of this?

[PabloLION]

liking

• Should allow non-zero exit code when generating graph #294

[PabloLION]

Hi, @louisscruz , thanks for this handy idea. I'm here to help with the PR.
Apart from the aforementioned problems, it seems to me the word "allow" is a bit of vague in the sense of "who allows what": madge won't forbid user to have circular dependency, it only throws error on checking.
Maybe we can consider using word like suppress or ignore?

[PabloLION]

Due to the inactivity, I'm going to do the edit myself and add some output test.

[Copilot]

Pull Request Overview

Adds a new --allow-circular flag to madge that allows the script to exit with code 0 even when circular dependencies are found, providing users the ability to list circular dependencies without triggering a failure exit code.

• Introduces --allow-circular flag for non-failing circular dependency detection
• Updates documentation to clarify exit behavior with and without the flag

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

reviewed with copilot