import_js 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2a0036427b0f66373fcbc6fda702570d501f281
-  data.tar.gz: 9c798047e26eb9189e169c5395ed1bd41b03e2fc
+  metadata.gz: 3808c953be3c8a47d0212d952f35b4329774cba8
+  data.tar.gz: f1929ccab0f99004521babc2dbbf8d35347c7313
 SHA512:
-  metadata.gz: 4eaed3ab7c8204e62a7b19bdad9cf002384f6797cd15fe6f6615763ebcda6f8cf607cbb3127f8c494082a53f84684c17e383544f897cd368ae0074101676dc5d
-  data.tar.gz: 43c8abdad3178c4df5c6f04a7030737daa9d2cb4e83cb777e6dbde088a5a43dffa2690ae13e1b1950ce915dc01f5252a75d4747883a9d0777124cf7353541e64
+  metadata.gz: 9380c3f44a4306a0e9d843496bf846c47200e696649a88348135e9c7f1d928e04ad5520d67a7c15beb3306e02af1ad7aa2fd2aaaef983c0eec2463e6ca9fd288
+  data.tar.gz: cc46051020022e9e7ba9db5b4c8750b104ad372bb72442f5fb7712867084f8bfff92f9dcba06826ca77d87a42d4897dfe72b5b96b7fb89f7dcb61d804e684f75

data/lib/import_js/configuration.rb

@@ -57,7 +57,7 @@ module ImportJS
         path = path.sub(/\{filename\}/,
                         File.basename(path_to_current_file, '.*'))
       end
-      ImportJS::JSModule.new(import_path: path)
+      JSModule.new(import_path: path)
     end
 
     # @param variable_name [String]
@@ -66,7 +66,7 @@ module ImportJS
       get('named_exports').each do |import_path, named_exports|
         next unless named_exports.include?(variable_name)
 
-        js_module = ImportJS::JSModule.new(import_path: import_path)
+        js_module = JSModule.new(import_path: import_path)
         js_module.has_named_exports = true
         return js_module
       end
@@ -108,11 +108,11 @@ module ImportJS
     def check_current_version!
       minimum_version = get('minimum_version')
       return if Gem::Dependency.new('', ">= #{minimum_version}")
-                               .match?('', ImportJS::VERSION)
+                               .match?('', VERSION)
 
-      fail ImportJS::ClientTooOldError,
+      fail ClientTooOldError,
            'The .importjs.json file you are using requires version ' \
-           "#{get('minimum_version')}. You are using #{ImportJS::VERSION}."
+           "#{get('minimum_version')}. You are using #{VERSION}."
     end
   end
 end

data/lib/import_js/emacs_editor.rb

@@ -16,13 +16,13 @@ module ImportJS
 
           case command
           when 'import'
-            ImportJS::Importer.new(self).import
+            Importer.new(self).import
             write_file
             puts 'import:success'
           when 'goto'
-            ImportJS::Importer.new(self).goto
+            Importer.new(self).goto
           when 'fix'
-            ImportJS::Importer.new(self).fix_imports
+            Importer.new(self).fix_imports
             write_file
             puts 'import:success'
           else

data/lib/import_js/import_statement.rb

@@ -1,7 +1,7 @@
 module ImportJS
   # Class that represents an import statement, e.g.
   # `const foo = require('foo');`
-  # `let foo = myCustomRequire('foo');`
+  # `var foo = myCustomRequire('foo');`
   # `import foo from 'foo';`
   class ImportStatement
     REGEX_CONST_LET_VAR = /
@@ -50,7 +50,7 @@ module ImportJS
 
     # @param string [String] a possible import statement, e.g.
     #   `const foo = require('foo');`
-    #   `let foo = myCustomRequire('foo');`
+    #   `var foo = myCustomRequire('foo');`
     #   `import foo from 'foo';`
     # @return [ImportJS::ImportStatement?] a parsed statement, or nil if the
     #   string can't be parsed
@@ -138,7 +138,7 @@ module ImportJS
         else
           [default_import_string(max_line_length, tab)]
         end
-      else # const/let/var
+      else # const/var
         strings = []
 
         if default_import

data/lib/import_js/importer.rb

@@ -9,14 +9,14 @@ module ImportJS
     REGEX_MULTI_LINE_COMMENT_END = %r{\*/}
     REGEX_WHITESPACE_ONLY = /\A\s*\Z/
 
-    def initialize(editor = ImportJS::VIMEditor.new)
+    def initialize(editor = VIMEditor.new)
       @editor = editor
     end
 
     # Finds variable under the cursor to import. By default, this is bound to
     # `<Leader>j`.
     def import
-      @config = ImportJS::Configuration.new(@editor.path_to_current_file)
+      reload_config
       variable_name = @editor.current_word
       if variable_name.empty?
         message(<<-EOS.split.join(' '))
@@ -39,17 +39,29 @@ module ImportJS
     end
 
     def goto
-      @config = ImportJS::Configuration.new(@editor.path_to_current_file)
+      reload_config
       js_modules = []
       variable_name = @editor.current_word
       time do
         js_modules = find_js_modules(variable_name)
       end
-      return if js_modules.empty?
-      js_module = resolve_one_js_module(js_modules, variable_name)
-      if js_module
-        @editor.open_file(js_module.open_file_path(@editor.path_to_current_file))
+
+      if js_modules.empty?
+        # No JS modules are found for the variable, so there is nothing to go to
+        # and we return early.
+        return message("No modules were found for `#{variable_name}`")
+      end
+
+      js_module = resolve_goto_module(js_modules, variable_name)
+
+      unless js_module
+        # The current word is not mappable to one of the JS modules that we
+        # found. This can happen if the user does not select one from the list.
+        # We have nothing to go to, so we return early.
+        return message("Could not resolve a module for `#{variable_name}`")
       end
+
+      @editor.open_file(js_module.open_file_path(@editor.path_to_current_file))
     end
 
     REGEX_ESLINT_RESULT = /
@@ -68,7 +80,7 @@ module ImportJS
 
     # Removes unused imports and adds imports for undefined variables
     def fix_imports
-      @config = ImportJS::Configuration.new(@editor.path_to_current_file)
+      reload_config
       eslint_result = run_eslint_command
 
       unused_variables = []
@@ -107,6 +119,13 @@ module ImportJS
 
     private
 
+    # The configuration is relative to the current file, so we need to make sure
+    # that we are operating with the appropriate configuration when we perform
+    # certain actions.
+    def reload_config
+      @config = Configuration.new(@editor.path_to_current_file)
+    end
+
     def message(str)
       @editor.message("ImportJS: #{str}")
     end
@@ -139,11 +158,11 @@ module ImportJS
                                 stdin_data: @editor.current_file_content)
 
       if ESLINT_STDOUT_ERROR_REGEXES.any? { |regex| out =~ regex }
-        fail ImportJS::ParseError.new, out
+        fail ParseError.new, out
       end
 
       if ESLINT_STDERR_ERROR_REGEXES.any? { |regex| err =~ regex }
-        fail ImportJS::ParseError.new, err
+        fail ParseError.new, err
       end
 
       out.split("\n")
@@ -296,7 +315,7 @@ module ImportJS
       # iterate through those and stop at anything that's not an import.
       imports = {}
       potential_imports_blob.scan(/^.*?;/m).each do |potential_import|
-        import_statement = ImportJS::ImportStatement.parse(potential_import)
+        import_statement = ImportStatement.parse(potential_import)
         break unless import_statement
 
         if imports[import_statement.path]
@@ -333,7 +352,7 @@ module ImportJS
         if lookup_path == ''
           # If lookup_path is an empty string, the `find` command will not work
           # as desired so we bail early.
-          fail ImportJS::FindError.new,
+          fail FindError.new,
                "lookup path cannot be empty (#{lookup_path.inspect})"
         end
 
@@ -345,14 +364,14 @@ module ImportJS
         command = "#{find_command} | #{egrep_command}"
         out, err = Open3.capture3(command)
 
-        fail ImportJS::FindError.new, err unless err == ''
+        fail FindError.new, err unless err == ''
 
         matched_modules.concat(
           out.split("\n").map do |f|
             next if @config.get('excludes').any? do |glob_pattern|
               File.fnmatch(glob_pattern, f)
             end
-            ImportJS::JSModule.construct(
+            JSModule.construct(
               lookup_path: lookup_path,
               relative_file_path: f,
               strip_file_extensions:
@@ -376,7 +395,7 @@ module ImportJS
       @config.package_dependencies.each do |dep|
         next unless dep =~ dep_regex
 
-        js_module = ImportJS::JSModule.construct(
+        js_module = JSModule.construct(
           lookup_path: 'node_modules',
           relative_file_path: "node_modules/#{dep}/package.json",
           strip_file_extensions: [])
@@ -399,7 +418,7 @@ module ImportJS
 
     # @param js_modules [Array]
     # @param variable_name [String]
-    # @return [String]
+    # @return [ImportJS::JSModule]
     def resolve_one_js_module(js_modules, variable_name)
       if js_modules.length == 1
         js_module = js_modules.first
@@ -421,6 +440,25 @@ module ImportJS
       js_modules[selected_index]
     end
 
+    # @param js_modules [Array]
+    # @param variable_name [String]
+    # @return [ImportJS::JSModule]
+    def resolve_goto_module(js_modules, variable_name)
+      return js_modules.first if js_modules.length == 1
+
+      # Look for a current import matching the goto
+      find_current_imports[:imports].each do |ist|
+        js_modules.each do |js_module|
+          next unless variable_name == ist.default_import ||
+                      (ist.named_imports || []).include?(variable_name)
+          return js_module if ist.path == js_module.import_path
+        end
+      end
+
+      # Fall back to asking the user to resolve the ambiguity
+      resolve_one_js_module(js_modules, variable_name)
+    end
+
     # Takes a string in any of the following four formats:
     #   dash-separated
     #   snake_case

data/lib/import_js/js_module.rb

@@ -52,10 +52,28 @@ module ImportJS
     # @return [String, String]
     def self.resolve_import_path_and_main(file_path, strip_file_extensions)
       if file_path.end_with? '/package.json'
-        main_file = JSON.parse(File.read(file_path))['main']
-        return [nil, nil] unless main_file
-        match = file_path.match(%r{(.*)/package\.json})
-        return match[1], main_file
+        return [nil, nil] unless File.exist?(file_path)
+
+        file_contents = File.read(file_path)
+        return [nil, nil] if file_contents.strip.empty?
+
+        main_file = JSON.parse(file_contents)['main']
+        match = file_path.match(%r{(?<package>.*)/package\.json})
+
+        unless main_file
+          index_file = find_index(match[:package])
+          return [nil, nil] unless index_file
+          main_file = index_file
+        end
+
+        if File.directory?("#{match[:package]}/#{main_file}")
+          # The main in package.json refers to a directory, so we want to
+          # resolve it to an index file.
+          index_file = find_index("#{match[:package]}/#{main_file}")
+          main_file += "/#{index_file}" if index_file
+        end
+
+        return match[:package], main_file
       end
 
       match = file_path.match(%r{(.*)/(index\.js[^/]*)$})
@@ -66,6 +84,15 @@ module ImportJS
       [import_path, nil]
     end
 
+    # @param directory [String]
+    # @return [String, nil]
+    def self.find_index(directory)
+      %w[index.js index.jsx].each do |index_file|
+        return index_file if File.exist? "#{directory}/#{index_file}"
+      end
+      nil
+    end
+
     # @param import_path [String]
     def initialize(import_path: nil)
       self.import_path = import_path
@@ -110,23 +137,41 @@ module ImportJS
     # @param path_to_current_file [String]
     # @return [String]
     def open_file_path(path_to_current_file)
-      if file_path && file_path.end_with?('/package.json')
-        return file_path.sub(/package\.json$/, main_file)
+      if @file_path
+        # There is a file_path. This happens for JSModules that are not aliases.
+        return @file_path unless @file_path.end_with?('/package.json')
+
+        # The file_path points to a package.json file, so we want to look in
+        # that package.json file for a `main` configuration value and open that
+        # file instead.
+        return @file_path.sub(/package\.json$/, main_file)
       end
-      return file_path if file_path
 
-      if import_path.start_with?('.')
-        return File.expand_path(import_path, File.dirname(path_to_current_file))
+      # There is no file_path. This likely means that we are working with an
+      # alias, so we want to expand it to a full path if we can.
+
+      if @import_path.start_with?('.')
+        # The import path in the alias starts with a ".", which means that it is
+        # relative to the current file. In order to open this file, we need to
+        # expand it to a full path.
+        return File.expand_path(
+          @import_path, File.dirname(path_to_current_file))
       end
 
-      import_path
+      # This is likely an alias that points to a package, so let's try to find
+      # its main file from its package.json file.
+      file_path = "node_modules/#{@import_path}/package.json"
+      _, main = self.class.resolve_import_path_and_main(file_path, [])
+      return "node_modules/#{@import_path}/#{main}" if main
+
+      @import_path
     end
 
     # @param variable_name [String]
     # @param config [ImportJS::Configuration]
     # @return [ImportJS::ImportStatement]
     def to_import_statement(variable_name, config)
-      ImportJS::ImportStatement.new.tap do |statement|
+      ImportStatement.new.tap do |statement|
         if has_named_exports
           statement.inject_named_import(variable_name)
         else

data/lib/import_js/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module ImportJS
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

metadata

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