astral-sh/ruff

Consider analyze-graph for packages and producing graph?

Open

#13,431 opened on Sep 20, 2024

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Rust (2,088 forks)batch import
analyzehelp wanted

Repository metrics

Stars
 (47,527 stars)
PR merge metrics
 (Avg merge 5d 4h) (463 merged PRs in 30d)

Description

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)

Contributor guide

Research direction
First, read the existing comments on the issue (#13431) to understand maintainer interest. Then examine the current implementation of the `ruff analyze graph` subcommand in the codebase, likely in `crates/ruff cli/src/commands/analyze.rs`. Consider how to add a ` package` flag by aggregating module imports per package. For ` output image`, evaluate available Rust graph visualization libraries or consider generating Graphviz DOT output. Review the linked graph imports package for reference on package level graph generation.
Tech stack
rustpython
Domain
clitoolingdeveloper experience
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Rust programmingFamiliarity with ruff CLIBasic graph concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55