js_dependency 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68994e61c025f75290a28d6d14e1004c54c09ad32d54f3c93fc5626d9621fcd2
-  data.tar.gz: f8dcb17dc254e873d217ecce20ec2e739d1c53c9935cbc6e163941d53a033f2a
+  metadata.gz: 20217229c2c7f845d05b400f356240d4e2db4d46f9b4d1fc6662868bc1bac372
+  data.tar.gz: d74ccf10be4764621ff17bc2700c56b8947263b5dc35bccaab49101df90eea59
 SHA512:
-  metadata.gz: 46891feebfed8de0c5fe551b3e176e48d38f17359c6322fd68893c6a0b101394981b5e97385079069c20b93df198c5e8abbb211a3d482609101ad5db06a81197
-  data.tar.gz: ab70ef7054409bc108c68ed0b376feaa110c59543769c91f232940b75cfe81917ca2ca4a7c2c3881b89dd3247fa49d8f03c27bf4b70f7bc14b14e14a8f31b7d1
+  metadata.gz: a842902a4bf0331ea00352315682bf4efb8ac6891dfa2fcfedff0d5ecdfada5d8cf1240ebc6e02a5f8b8ac8a6df54d85c47e4140ac581601d43dbb7a16f3fb2d
+  data.tar.gz: 919130f6a767b0dc51533cacee935c810da0a8460ab74e86536704fea8614289fa45025c8b3d9edd62a48782bc463e632256b3c9868f849bcb93cf006859c035

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-07-19
+
+- Bug fix of double quotation mark.
+
 ## [0.1.0] - 2022-07-16
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js_dependency (0.1.0)
+    js_dependency (0.1.1)
       pathname
 
 GEM

data/README.md

@@ -2,7 +2,7 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/js_dependency`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+Analyze import dependency of JavaScript code and export mermaid format.
 
 ## Installation
 
@@ -15,8 +15,30 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install js_dependency
 
 ## Usage
+If your javascript code is in `./src` and `./src/App.vue` is in the directory, you can analyze `./src/App.vue` dependency like this:
 
-TODO: Write usage instructions here
+```ruby
+require 'js_dependency'
+
+
+src_path = './src' # Root folder.
+target_path = './src/App.vue' # Target file that you want to analyze.
+child_analyze_level = 2 # Output level of child dependency.
+parent_analyze_level = 2 # Output level of parent dependency.
+output_path = './mermaid.txt' # Optional. Output file path
+alias_paths = {'@' => '/src' } # Optional. Alias path.
+
+# mermaid出力実行
+JsDependency.export_mermaid(
+  src_path,
+  target_path,
+  child_analyze_level: child_analyze_level,
+  parent_analyze_level: parent_analyze_level,
+  output_path: output_path,
+  alias_paths: alias_paths)
+```
+
+See `./mermaid.txt` of `output_path` for the result.
 
 ## Development
 
@@ -26,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/js_dependency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/js_dependency/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/junara/js_dependency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/js_dependency/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/js_dependency/extract_import_path.rb

@@ -12,11 +12,11 @@ module JsDependency
     def call
       str = @str
       # import defaultExport from 'module-name';
-      paths = str.gsub(/import\s+\S+\s+from\s+"([^']+)"/).with_object([]) { |_, list| list << Regexp.last_match(1) }
+      paths = str.gsub(/import\s+\S+\s+from\s+"([^"]+)"/).with_object([]) { |_, list| list << Regexp.last_match(1) }
       paths += str.gsub(/import\s+\S+\s+from\s+'([^']+)'/).with_object([]) { |_, list| list << Regexp.last_match(1) }
 
       # import * as name from \"module-name\";
-      paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+\s+as\s+\S+\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -28,7 +28,7 @@ module JsDependency
       # import { export1 , export2 } from "module-name";
       # import { foo , bar } from "module-name/path/to/specific/un-exported/file";
       # import { export1 , export2 as alias2 , [...] } from "module-name";
-      paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\{\s+.+\s+\}\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -36,7 +36,7 @@ module JsDependency
       end
 
       # import defaultExport, { export1 [ , [...] ] } from "module-name";
-      paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+,\s+\{\s+.+\s+\}\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -44,7 +44,7 @@ module JsDependency
       end
 
       # import defaultExport, * as name from "module-name";
-      paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+\S+,\s+.+\s+as\s+\S+\s+from\s+'([^']+)'/).with_object([]) do |_, list|
@@ -52,7 +52,7 @@ module JsDependency
       end
 
       # import "module-name";
-      paths += str.gsub(/import\s+"([^']+)"/).with_object([]) do |_, list|
+      paths += str.gsub(/import\s+"([^"]+)"/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\s+'([^']+)'/).with_object([]) do |_, list|
@@ -60,7 +60,7 @@ module JsDependency
       end
 
       # var promise = import("module-name");
-      paths += str.gsub(/import\("([^']+)"\)/).with_object([]) do |_, list|
+      paths += str.gsub(/import\("([^"]+)"\)/).with_object([]) do |_, list|
         list << Regexp.last_match(1)
       end
       paths += str.gsub(/import\('([^']+)'\)/).with_object([]) do |_, list|

data/lib/js_dependency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_dependency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pathname