js_dependency 0.3.14 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249f9142ce332c3874696fb62d0478365ed719caea8088c75b4059ade79931cb
-  data.tar.gz: cf44ea94425033c0905d29f496c65d0bbf32c45d7fc8d3681ad1d5a66e9762d0
+  metadata.gz: c40c515c695755869134ea2cda376981c48e4202648fc4946d66219b93d5917b
+  data.tar.gz: c185eaf95efb2f6a8c11abd91380b2f736c8ddee5dc410f7ea0dab44641eb0aa
 SHA512:
-  metadata.gz: a4427662cc2db7567b4bb041416aea5b7b5d60f16a7c112e215670de211c20b4457265f95d087647bc934d96a3f5fa1052e7078c610f056fb0dbf0525c6cc0d9
-  data.tar.gz: 2ee5a1db44106a777b7b583204db51fcc37315635101a995bf79110cc99a3e05c0fb1434c2e9a6c4becbd7615237facd0e9ed9b53ca1522d98a85c07bd490302
+  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,20 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-21 04:15:24 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
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 31
+  Max: 32
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 118
+  Max: 120
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
@@ -24,12 +24,12 @@ Metrics/CyclomaticComplexity:
 # Offense count: 10
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 19
+  Max: 22
 
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 9
+  Max: 10
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
@@ -37,6 +37,11 @@ Metrics/PerceivedComplexity:
   Max: 15
 
 # 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

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## [Unreleased]
 
-## [0.3.14] - 2022-08-14
+## [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.
 

data/Gemfile.lock

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

data/README.md

@@ -91,9 +91,11 @@ js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e exclu
 #### 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
+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:
 
 ```
@@ -101,10 +103,9 @@ Like this:
 
 ### Orphan modules
 
-3 orphaned modules.
+2 orphaned modules.
 
 * ``components/sub/Exclude.vue``
-* ``pages/app.js``
 * ``utils/calculation.js``
 
 ### Module dependency
@@ -129,10 +130,9 @@ style utils_calculation.js stroke:#f9f,stroke-width:4px
 
 ### Orphan modules
 
-3 orphaned modules.
+2 orphaned modules.
 
 * ``components/sub/Exclude.vue``
-* ``pages/app.js``
 * ``utils/calculation.js``
 
 ### Module dependency

data/lib/js_dependency/cli.rb

@@ -121,7 +121,7 @@ module JsDependency
     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)
@@ -133,7 +133,8 @@ module JsDependency
         alias_paths: config.alias_paths,
         name_level: config.name_level,
         excludes: config.excludes,
-        identifier: config.identifier
+        identifier: config.identifier,
+        exclude_output_names: config.exclude_output_names
       )
     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, :identifier
+                  :alias_paths, :name_level, :excludes, :identifier, :exclude_output_names
 
       # @param [Hash] options
       # @param [Hash] args
@@ -21,6 +21,7 @@ module JsDependency
         @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

@@ -10,7 +10,7 @@ module JsDependency
       # @param [nil, String] identifier
       def initialize(orphan_list, mermaid_markdown, identifier: nil)
         @orphan_list = orphan_list || []
-        @mermaid_markdown = mermaid_markdown || ""
+        @mermaid_markdown = mermaid_markdown
         @identifier = identifier || "js_dependency_report_identifier"
       end
 
@@ -30,17 +30,22 @@ module JsDependency
           markdown += "#{@orphan_list.map { |str| "* ``#{str}``" }.join("\n")}\n\n"
         end
 
-        markdown += <<~"MAKRDOWNTEXT"
-          ### Module dependency
+        markdown += "### Module dependency\n\n"
 
-          ```mermaid
-        MAKRDOWNTEXT
-        markdown += @mermaid_markdown.to_s
+        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 += <<~"MAKRDOWNTEXT"
-          ```
+          markdown += @mermaid_markdown.to_s
 
-        MAKRDOWNTEXT
+          markdown += <<~"MAKRDOWNTEXT"
+            ```
+
+          MAKRDOWNTEXT
+        end
 
         markdown += "<!-- #{@identifier} -->"
         markdown

data/lib/js_dependency/version.rb

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

data/lib/js_dependency.rb

@@ -36,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
@@ -137,19 +141,23 @@ module JsDependency
   # @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)
+                                  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.14
+  version: 0.3.15
 platform: ruby
 authors:
 - junara