import_js 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5855fcda8dcbe929e0aecbd16b9b940cb6fa80a
-  data.tar.gz: 458cbb3e52b3358ec99b5c8891f9ae54b06769b9
+  metadata.gz: c90724e922f7ebecab12977097f1b867d83d8f74
+  data.tar.gz: 43cc4828550165c17ca8b07b142c5e033fbbb31f
 SHA512:
-  metadata.gz: e4a57078bbd9ebf4a07fe2f09c6e666fcd118f223c8ac35d54ca8538648a5d920f5ed7883170d905bf40a96969a74aae46aa4b4fc4d424f1451fcae6a0b82f10
-  data.tar.gz: 2722de373880d2530db9eb769543248dc341067fba8cf7791ddac1fc5380cd9fde64b548fc0fbcc8e0d5ea0f51938758da8a4ec62d8c2d7c8a2b4847e0a8c2a7
+  metadata.gz: c6f3b02306c7c21ccc09b13e7246d2c8ddb7c78f05f149d2644b73d1ce8d731d4349e54f68d52bc79b1558d07aa94aba5fe7a809f9f4137410f9cfccd0d4225e
+  data.tar.gz: 105ab5859eaef7bd8d3bd5b31a0725c4000cf833743a786c7d6a1e9a5bac21bcbdc2de79580c565f74fde07a58f4467b004709031695a892d3468d4cc9304b2d

data/lib/import_js/configuration.rb

@@ -6,10 +6,13 @@ module ImportJS
 
   DEFAULT_CONFIG = {
     'aliases' => {},
-    'declaration_keyword' => 'var',
+    'declaration_keyword' => 'import',
+    'eslint_executable' => 'eslint',
     'excludes' => [],
+    'ignore_package_prefixes' => [],
     'lookup_paths' => ['.'],
-    'strip_file_extensions' => ['.js', '.jsx']
+    'strip_file_extensions' => ['.js', '.jsx'],
+    'use_relative_paths' => false
   }
 
   # Class that initializes configuration from a .importjs.json file
@@ -41,14 +44,18 @@ module ImportJS
         path = path.sub(/\{filename\}/,
                         File.basename(path_to_current_file, '.*'))
       end
-      ImportJS::JSModule.new(nil, path, [])
+      ImportJS::JSModule.new(lookup_path: nil,
+                             relative_file_path: path,
+                             strip_file_extensions: [])
     end
 
     def resolve_destructured_alias(variable_name)
       @config['aliases'].each do |_, path|
         next if path.is_a? String
         if (path['destructure'] || []).include?(variable_name)
-          js_module = ImportJS::JSModule.new(nil, path['path'], [])
+          js_module = ImportJS::JSModule.new(lookup_path: nil,
+                                             relative_file_path: path['path'],
+                                             strip_file_extensions: [])
           js_module.is_destructured = true
           return js_module
         end

data/lib/import_js/import_statement.rb

@@ -36,7 +36,7 @@ module ImportJS
         (?<destructured>.*)  # <destructured> variables
         \s*
       \}
-    }x
+    }xm
 
     attr_accessor :assignment
     attr_accessor :original_import_string # a cache of the parsed import string

data/lib/import_js/importer.rb

@@ -90,8 +90,7 @@ module ImportJS
 
     # @return [Array<String>] the output from eslint, line by line
     def run_eslint_command
-      command = %w[
-        eslint
+      command = @config.get('eslint_executable') + ' ' + %w[
         --stdin
         --format unix
         --rule 'no-undef: 2'
@@ -101,12 +100,16 @@ module ImportJS
                                 stdin_data: @editor.current_file_content)
 
       if out =~ /Parsing error: / ||
-         out =~ /Unrecoverable syntax error/
+         out =~ /Unrecoverable syntax error/ ||
+         out =~ /<text>:0:0: Cannot find module '.*'/
         fail ImportJS::ParseError.new, out
       end
 
       if err =~ /SyntaxError: / ||
-         err =~ /eslint: command not found/
+         err =~ /eslint: command not found/ ||
+         err =~ /Cannot read config package: / ||
+         err =~ /Cannot find module '.*'/ ||
+         err =~ /No such file or directory/
         fail ImportJS::ParseError.new, err
       end
 
@@ -167,6 +170,17 @@ module ImportJS
           @editor.tab)
       end.flatten.sort
 
+      # Find old import strings so we can compare with the new import strings
+      # and see if anything has changed.
+      old_import_strings = []
+      old_imports_lines.times do |line|
+        old_import_strings << @editor.read_line(1 + line + imports_start_at)
+      end
+
+      # If nothing has changed, bail to prevent unnecessarily dirtying the
+      # buffer.
+      return if import_strings == old_import_strings
+
       # Delete old imports, then add the modified list back in.
       old_imports_lines.times { @editor.delete_line(1 + imports_start_at) }
       import_strings.reverse_each do |import_string|
@@ -227,16 +241,20 @@ module ImportJS
     # @param variable_name [String]
     # @return [Array]
     def find_js_modules(variable_name)
+      path_to_current_file = @editor.path_to_current_file
       if alias_module = @config.resolve_alias(variable_name,
-                                              @editor.path_to_current_file)
+                                              path_to_current_file)
         return [alias_module]
       end
-
       egrep_command =
         "egrep -i \"(/|^)#{formatted_to_regex(variable_name)}(/index)?(/package)?\.js.*\""
       matched_modules = []
       @config.get('lookup_paths').each do |lookup_path|
-        find_command = "find #{lookup_path} -name \"**.js*\""
+        find_command = %W[
+          find #{lookup_path}
+          -name "**.js*"
+          -not -path "./node_modules/*"
+        ].join(' ')
         out, _ = Open3.capture3("#{find_command} | #{egrep_command}")
         matched_modules.concat(
           out.split("\n").map do |f|
@@ -244,7 +262,13 @@ module ImportJS
               File.fnmatch(glob_pattern, f)
             end
             js_module = ImportJS::JSModule.new(
-              lookup_path, f, @config.get('strip_file_extensions'))
+              lookup_path: lookup_path,
+              relative_file_path: f,
+              strip_file_extensions: @config.get('strip_file_extensions'),
+              make_relative_to: @config.get('use_relative_paths') &&
+                                path_to_current_file
+            )
+
             next if js_module.skip
             js_module
           end.compact
@@ -253,11 +277,19 @@ module ImportJS
 
       # Find imports from package.json
       @config.package_dependencies.each do |dep|
-        next unless dep =~ /^#{formatted_to_regex(variable_name)}$/
-        js_module = ImportJS::JSModule.new(
-          'node_modules', "node_modules/#{dep}/package.json", [])
-        next if js_module.skip
-        matched_modules << js_module
+        ignore_prefixes = @config.get('ignore_package_prefixes')
+        dep_matcher = /^#{formatted_to_regex(variable_name)}$/
+        if dep =~ dep_matcher ||
+           ignore_prefixes.any? do |prefix|
+             dep.sub(/^#{prefix}/, '') =~ dep_matcher
+           end
+          js_module = ImportJS::JSModule.new(
+            lookup_path: 'node_modules',
+            relative_file_path: "node_modules/#{dep}/package.json",
+            strip_file_extensions: [])
+          next if js_module.skip
+          matched_modules << js_module
+        end
       end
 
       # If you have overlapping lookup paths, you might end up seeing the same
@@ -302,10 +334,26 @@ module ImportJS
     def formatted_to_regex(string)
       # Based on
       # http://stackoverflow.com/questions/1509915/converting-camel-case-to-underscore-case-in-ruby
-      string.
-        gsub(/([a-z\d])([A-Z])/, '\1.?\2'). # separates camelCase words with '.?'
-        tr('-_', '.'). # replaces underscores or dashes with '.'
-        downcase # converts all upper to lower case
+
+      # The pattern to match in between words. The "es" and "s" match is there
+      # to catch pluralized folder names. There is a risk that this is overly
+      # aggressive and will lead to trouble down the line. In that case, we can
+      # consider adding a configuration option to control mapping a singular
+      # variable name to a plural folder name (suggested by @lencioni in #127).
+      # E.g.
+      #
+      # {
+      #   "^mock": "./mocks/"
+      # }
+      split_pattern = '(es|s)?.?'
+
+      # Split up the string, allow pluralizing and a single (any) character
+      # in between. This will make e.g. 'fooBar' match 'foos/bar', 'foo_bar',
+      # and 'foobar'.
+      string
+        .gsub(/([a-z\d])([A-Z])/, '\1' + split_pattern + '\2') # camelCase
+        .tr('-_', split_pattern)
+        .downcase
     end
 
     # @return [String]

data/lib/import_js/js_module.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module ImportJS
   # Class that represents a js module found in the file system
   class JSModule
@@ -13,15 +15,25 @@ module ImportJS
     #   the project root.
     # @param strip_file_extensions [Array] a list of file extensions to strip,
     #   e.g. ['.js', '.jsx']
-    def initialize(lookup_path, relative_file_path, strip_file_extensions)
+    # @param make_relative_to [String|nil] a path to a different file which the
+    #   resulting import path should be relative to.
+    def initialize(lookup_path: nil,
+                   relative_file_path: nil,
+                   strip_file_extensions: nil,
+                   make_relative_to: nil)
       @lookup_path = lookup_path
       @file_path = relative_file_path
+
+      if @lookup_path && @lookup_path.start_with?('.')
+        @lookup_path.sub!(/^\.\/?/, '')
+        @file_path.sub!(/^\.\/?/, '')
+      end
       if relative_file_path.end_with? '/package.json'
         @main_file = JSON.parse(File.read(relative_file_path))['main']
         match = relative_file_path.match(/(.*)\/package\.json/)
         @import_path = match[1]
         @skip = !@main_file
-      elsif relative_file_path.match(/\/index\.js.*$/)
+      elsif relative_file_path.match(%r{/index\.js[^/]*$})
         match = relative_file_path.match(/(.*)\/(index\.js.*)/)
         @main_file = match[2]
         @import_path = match[1]
@@ -35,9 +47,34 @@ module ImportJS
         end
       end
 
-      if lookup_path
-        @import_path = @import_path.sub("#{@lookup_path}\/", '') # remove path prefix
+      if @lookup_path
+        @import_path.sub!(/^#{Regexp.escape(@lookup_path)}\//, '')
+        if make_relative_to
+          make_import_path_relative_to(make_relative_to)
+        end
+      end
+    end
+
+    # @param make_relative_to [String]
+    def make_import_path_relative_to(make_relative_to)
+      # First, strip out any absolute path up until the current directory
+      make_relative_to = make_relative_to.sub(Dir.pwd + "\/", '')
+
+      # Ignore if the file to relate to is part of a different lookup_path
+      return unless make_relative_to.start_with? @lookup_path
+
+      # Strip out the lookup_path
+      make_relative_to.sub!(/^#{Regexp.escape(@lookup_path)}\//, '')
+
+      path = Pathname.new(@import_path).relative_path_from(
+        Pathname.new(File.dirname(make_relative_to))
+      ).to_s
+
+      unless path.start_with?('.')
+        # `Pathname.relative_path_from` will not add "./" automatically
+        path = './' + path
       end
+      @import_path = path
     end
 
     # @return [String] a readable description of the module

data/lib/import_js/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module ImportJS
-  VERSION = '0.2.5'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: import_js
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Henric Trotzig