pahen/madge

[Feat] Specify config path via CLI

Open

#335 opened on Nov 18, 2022

View on GitHub
 (1 comment) (5 reactions) (0 assignees)JavaScript (8,058 stars) (322 forks)batch import
cligood first issue

Description

There is currently no way to provide config path or detectiveOptions via CLI. Its blocked by commander even though it would work out of the box with rc

Contributor guide

Tech stack
javascriptnodejs
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
Basic Node.js knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding a CLI option to specify a config file path. Currently, madge uses commander for CLI argument parsing, but does not accept a config path. The issue suggests using the 'rc' package to load configuration. To implement, look at the CLI entry point (e.g., bin/madge or similar) and add a new option like ' c' or ' config' using commander. Then integrate a config loading mechanism, possibly using 'rc' as suggested. Review existing configuration handling in the codebase to ensure compatibility.