import_js 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90724e922f7ebecab12977097f1b867d83d8f74
-  data.tar.gz: 43cc4828550165c17ca8b07b142c5e033fbbb31f
+  metadata.gz: a2a0036427b0f66373fcbc6fda702570d501f281
+  data.tar.gz: 9c798047e26eb9189e169c5395ed1bd41b03e2fc
 SHA512:
-  metadata.gz: c6f3b02306c7c21ccc09b13e7246d2c8ddb7c78f05f149d2644b73d1ce8d731d4349e54f68d52bc79b1558d07aa94aba5fe7a809f9f4137410f9cfccd0d4225e
-  data.tar.gz: 105ab5859eaef7bd8d3bd5b31a0725c4000cf833743a786c7d6a1e9a5bac21bcbdc2de79580c565f74fde07a58f4467b004709031695a892d3468d4cc9304b2d
+  metadata.gz: 4eaed3ab7c8204e62a7b19bdad9cf002384f6797cd15fe6f6615763ebcda6f8cf607cbb3127f8c494082a53f84684c17e383544f897cd368ae0074101676dc5d
+  data.tar.gz: 43c8abdad3178c4df5c6f04a7030737daa9d2cb4e83cb777e6dbde088a5a43dffa2690ae13e1b1950ce915dc01f5252a75d4747883a9d0777124cf7353541e64

data/bin/import-js

@@ -9,7 +9,7 @@ opts = Slop.parse do |o|
   o.bool '--goto', 'instead of importing, just print the path to a module'
   o.array '--selections', 'a list of resolved selections, e.g. Foo:0,Bar:1'
   o.string '--filename',
-    'a path to the file which contents are being passed in as stdin'
+           'a path to the file which contents are being passed in as stdin'
   o.on '-v', '--version', 'print the current version' do
     puts ImportJS::VERSION
     exit
@@ -50,7 +50,7 @@ end
 
 # Print messages to stderr
 meta = {
-  messages: editor.messages
+  messages: editor.messages,
 }
 ask = editor.ask_for_selections
 meta[:ask_for_selections] = ask unless ask.empty?

data/lib/import_js/command_line_editor.rb

@@ -1,4 +1,5 @@
 module ImportJS
+  # This is the implementation of command line integration in Import-JS.
   class CommandLineEditor
     def initialize(lines, opts)
       @lines = lines
@@ -24,20 +25,14 @@ module ImportJS
       @goto = file_path
     end
 
-    # @return [String]
-    def goto
-      @goto
-    end
+    attr_reader :goto
 
     # @param str [String]
     def message(str)
       @messages << str
     end
 
-    # @return [Array]
-    def ask_for_selections
-      @ask_for_selections
-    end
+    attr_reader :ask_for_selections
 
     # @return [String]
     def current_file_content
@@ -110,7 +105,7 @@ module ImportJS
       else
         @ask_for_selections << {
           word: word,
-          alternatives: alternatives
+          alternatives: alternatives,
         }
         nil
       end

data/lib/import_js/configuration.rb

@@ -1,42 +1,55 @@
+# frozen_string_literal: true
 require 'json'
 require 'open3'
 
 module ImportJS
-  CONFIG_FILE = '.importjs.json'
+  CONFIG_FILE = '.importjs.json'.freeze
 
   DEFAULT_CONFIG = {
     'aliases' => {},
     'declaration_keyword' => 'import',
+    'named_exports' => {},
     'eslint_executable' => 'eslint',
     'excludes' => [],
     'ignore_package_prefixes' => [],
+    'import_dev_dependencies' => false,
+    'import_function' => 'require',
     'lookup_paths' => ['.'],
+    'minimum_version' => '0.0.0',
     'strip_file_extensions' => ['.js', '.jsx'],
-    'use_relative_paths' => false
-  }
+    'strip_from_path' => nil,
+    'use_relative_paths' => false,
+  }.freeze
 
   # Class that initializes configuration from a .importjs.json file
   class Configuration
-    def initialize
-      @config = DEFAULT_CONFIG.merge(load_config)
-    end
+    def initialize(path_to_current_file)
+      @path_to_current_file = normalize_path(path_to_current_file)
+      @configs = []
+      user_config = load_config(CONFIG_FILE)
+      @configs.concat([user_config].flatten.reverse) if user_config
+      @configs << DEFAULT_CONFIG
 
-    def refresh
-      return if @config_time == config_file_last_modified
-      @config = DEFAULT_CONFIG.merge(load_config)
+      check_current_version!
     end
 
     # @return [Object] a configuration value
-    def get(key)
-      @config[key]
+    def get(key, from_file: nil)
+      @configs.find do |config|
+        applies_to = config['applies_to'] || '*'
+        applies_from = config['applies_from'] || '*'
+        next unless config.key?(key)
+        File.fnmatch(normalize_path(applies_to), @path_to_current_file) &&
+          File.fnmatch(normalize_path(applies_from), normalize_path(from_file))
+      end[key]
     end
 
     # @param variable_name [String]
     # @param path_to_current_file [String?]
     # @return [ImportJS::JSModule?]
     def resolve_alias(variable_name, path_to_current_file)
-      path = @config['aliases'][variable_name]
-      return resolve_destructured_alias(variable_name) unless path
+      path = get('aliases')[variable_name]
+      return unless path
 
       path = path['path'] if path.is_a? Hash
 
@@ -44,21 +57,18 @@ module ImportJS
         path = path.sub(/\{filename\}/,
                         File.basename(path_to_current_file, '.*'))
       end
-      ImportJS::JSModule.new(lookup_path: nil,
-                             relative_file_path: path,
-                             strip_file_extensions: [])
+      ImportJS::JSModule.new(import_path: path)
     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(lookup_path: nil,
-                                             relative_file_path: path['path'],
-                                             strip_file_extensions: [])
-          js_module.is_destructured = true
-          return js_module
-        end
+    # @param variable_name [String]
+    # @return [ImportJS::JSModule?]
+    def resolve_named_exports(variable_name)
+      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.has_named_exports = true
+        return js_module
       end
       nil
     end
@@ -67,26 +77,42 @@ module ImportJS
     def package_dependencies
       return [] unless File.exist?('package.json')
 
-      package = JSON.parse(File.read('package.json'))
-      dependencies = package['dependencies'] ?
-        package['dependencies'].keys : []
-      peer_dependencies = package['peerDependencies'] ?
-        package['peerDependencies'].keys : []
-
-      dependencies.concat(peer_dependencies)
+      keys = %w[dependencies peerDependencies]
+      keys << 'devDependencies' if get('import_dev_dependencies')
+      package_json = JSON.parse(File.read('package.json'))
+      keys.map do |key|
+        package_json[key].keys if package_json[key]
+      end.compact.flatten
     end
 
     private
 
+    # @param file [File]
     # @return [Hash]
-    def load_config
-      @config_time = config_file_last_modified
-      File.exist?(CONFIG_FILE) ? JSON.parse(File.read(CONFIG_FILE)) : {}
+    def load_config(file)
+      return unless File.exist?(file)
+      JSON.parse(File.read(file))
+    end
+
+    # @param path [String]
+    # @return [String]
+    def normalize_path(path)
+      return './' unless path
+      path = path.sub(/^#{Regexp.escape(Dir.pwd)}/, '.')
+      path = "./#{path}" unless path.start_with?('.')
+      path
     end
 
-    # @return [Time?]
-    def config_file_last_modified
-      File.exist?(CONFIG_FILE) ? File.mtime(CONFIG_FILE) : nil
+    # Checks that the current version is bigger than the `minimum_version`
+    # defined in config. Raises an error if it doesn't match.
+    def check_current_version!
+      minimum_version = get('minimum_version')
+      return if Gem::Dependency.new('', ">= #{minimum_version}")
+                               .match?('', ImportJS::VERSION)
+
+      fail ImportJS::ClientTooOldError,
+           'The .importjs.json file you are using requires version ' \
+           "#{get('minimum_version')}. You are using #{ImportJS::VERSION}."
     end
   end
 end

data/lib/import_js/emacs_editor.rb

@@ -1,159 +1,159 @@
 # encoding: utf-8
 module ImportJS
-end
-
-class ImportJS::EmacsEditor
-  attr_accessor :current_word
-
-  def initialize
-    loop do
-      input = gets.chomp
-      command, value, path = input.split(':')
-
-      begin
-        @path = path
-        @file = File.readlines(path).map(&:chomp)
-        @current_word = value
-
-        case command
-        when 'import'
-          ImportJS::Importer.new(self).import
-          write_file
-          puts 'import:success'
-        when 'goto'
-          ImportJS::Importer.new(self).goto
-        when 'fix'
-          ImportJS::Importer.new(self).fix_imports
-          write_file
-          puts 'import:success'
-        else
-          puts "unknown command: #{command}"
+  # This is the implementation of the emacs integration in Import-JS.
+  class EmacsEditor
+    attr_accessor :current_word
+
+    def initialize
+      loop do
+        input = gets.chomp
+        command, value, path = input.split(':')
+
+        begin
+          @path = path
+          @file = File.readlines(path).map(&:chomp)
+          @current_word = value
+
+          case command
+          when 'import'
+            ImportJS::Importer.new(self).import
+            write_file
+            puts 'import:success'
+          when 'goto'
+            ImportJS::Importer.new(self).goto
+          when 'fix'
+            ImportJS::Importer.new(self).fix_imports
+            write_file
+            puts 'import:success'
+          else
+            puts "unknown command: #{command}"
+          end
+        rescue Exception => e
+          puts e.inspect
         end
-      rescue Exception => e
-        puts e.inspect
       end
     end
-  end
 
-  def write_file
-    new_file = File.open(@path, 'w')
-    @file.each {|line| new_file.puts(line) }
-    new_file.close
-  end
+    def write_file
+      new_file = File.open(@path, 'w')
+      @file.each { |line| new_file.puts(line) }
+      new_file.close
+    end
 
-  # Open a file specified by a path.
-  #
-  # @param file_path [String]
-  def open_file(file_path)
-    puts "goto:success:#{File.expand_path(file_path)}"
-  end
+    # Open a file specified by a path.
+    #
+    # @param file_path [String]
+    def open_file(file_path)
+      puts "goto:success:#{File.expand_path(file_path)}"
+    end
 
-  # Get the path to the file currently being edited. May return `nil` if an
-  # anonymous file is being edited.
-  #
-  # @return [String?]
-  def path_to_current_file
-    @path
-  end
+    # Get the path to the file currently being edited. May return `nil` if an
+    # anonymous file is being edited.
+    #
+    # @return [String?]
+    def path_to_current_file
+      @path
+    end
 
-  # Display a message to the user.
-  #
-  # @param str [String]
-  def message(str)
-    puts str
-  end
+    # Display a message to the user.
+    #
+    # @param str [String]
+    def message(str)
+      puts str
+    end
 
-  # Read the entire file into a string.
-  #
-  # @return [String]
-  def current_file_content
-    @file.join("\n")
-  end
+    # Read the entire file into a string.
+    #
+    # @return [String]
+    def current_file_content
+      @file.join("\n")
+    end
 
-  # Reads a line from the file.
-  #
-  # Lines are one-indexed, so 1 means the first line in the file.
-  # @return [String]
-  def read_line(line_number)
-    @file[line_number - 1]
-  end
+    # Reads a line from the file.
+    #
+    # Lines are one-indexed, so 1 means the first line in the file.
+    # @return [String]
+    def read_line(line_number)
+      @file[line_number - 1]
+    end
 
-  # Get the cursor position.
-  #
-  # @return [Array(Number, Number)]
-  def cursor
-    return 0, 0
-  end
+    # Get the cursor position.
+    #
+    # @return [Array(Number, Number)]
+    def cursor
+      [0, 0]
+    end
 
-  # Place the cursor at a specified position.
-  #
-  # @param position_tuple [Array(Number, Number)] the row and column to place
-  #   the cursor at.
-  def cursor=(position_tuple)
-  end
+    # Place the cursor at a specified position.
+    #
+    # @param position_tuple [Array(Number, Number)] the row and column to place
+    #   the cursor at.
+    def cursor=(position_tuple)
+    end
 
-  # Delete a line.
-  #
-  # @param line_number [Number] One-indexed line number.
-  #   1 is the first line in the file.
-  def delete_line(line_number)
-    @file.delete_at(line_number - 1)
-  end
+    # Delete a line.
+    #
+    # @param line_number [Number] One-indexed line number.
+    #   1 is the first line in the file.
+    def delete_line(line_number)
+      @file.delete_at(line_number - 1)
+    end
 
-  # Append a line right after the specified line.
-  #
-  # Lines are one-indexed, but you need to support appending to line 0 (add
-  # content at top of file).
-  # @param line_number [Number]
-  def append_line(line_number, str)
-    @file.insert(line_number, str)
-  end
+    # Append a line right after the specified line.
+    #
+    # Lines are one-indexed, but you need to support appending to line 0 (add
+    # content at top of file).
+    # @param line_number [Number]
+    def append_line(line_number, str)
+      @file.insert(line_number, str)
+    end
 
-  # Count the number of lines in the file.
-  #
-  # @return [Number] the number of lines in the file
-  def count_lines
-    @file.size
-  end
+    # Count the number of lines in the file.
+    #
+    # @return [Number] the number of lines in the file
+    def count_lines
+      @file.size
+    end
 
-  # Ask the user to select something from a list of alternatives.
-  #
-  # @param word [String] The word/variable to import
-  # @param alternatives [Array<String>] A list of alternatives
-  # @return [Number, nil] the index of the selected alternative, or nil if
-  #   nothing was selected.
-  def ask_for_selection(word, alternatives)
-    puts "asking for selection"
-    puts "ImportJS: Pick JS module to import for '#{word}':"
-    puts JSON.pretty_generate(alternatives)
-    return
-
-    # need to implement this
-    escaped_list = [heading]
-    escaped_list << alternatives.each_with_index.map do |alternative, i|
-      "\"#{i + 1}: #{alternative}\""
-    end
-    escaped_list_string = '[' + escaped_list.join(',') + ']'
-
-    selected_index = VIM.evaluate("inputlist(#{escaped_list_string})")
-    return if selected_index < 1
-    selected_index - 1
-  end
+    # Ask the user to select something from a list of alternatives.
+    #
+    # @param word [String] The word/variable to import
+    # @param alternatives [Array<String>] A list of alternatives
+    # @return [Number, nil] the index of the selected alternative, or nil if
+    #   nothing was selected.
+    def ask_for_selection(word, alternatives)
+      puts 'asking for selection'
+      puts "ImportJS: Pick JS module to import for '#{word}':"
+      puts JSON.pretty_generate(alternatives)
+      return
+
+      # need to implement this
+      escaped_list = [heading]
+      escaped_list << alternatives.each_with_index.map do |alternative, i|
+        "\"#{i + 1}: #{alternative}\""
+      end
+      escaped_list_string = '[' + escaped_list.join(',') + ']'
 
-  # Get the preferred max length of a line
-  # @return [Number?]
-  def max_line_length
-    80
-  end
+      selected_index = VIM.evaluate("inputlist(#{escaped_list_string})")
+      return if selected_index < 1
+      selected_index - 1
+    end
 
-  # @return [String] shiftwidth number of spaces if expandtab is not set,
-  #   otherwise `\t`
-  def tab
-    return ' ' * shift_width || 2
-  end
+    # Get the preferred max length of a line
+    # @return [Number?]
+    def max_line_length
+      80
+    end
+
+    # @return [String] shiftwidth number of spaces if expandtab is not set,
+    #   otherwise `\t`
+    def tab
+      ' ' * shift_width || 2
+    end
 
-  # @return [Number?]
-  def shift_width
-    2
+    # @return [Number?]
+    def shift_width
+      2
+    end
   end
 end