js_dependency 0.3.8 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a376c442837e1a87365b91b1f13b46e048f271078e691425350237066e1f567d
-  data.tar.gz: 606813cc029e62b21c7073409c8312c27104adada8b3e3e33877075fde15d2cc
+  metadata.gz: a61cec11e64fc475a0fb7838b11abf8ab6a1a0d8cfab0929e475eff2fcbef6c0
+  data.tar.gz: 461e0b8503aec5ab25f7b3508ae420af41f72022e39a4e1388a8ae8217858ac1
 SHA512:
-  metadata.gz: da8c831e0eec9e3251597874af4b067efb2079c651e46341beb5a8f34b70b857c2960f134cd0db6fc8e8cf380090b70d87732891d8161ecfbdfe7756179d7cba
-  data.tar.gz: 3513921cc2068f220fcd5ca001d59339a361e36fe76c9bf9ca5f4bc4f5ba5cf91ac0f220c72814cad02a44e6ed9ddc11421721a6d20d1f1a010b7bec5422893f
+  metadata.gz: c2e5483e130e608b4a21741ffccf44db1f812a6096b9f4c5df419cb97029f340c9c8ba770542133d528a213720f924282e9cd72bfd6cc135606904a594c20ed1
+  data.tar.gz: ae67a36c93fdb56ddc5a59c6244d78b7c58f08399d72a725a6d655e945f518c2a14f517c6253dde5cf26516c1cf30a5834ac77cc752e0a67a51301c13d2576e2

data/.js_dependency.yml.sample

@@ -1,5 +1,8 @@
 src_path: ./src
 target_path: ./src/App.vue
+target_paths:
+  - ./src/App1.vue
+  - ./src/App2.vue
 child_analyze_level: 2
 parent_analyze_level: 2
 name_level: 1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-11 12:19:56 UTC using RuboCop version 1.34.1.
+# on 2022-08-13 05:13:43 UTC using RuboCop version 1.34.1.
 # 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,12 +9,12 @@
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 31
+  Max: 29
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 18
+  Max: 15
 
 # Offense count: 8
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
@@ -29,14 +29,14 @@ Metrics/ParameterLists:
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 19
+  Max: 15
 
 # Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
     - 'lib/js_dependency/mermaid/root.rb'
 
-# Offense count: 6
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.3.11] - 2022-08-13
+
+- Add target_paths options in configuration file to use array.
+
+## [0.3.10] - 2022-08-13
+
+- Add file_config options to specify configuration yaml which user like.
+
+## [0.3.9] - 2022-08-12
+
+- Add alias_paths options of hash.
+
 ## [0.3.8] - 2022-08-11
 
 - `.js_dependecy.yaml` is arrowed for configuration file name.

data/Gemfile.lock

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

data/README.md

@@ -35,6 +35,9 @@ Configuration file is `./.js_dependency.yml`. This file includes parameters for
 ```yaml
 src_path: ./src # Root folder
 target_path: ./src/App.vue # Target file tha you want to analyze
+target_paths: # Target files tha you want to analyze
+  - ./src/App1.vue
+  - ./src/App2.vue
 child_analyze_level: 2 # Output level of child analyze
 parent_analyze_level: 2 # Output level of parent analyze
 name_level: 1 # Output name level
@@ -46,6 +49,12 @@ excludes: # Exclude words that you want to skip from export.
   - excludeWord2
 ```
 
+If you want to specify .js_dependency.yml as another path, you can add option path by `-f` option.
+
+```shell
+js_dependency -f path/to/yourfilename.yml
+```
+
 Each parameter is overridden by the command line.
 
 ```
@@ -56,6 +65,7 @@ parent_analyze_level -> -p
 name_level -> -n
 output_path -> -o
 exclude -> -e
+alias_paths -> -a
 ```
 
 #### Export Mermaid Format
@@ -63,31 +73,31 @@ exclude -> -e
 ##### Single target path
 
 ```shell
-js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1
+js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -a @:./pages
 ```
 
 ##### Multiple target paths
 
 ```shell
-js_dependency -s ./src -t ./src/App.vue ./src/components/Sub.vue -o ./mermaid.txt -c 2 -p 2 -n 1
+js_dependency -s ./src -t ./src/App.vue ./src/components/Sub.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -a @:./pages
 ```
 
-##### Exclude path which iclude exclude words `-e` from output
+##### Exclude path which include exclude words `-e` from output
 
 ```shell
-js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e excludeWord1 excludeWord2
+js_dependency -s ./src -t ./src/App.vue -o ./mermaid.txt -c 2 -p 2 -n 1 -e excludeWord1 excludeWord2 -a @:./pages
 ```
 
 #### Export parents components list
 
 ```shell
-js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2
+js_dependency parents -s ./src -t ./src/App.vue -o ./parents.txt -p 2 -a @:./pages
 ```
 
 #### Export children components list
 
 ```shell
-js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
+js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2 -a @:./pages
 ```
 
 #### Export orphan components list
@@ -95,7 +105,7 @@ js_dependency childrent -s ./src -t ./src/App.vue -o ./children.txt -c 2
 Components that are not used in other components.
 
 ```shell
-js_dependency orphan -s ./src
+js_dependency orphan -s ./src -a @:./pages
 ```
 
 #### Export left components list
@@ -103,7 +113,7 @@ js_dependency orphan -s ./src
 Components that do not import other components.
 
 ```shell
-js_dependency leave -s ./src
+js_dependency leave -s ./src -a @:./pages
 ```
 
 ### By ruby code

data/lib/js_dependency/cli.rb

@@ -15,9 +15,11 @@ module JsDependency
     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."
 
     def export_mermaid
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.export_mermaid(
         config.src_path,
@@ -37,9 +39,11 @@ module JsDependency
     method_option :output_path, type: :string, aliases: "-o", desc: "Output file path"
     method_option :parent_analyze_level, type: :numeric, aliases: "-p", desc: "Output level of parent dependency"
     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."
 
     def parents
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.parents(
         config.src_path,
@@ -57,9 +61,11 @@ module JsDependency
     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 :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."
 
     def children
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.children(
         config.src_path,
@@ -73,9 +79,11 @@ module JsDependency
 
     desc "orphan", "export components than is not depended by others"
     method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    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."
 
     def orphan
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.orphan(
         config.src_path,
@@ -85,9 +93,11 @@ module JsDependency
 
     desc "leave", "export components than is not depended by others"
     method_option :src_path, type: :string, aliases: "-s", desc: "Root folder."
+    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."
 
     def leave
-      args = JsDependency::CliUtils::Yaml.new.args
+      args = JsDependency::CliUtils::Yaml.new(path: options[:file_config]).args
       config = JsDependency::CliUtils::Config.new(options, args)
       puts JsDependency.leave(
         config.src_path,

data/lib/js_dependency/cli_utils/config.rb

@@ -10,18 +10,82 @@ module JsDependency
       # @param [Hash] args
       def initialize(options, args)
         @src_path = options[:src_path] || args[:src_path]
-        @target_paths = options[:target_paths] || (args[:target_path].is_a?(String) ? [args[:target_path]] : args[:target_path])
-        @target_path = options[:target_path] || args[:target_path]
+        @target_paths = calc_target_paths(options[:target_path], options[:target_paths], args[:target_path],
+                                          args[:target_paths])
+        @target_path = calc_target_path(options[:target_path], options[:target_paths], args[:target_path],
+                                        args[:target_paths])
         @child_analyze_level = options[:child_analyze_level] || args[:child_analyze_level] || 2
         @parent_analyze_level = options[:parent_analyze_level] || args[:parent_analyze_level] || 2
         @output_path = options[:output_path] || args[:output_path] || nil
-        @alias_paths = args[:alias_paths] || nil
+        @alias_paths = options[:alias_paths] || args[:alias_paths] || {}
         @name_level = options[:name_level] || args[:name_level] || 1
-        @excludes = if options[:excludes]&.length&.positive?
-                      options[:excludes]
-                    elsif args[:excludes]
-                      args[:excludes]
-                    end
+        @excludes = calc_excludes(options[:excludes], args[:excludes])
+      end
+
+      private
+
+      # @param [String, Array, nil] option_target_path
+      # @param [String, Array, nil] option_target_paths
+      # @param [String, Array, nil] args_target_path
+      # @param [String, Array, nil] args_target_paths
+      # @return [nil, Array]
+      def calc_target_paths(option_target_path, option_target_paths, args_target_path, args_target_paths)
+        [option_target_paths, option_target_path, args_target_paths, args_target_path].each do |obj|
+          return as_array(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [String, Array, nil] option_target_path
+      # @param [String, Array, nil] option_target_paths
+      # @param [String, Array, nil] args_target_path
+      # @param [String, Array, nil] args_target_paths
+      # @return [nil, String]
+      def calc_target_path(option_target_path, option_target_paths, args_target_path, args_target_paths)
+        [option_target_path, option_target_paths, args_target_path, args_target_paths].each do |obj|
+          return as_string_or_first(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [Object] option_excludes
+      # @param [Object] args_excludes
+      # @return [nil, Array]
+      def calc_excludes(option_excludes, args_excludes)
+        [option_excludes, args_excludes].each do |obj|
+          return as_array(obj) if present?(obj)
+        end
+
+        nil
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [TrueClass, FalseClass]
+      def present?(obj)
+        return false if obj.nil?
+        return false if obj.empty?
+
+        true
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [Array, nil]
+      def as_array(obj)
+        return nil if obj.nil?
+        return obj if obj.is_a?(Array)
+
+        [obj]
+      end
+
+      # @param [Array, String, nil] obj
+      # @return [String, nil]
+      def as_string_or_first(obj)
+        return nil if obj.nil?
+        return obj if obj.is_a?(String)
+
+        return obj.first if obj.is_a?(Array)
       end
     end
   end

data/lib/js_dependency/cli_utils/yaml.rb

@@ -3,22 +3,42 @@
 module JsDependency
   module CliUtils
     class Yaml
-      attr_reader :args,
-                  :dir_path
+      attr_reader :dir_path,
+                  :path
 
       # @param [String, nil] dir_path
-      def initialize(dir_path: nil)
-        @dir_path = dir_path || Dir.pwd
-        pathname = config_pathname
-        @args = if pathname.nil?
-                  {}
-                else
-                  symbolize_keys(YAML.safe_load(pathname.read))
-                end
+      # @param [String, nil] path
+      def initialize(dir_path: nil, path: nil)
+        @dir_path = present?(dir_path) ? dir_path : Dir.pwd
+        @path = path
+      end
+
+      # @return [Hash]
+      def args
+        pathname = if present?(@path)
+                     Pathname.new(@path)
+                   else
+                     config_pathname
+                   end
+
+        if pathname.nil?
+          {}
+        else
+          symbolize_keys(YAML.safe_load(pathname.read))
+        end
       end
 
       private
 
+      # @param [String] str
+      # @return [TrueClass, FalseClass]
+      def present?(str)
+        return false if str.nil?
+        return false if str.empty?
+
+        true
+      end
+
       # @return [Pathname, nil]
       def config_pathname
         dir_pathname = Pathname.new(@dir_path)

data/lib/js_dependency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.11
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname