Introduce .ruby-lsp.yml config file

Shopify · Feb 29, 2024 · 8aeeaa7 · 8aeeaa7
1 parent 4d5bc2e
commit 8aeeaa7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/.index.yml → .ruby-lsp.yml b/.index.yml → .ruby-lsp.yml
diff --git a/lib/ruby_indexer/lib/ruby_indexer/configuration.rb b/lib/ruby_indexer/lib/ruby_indexer/configuration.rb
@@ -45,16 +45,20 @@ def initialize
 
     sig { void }
     def load_config
-      return unless File.exist?(".index.yml")
+      config_file = if File.exist?(".ruby-lsp.yml")
+        ".ruby-lsp.yml"
+      elsif File.exist?(".index.yml") # previously used name. Add a deprecation warning?
+        ".index.yml"
+      end
 
-      config = YAML.parse_file(".index.yml")
-      return unless config
+      config = YAML.parse_file(config_file)
+      return unless config # TODO: why would this be nil?
 
       config_hash = config.to_ruby
       validate_config!(config_hash)
       apply_config(config_hash)
     rescue Psych::SyntaxError => e
-      raise e, "Syntax error while loading .index.yml configuration: #{e.message}"
+      raise e, "Syntax error while loading #{config_file} configuration: #{e.message}"
     end
 
     sig { returns(T::Array[IndexablePath]) }