Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
visualize_packwerk (0.0.5)
visualize_packwerk (0.0.6)
code_ownership
parse_packwerk
rake
Expand Down
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,25 @@
This gem contains rake tasks to help visualize relationships between packwerk packs.

# Usage
## Building a package graph for a selection of packages (owned by 5 teams max)
```
bin/rails visualize_packwerk:package_relationships['packs/pack1','packs/pack2']
## Building a package graph for a selection of packages
```ruby
# Select the packs you want to include
selected_packs = ParsePackwerk.all
selected_packs = ParsePackwerk.all.select{|p| ['packs/my_pack_1', 'packs/my_pack_2'].include?(p.name) }
selected_packs = ParsePackwerk.all.select{|p| ['Team 1', 'Team 2'].include?(CodeOwnership.for_package(p)&.name) }
VisualizePackwerk.package_graph!(selected_packs)
```

# Building a package graph for specific teams (5 teams max)
# Building a team graph for specific teams
```
bin/rails visualize_packwerk:package_relationships_for_teams['Team1','Team2']
# Select the teams you want to include
selected_teams = CodeTeams.all
selected_teams = CodeTeams.all.select{ ... }
VisualizePackwerk.team_graph!(selected_teams)
```

# Building a package graph for all packages (this is slow and produces a huge file)
```
bin/rails visualize_packwerk:package_relationships
```

# Building a TEAM graph for specific teams
```
bin/rails visualize_packwerk:team_relationships['Team1','Team2']
```

# Building a TEAM graph for all teams (this is slow and produces a huge file)
```
bin/rails visualize_packwerk:team_relationships
```
## bin/packs
For simpler use, use `bin/packs` in `use_packwerk` (https://github.com/rubyatscale/use_packwerk)

# Want to change something or add a feature?
Submit a PR or post an issue!
34 changes: 23 additions & 11 deletions lib/visualize_packwerk.rb
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
# typed: strict

require 'parse_packwerk'
require 'code_ownership'
require 'graphviz'
require 'sorbet-runtime'

require 'visualize_packwerk/node_interface'
require 'visualize_packwerk/graph_interface'
require 'visualize_packwerk/team_node'
require 'visualize_packwerk/package_node'
require 'visualize_packwerk/team_graph'
require 'visualize_packwerk/package_graph'
require 'visualize_packwerk/package_relationships'

module VisualizePackwerk
require 'visualize_packwerk/railtie' if defined?(Rails)
require 'parse_packwerk'
require 'code_ownership'
require 'graphviz'
extend T::Sig

sig { params(packages: T::Array[ParsePackwerk::Package]).void }
def self.package_graph!(packages)
PackageRelationships.new.create_package_graph!(packages)
end

require 'visualize_packwerk/node_interface'
require 'visualize_packwerk/graph_interface'
require 'visualize_packwerk/team_node'
require 'visualize_packwerk/package_node'
require 'visualize_packwerk/team_graph'
require 'visualize_packwerk/package_graph'
require 'visualize_packwerk/package_relationships'
sig { params(teams: T::Array[CodeTeams::Team]).void }
def self.team_graph!(teams)
PackageRelationships.new.create_team_graph!(teams)
end
end
15 changes: 0 additions & 15 deletions lib/visualize_packwerk/railtie.rb

This file was deleted.

73 changes: 0 additions & 73 deletions lib/visualize_packwerk/tasks/visualize_packwerk.rake

This file was deleted.

2 changes: 1 addition & 1 deletion visualize_packwerk.gemspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Gem::Specification.new do |spec|
spec.name = "visualize_packwerk"
spec.version = '0.0.5'
spec.version = '0.0.6'
spec.authors = ['Gusto Engineers']
spec.email = ['dev@gusto.com']
spec.summary = 'A gem to visualize connections in a Rails app that uses Packwerk'
Expand Down