js_dependency 0.3.13 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b9f351689b4d75a421eda510b534970d54309e031496ed3b1e01e25b0ff0a2
-  data.tar.gz: bc0d1e40069754c33aa375b14dbc4d7e29a4d3ae09125dc330a03d4daf0dc4ab
+  metadata.gz: 249f9142ce332c3874696fb62d0478365ed719caea8088c75b4059ade79931cb
+  data.tar.gz: cf44ea94425033c0905d29f496c65d0bbf32c45d7fc8d3681ad1d5a66e9762d0
 SHA512:
-  metadata.gz: 43af3b1752058c11f4d549275a2cb0bc969fc00cf57c00c72ad5af857fc4af321e918e7858fc79677c8822a5a73c9c3d43995239574be5975603fa03f60a9da8
-  data.tar.gz: 931e374285441b95d3a00de41318532e62ce40933969e30a937c8cc175bd1615eb29f5f2e2464db24966bd59ff3ee86f13e103e8f8b61ffe45ee5f0ad8f40938
+  metadata.gz: a4427662cc2db7567b4bb041416aea5b7b5d60f16a7c112e215670de211c20b4457265f95d087647bc934d96a3f5fa1052e7078c610f056fb0dbf0525c6cc0d9
+  data.tar.gz: 2ee5a1db44106a777b7b583204db51fcc37315635101a995bf79110cc99a3e05c0fb1434c2e9a6c4becbd7615237facd0e9ed9b53ca1522d98a85c07bd490302

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config --exclude-limit 1`
-# on 2022-08-14 11:04:22 UTC using RuboCop version 1.35.0.
+# `rubocop --auto-gen-config`
+# on 2022-08-21 04:15:24 UTC using RuboCop version 1.35.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,19 +9,24 @@
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 29
+  Max: 31
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 118
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 15
 
-# Offense count: 7
+# Offense count: 10
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
   Max: 19
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.14] - 2022-08-14
+
+- Add export_markdown_report cli. This will export the markdown report to a file for GitHub comment.
+
 ## [0.3.13] - 2022-08-14
 
 - Add rspec test.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.3.13)
+    js_dependency (0.3.14)
       pathname
       thor
       yaml

data/README.md

@@ -88,6 +88,70 @@ js_dependency -s ./src -t ./src/App.vue ./src/components/Sub.vue -o ./mermaid.tx
 js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e excludeWord1 excludeWord2 -a @:./pages
 ```
 
+#### Export Markdown report
+
+```shell
+js_dependency export_markdown_report -s ./src -t ./src/App.vue -c 2 -p 2 -n 1 -a @:./pages --identifier your_uniq_identifier_for_upsert_report
+```
+
+Like this:
+
+```
+## JsDependency Reports
+
+### Orphan modules
+
+3 orphaned modules.
+
+* ``components/sub/Exclude.vue``
+* ``pages/app.js``
+* ``utils/calculation.js``
+
+### Module dependency
+
+\```mermaid
+flowchart LR
+components_Button["components/Button"] --> components_sub_Title.vue["sub/Title.vue"]
+components_Button["components/Button"] --> fixtures_index_creator_self_call_src_components_sub_Exclude["sub/Exclude"]
+components_New.vue["components/New.vue"] --> components_Button["components/Button"]
+components_New.vue["components/New.vue"] --> components_modal.js["components/modal.js"]
+pages_app.js["pages/app.js"] --> components_New.vue["components/New.vue"]
+utils_calculation.js["utils/calculation.js"] --> external_lib["external/lib"]
+style components_New.vue stroke:#f9f,stroke-width:4px
+style utils_calculation.js stroke:#f9f,stroke-width:4px
+\```
+
+<!-- identifier -->
+
+```
+
+## JsDependency Reports
+
+### Orphan modules
+
+3 orphaned modules.
+
+* ``components/sub/Exclude.vue``
+* ``pages/app.js``
+* ``utils/calculation.js``
+
+### Module dependency
+
+```mermaid
+flowchart LR
+components_Button["components/Button"] --> components_sub_Title.vue["sub/Title.vue"]
+components_Button["components/Button"] --> fixtures_index_creator_self_call_src_components_sub_Exclude["sub/Exclude"]
+components_New.vue["components/New.vue"] --> components_Button["components/Button"]
+components_New.vue["components/New.vue"] --> components_modal.js["components/modal.js"]
+pages_app.js["pages/app.js"] --> components_New.vue["components/New.vue"]
+utils_calculation.js["utils/calculation.js"] --> external_lib["external/lib"]
+style components_New.vue stroke:#f9f,stroke-width:4px
+style utils_calculation.js stroke:#f9f,stroke-width:4px
+```
+
+<!-- identifier -->
+
+
 #### Export parents components list
 
 ```shell

data/lib/js_dependency/cli.rb

@@ -109,5 +109,32 @@ module JsDependency
     def version
       puts JsDependency::VERSION
     end
+
+    desc "export_markdown_report", "Output markdown formatted report."
+    method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    method_option :target_paths, type: :array, aliases: "-t", desc: "Target file that you want to analyze."
+    method_option :output_path, type: :string, aliases: "-o", desc: "Output file path"
+    method_option :child_analyze_level, type: :numeric, aliases: "-c", desc: "Output level of child dependency"
+    method_option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
+    method_option :name_level, type: :numeric, aliases: "-n", desc: "Output name level"
+    method_option :excludes, type: :array, aliases: "-e", desc: "Exclude the word that is included in the path"
+    method_option :alias_paths, type: :hash, aliases: "-a", desc: "Alias paths by hash format."
+    method_option :file_config, type: :string, aliases: "-f", desc: "Configuration file path."
+    method_option :identifier, type: :string, desc: "Embed id in markdown."
+
+    def export_markdown_report
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
+      config = JsDependency::CliUtils::Config.new(options, args)
+      puts JsDependency.export_markdown_report(
+        config.src_path,
+        config.target_paths,
+        child_analyze_level: config.child_analyze_level,
+        parent_analyze_level: config.parent_analyze_level,
+        alias_paths: config.alias_paths,
+        name_level: config.name_level,
+        excludes: config.excludes,
+        identifier: config.identifier
+      )
+    end
   end
 end

data/lib/js_dependency/cli_utils/config.rb

@@ -4,7 +4,7 @@ module JsDependency
   module CliUtils
     class Config
       attr_reader :src_path, :target_paths, :target_path, :child_analyze_level, :parent_analyze_level, :output_path,
-                  :alias_paths, :name_level, :excludes
+                  :alias_paths, :name_level, :excludes, :identifier
 
       # @param [Hash] options
       # @param [Hash] args
@@ -20,6 +20,7 @@ module JsDependency
         @alias_paths = options[:alias_paths] || args[:alias_paths] || {}
         @name_level = options[:name_level] || args[:name_level] || 1
         @excludes = calc_excludes(options[:excludes], args[:excludes])
+        @identifier = options[:identifier] || nil
       end
 
       private

data/lib/js_dependency/report/markdown.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module JsDependency
+  module Report
+    class Markdown
+      attr_reader :orphan_list, :mermaid_markdown, :identifier
+
+      # @param [Array] orphan_list
+      # @param [String] mermaid_markdown
+      # @param [nil, String] identifier
+      def initialize(orphan_list, mermaid_markdown, identifier: nil)
+        @orphan_list = orphan_list || []
+        @mermaid_markdown = mermaid_markdown || ""
+        @identifier = identifier || "js_dependency_report_identifier"
+      end
+
+      # @return [String]
+      def export
+        markdown = <<~"MAKRDOWNTEXT"
+          ## JsDependency Reports
+
+          ### Orphan modules
+
+        MAKRDOWNTEXT
+
+        if @orphan_list.empty?
+          markdown += "No orphaned module !\n\n"
+        else
+          markdown += "#{@orphan_list.size} orphaned modules.\n\n"
+          markdown += "#{@orphan_list.map { |str| "* ``#{str}``" }.join("\n")}\n\n"
+        end
+
+        markdown += <<~"MAKRDOWNTEXT"
+          ### Module dependency
+
+          ```mermaid
+        MAKRDOWNTEXT
+        markdown += @mermaid_markdown.to_s
+
+        markdown += <<~"MAKRDOWNTEXT"
+          ```
+
+        MAKRDOWNTEXT
+
+        markdown += "<!-- #{@identifier} -->"
+        markdown
+      end
+    end
+  end
+end

data/lib/js_dependency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsDependency
-  VERSION = "0.3.13"
+  VERSION = "0.3.14"
 end

data/lib/js_dependency.rb

@@ -9,6 +9,7 @@ require_relative "js_dependency/mermaid/target_pathname"
 require_relative "js_dependency/source_analysis/leave"
 require_relative "js_dependency/source_analysis/orphan"
 require_relative "js_dependency/pathname_utility"
+require_relative "js_dependency/report/markdown"
 require_relative "js_dependency/cli_utils/yaml"
 require_relative "js_dependency/cli_utils/config"
 require "pathname"
@@ -123,4 +124,33 @@ module JsDependency
     output_pathname&.write(output.sort.join("\n"))
     output
   end
+
+  # @param [String] src_path
+  # @param [Array<String>] target_paths
+  # @param [String] orientation
+  # @param [Hash, nil] alias_paths
+  # @param [Integer] child_analyze_level
+  # @param [Integer] parent_analyze_level
+  # @param [Integer] name_level
+  # @param [String, nil] output_path
+  # @param [Array, nil] excludes
+  # @param [String, nil] identifier
+  # @return [String]
+  def self.export_markdown_report(src_path, target_paths, orientation: "LR", alias_paths: nil, child_analyze_level: 1,
+                                  parent_analyze_level: 1, name_level: 1, excludes: nil, identifier: nil)
+    mermaid_markdown = JsDependency.export_mermaid(
+      src_path,
+      target_paths,
+      orientation: orientation,
+      alias_paths: alias_paths,
+      child_analyze_level: child_analyze_level,
+      parent_analyze_level: parent_analyze_level,
+      name_level: name_level,
+      excludes: excludes
+    )
+
+    orphan_list = JsDependency.orphan(src_path, alias_paths: alias_paths)
+
+    JsDependency::Report::Markdown.new(orphan_list, mermaid_markdown, identifier: identifier).export
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.14
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname
@@ -170,6 +170,7 @@ files:
 - lib/js_dependency/mermaid/target_pathname.rb
 - lib/js_dependency/pathname_utility.rb
 - lib/js_dependency/replace_path_alias.rb
+- lib/js_dependency/report/markdown.rb
 - lib/js_dependency/source_analysis/leave.rb
 - lib/js_dependency/source_analysis/orphan.rb
 - lib/js_dependency/target_pathname.rb