astral-sh/ruff

Consider analyze-graph for packages and producing graph?

Open

Aperta il 20 set 2024

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Rust (47.527 star) (2088 fork)batch import
analyzehelp wanted

Descrizione

My Graph-Imports package has been a useful tool in my development. Now that Ruff has ruff analyze graph, it could be extended to supplant my tool if there's a desire. Suggestions:

  • Add a --package flag to switch from producing a graph of module imports to package imports (take the union over every module within a package?)
  • Add a --output_image flag to produce an actual image of the graph rather than text?

I realize this may be out of scope, but I thought I'd suggest it since it might be easy to do. (The source for graph-imports is quite short: https://github.com/NeilGirdhar/graph_imports/blob/main/graph_imports/__init__.py)

Guida contributor

Tech stack
rustpython
Dominio
clitoolingdeveloper experience
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Rust programmingFamiliarity with ruff CLIBasic graph concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
55
Direzione di ricerca
Per prima cosa, leggi i commenti esistenti sull'issue (#13431) per comprendere l'interesse dei maintainer. Poi esamina l'implementazione corrente del sottocomando `ruff analyze graph` nella codebase, probabilmente in `crates/ruff cli/src/commands/analyze.rs`. Considera come aggiungere un flag ` package` aggregando le importazioni dei moduli per pacchetto. Per ` output image`, valuta le librerie Rust disponibili per la visualizzazione di grafi o considera la generazione di output Graphviz DOT. Rivedi il pacchetto graph imports linkato come riferimento per la generazione di grafi a livello di pacchetto.