nccgroup/sobelow

`--no-router` flag for use in non-Phoenix projects

Open

#165 opened on May 3, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Elixir (1,780 stars) (119 forks)batch import
enhancementgood first issuehelp wanted

Description

I see the cannot found the router warning in my umbrella applications which do not have Phoenix routers, and I would also like to use Sobelow in some libraries that I maintain without seeing this warning.

If a --no-router flag is specified (or is present in configuration), then the no_router message should not be printed.

Contributor guide

Tech stack
None
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Elixir basicsSobelow CLI understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
This issue requests a ` no router` flag to suppress the 'cannot found the router' warning in non Phoenix projects. The implementation should add a CLI option (e.g., in lib/sobelow/cli.ex) and check it before printing the warning. The configuration could also be read from the CLI or config files. Look at existing flag handling in the codebase (e.g., how other flags like all checks are implemented). See issue comments for additional suggestions about configuration.