js_dependency 0.3.12 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a4e8c31528eb944e9acf98aaf37710cffb27728f6e5c9b7337f85dcf5a3ca13
-  data.tar.gz: fb428fe8a8eca603ebef72f19771d8b8d94235d782ccb301e2de7bb11da0a004
+  metadata.gz: c40c515c695755869134ea2cda376981c48e4202648fc4946d66219b93d5917b
+  data.tar.gz: c185eaf95efb2f6a8c11abd91380b2f736c8ddee5dc410f7ea0dab44641eb0aa
 SHA512:
-  metadata.gz: 7531ac4e27d5ec92a7efeea5e13051baed6471d7b059c622bd2aa21885a9d09bfcf9767c99bc59812adf1de6b333e60374518a888a7f3ef704d64a0d827ac812
-  data.tar.gz: 818a5e4210088a3f3d240a18d437909842c46619636e0c38cac1ffd3444659812e2b3a13dfe10b98f39bc4561fb8f52594696374159215f8d4bd29214f436cd1
+  metadata.gz: af9562638595533ae8cda360e0a5575909a3d36f376e47d863988b0e2ced296853cafda54468530c8484c63516d304ce8e7180e7491491461748778df340eb06
+  data.tar.gz: f2f0046905e4906585b47b89b50d37e767b96498d49680202346105ac78f07322cb4eb69471611e326031d654c37e6bb3ef4d37c72d7b1e29c8f4a45220d106b

data/.js_dependency.yml.sample

@@ -12,3 +12,5 @@ alias_paths:
 excludes:
   - excludedWord1
   - excludedWord2
+exclude_output_names:
+  - pages

data/.rubocop_todo.yml

@@ -1,44 +1,49 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-13 15:05:03 UTC using RuboCop version 1.35.0.
+# on 2022-08-21 08:22:13 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-Lint/UselessAssignment:
-  Exclude:
-    - 'spec/js_dependency_spec.rb'
-
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 29
+  Max: 32
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 120
 
 # 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
+  Max: 22
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 9
+  Max: 10
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/PerceivedComplexity:
   Max: 15
 
-# Offense count: 18
+# Offense count: 1
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 6
+
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 187
+  Max: 183

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.3.15] - 2022-08-21
+
+- Add exclude_output_names option for export_markdown_report.
+
+## [0.3.14] - 2022-08-21
+
+- 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.
+
 ## [0.3.12] - 2022-08-14
 
 - Add rspec test.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.3.12)
+    js_dependency (0.3.15)
       pathname
       thor
       yaml
@@ -14,9 +14,9 @@ GEM
     codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    debug (1.5.0)
+    debug (1.6.2)
       irb (>= 1.3.6)
-      reline (>= 0.2.7)
+      reline (>= 0.3.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     io-console (0.5.11)
@@ -58,14 +58,14 @@ GEM
       rspec (>= 2.13, < 4)
       unparser
     rspec-support (3.11.0)
-    rubocop (1.34.1)
+    rubocop (1.35.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)

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 --exclude_output_names pages
+```
+
+``--exclude_output_names`` option is used to exclude outputs from orphan list by name matching. In following results, include pages file is excluded from orphan.
+
+Like this:
+
+```
+## JsDependency Reports
+
+### Orphan modules
+
+2 orphaned modules.
+
+* ``components/sub/Exclude.vue``
+* ``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
+
+2 orphaned modules.
+
+* ``components/sub/Exclude.vue``
+* ``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,33 @@ 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."
+    method_option :exclude_output_names, type: :array, desc: "Exclude output names"
+    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,
+        exclude_output_names: config.exclude_output_names
+      )
+    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, :exclude_output_names
 
       # @param [Hash] options
       # @param [Hash] args
@@ -20,6 +20,8 @@ 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
+        @exclude_output_names = options[:exclude_output_names] || []
       end
 
       private

data/lib/js_dependency/pathname_utility.rb

@@ -46,5 +46,14 @@ module JsDependency
         pathname.to_s
       end
     end
+
+    # @param [Array<String>] paths
+    # @return [Array<String>]
+    def self.filter_js_files(paths)
+      return paths if paths.nil? || paths.empty?
+
+      permitted_extnames = %w[.js .vue .jsx]
+      paths.filter { |path| permitted_extnames.include?(Pathname.new(path).extname) }
+    end
   end
 end

data/lib/js_dependency/report/markdown.rb

@@ -0,0 +1,55 @@
+# 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 += "### Module dependency\n\n"
+
+        if @mermaid_markdown.nil? || @mermaid_markdown.empty?
+          markdown += ".vue or .js or .jsx files are not changed.\n\n"
+        else
+          markdown += <<~"MAKRDOWNTEXT"
+            ```mermaid
+          MAKRDOWNTEXT
+
+          markdown += @mermaid_markdown.to_s
+
+          markdown += <<~"MAKRDOWNTEXT"
+            ```
+
+          MAKRDOWNTEXT
+        end
+
+        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.12"
+  VERSION = "0.3.15"
 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"
@@ -35,9 +36,13 @@ module JsDependency
   # @param [String] src_path
   # @param [Hash, nil] alias_paths
   # @return [Array<String>]
-  def self.orphan(src_path, alias_paths: nil)
+  def self.orphan(src_path, alias_paths: nil, exclude_output_names: [])
     index = JsDependency::IndexCreator.call(src_path, alias_paths: alias_paths)
-    JsDependency::SourceAnalysis::Orphan.new(index, src_path).call
+    JsDependency::SourceAnalysis::Orphan.new(index, src_path).call.filter do |path|
+      exclude_output_names.none? do |name|
+        path.include?(name)
+      end
+    end
   end
 
   # @param [String] src_path
@@ -123,4 +128,37 @@ 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, exclude_output_names: [])
+    permitted_target_paths = JsDependency::PathnameUtility.filter_js_files(target_paths)
+    mermaid_markdown = if target_paths.nil? || target_paths.empty?
+                         nil
+                       else
+                         JsDependency.export_mermaid(
+                           src_path,
+                           permitted_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
+                         )
+                       end
+    orphan_list = JsDependency.orphan(src_path, alias_paths: alias_paths, exclude_output_names: exclude_output_names)
+
+    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.12
+  version: 0.3.15
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-13 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