Skip to content

Commit 81a2ee4

Browse files
Feature: Add SVG output format support
* Add SVG output format support * fixup! Add SVG output format support * fixup! fixup! Add SVG output format support
1 parent a6d987f commit 81a2ee4

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A huge shout out to the people behind these projects.
5151

5252
To generate the overall component dependency graph for a project, use it like so -
5353

54-
`cpp_dependency_graph visualise_project -r spec\test\example_project\ -o deps.dot -f dot`
54+
`cpp_dependency_graph visualise_project -r spec\test\example_project\ -o deps.svg -f svg`
5555

5656
Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)
5757

Diff for: docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A huge shout out to the people behind these projects.
3232

3333
To generate the overall component dependency graph for a project, use it like so -
3434

35-
`cpp_dependency_graph visualise -r spec\test\example_project\ -o deps.dot -f dot`
35+
`cpp_dependency_graph visualise -r spec\test\example_project\ -o deps.svg -f svg`
3636

3737
Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)
3838

Diff for: exe/cpp_dependency_graph

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ doc = <<DOCOPT
5151
-v --version show version and exit
5252
-r --root_dir dir top level root directory of C/C++ project
5353
-o --output_file file name of output file to be generated [default: deps.html]
54-
-f --output_format format format of output file (dot, html, graphml, json) [default: html]
54+
-f --output_format format format of output file (svg, html, graphml, json) [default: html]
5555
--component component component generate visualisation for (case sensitive!)
5656
--header file header file to generate visualisation for (case sensitive!)
5757
DOCOPT

Diff for: lib/cpp_dependency_graph.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
require_relative 'cpp_dependency_graph/circle_packing_visualiser'
44
require_relative 'cpp_dependency_graph/component_dependency_graph'
55
require_relative 'cpp_dependency_graph/dir_tree'
6-
require_relative 'cpp_dependency_graph/graph_to_dot_visualiser'
76
require_relative 'cpp_dependency_graph/graph_to_html_visualiser'
7+
require_relative 'cpp_dependency_graph/graph_to_svg_visualiser'
88
require_relative 'cpp_dependency_graph/include_component_dependency_graph'
99
require_relative 'cpp_dependency_graph/include_file_dependency_graph'
1010
require_relative 'cpp_dependency_graph/project'
@@ -63,8 +63,8 @@ def generate_cyclic_dependencies(project_dir, format, file)
6363

6464
def generate_visualisation(deps, format, file)
6565
case format
66-
when 'dot'
67-
GraphToDotVisualiser.new.generate(deps, file)
66+
when 'svg'
67+
GraphToSvgVisualiser.new.generate(deps, file)
6868
when 'html'
6969
GraphToHtmlVisualiser.new.generate(deps, file)
7070
when 'json'

Diff for: lib/cpp_dependency_graph/graph_to_dot_visualiser.rb renamed to lib/cpp_dependency_graph/graph_to_svg_visualiser.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
require 'ruby-graphviz'
44

55
# Outputs a `dot` language representation of a dependency graph
6-
class GraphToDotVisualiser
6+
class GraphToSvgVisualiser
77
def generate(deps, file)
88
@g = GraphViz.new('dependency_graph')
99
create_nodes(deps)
1010
connect_nodes(deps)
11-
@g.output(dot: file)
11+
@g.output(svg: file)
1212
end
1313

1414
private

Diff for: lib/cpp_dependency_graph/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
22

33
module CppDependencyGraph
4-
VERSION = '0.4.1'
4+
VERSION = '0.4.2'
55
end

0 commit comments

Comments
 (0)