Allow levels to be changed for typechecking rules in .solargraph.yml (#1126)

apiology · castwide · lekemula · web-flow · commit d586a31ef607 · 2026-01-01T07:26:03.000-05:00
* Add 'solargraph method_pin' command for debugging ```sh $ SOLARGRAPH_ASSERTS=on bundle exec solargraph method_pin --rbs 'RuboCop::AST::ArrayNode#values' def values: () -> Array $ bundle exec solargraph help method_pin Usage: solargraph method_pin [PATH] Options: [--rbs], [--no-rbs], [--skip-rbs] # Output the pin as RBS # Default: false [--typify], [--no-typify], [--skip-typify] # Output the calculated return type of the pin from annotations # Default: false [--probe], [--no-probe], [--skip-probe] # Output the calculated return type of the pin from annotations and inference # Default: false [--stack], [--no-stack], [--skip-stack] # Show entire stack by including definitions in superclasses # Default: false Describe a method pin $ ``` * RuboCop and Solargraph fixes * Linting fix * Add spec * Fix spec * Allow newer RBS gem versions, exclude incompatible ones (#995) * Allow newer RBS gem versions This allow users to upgrade to recent Tapioca versions. Tapioca now requires newish versions of the spoom gem, which depends on 4.x pre-releases of the rbs gem. * Add RBS version to test matrix * Add exclude rule * Move to 3.6.1 * Look for external requires before cataloging bench (#1021) * Look for external requires before cataloging bench It seems like sync_catalog will go through the motions but not actually load pins from gems here due to passing an empty requires array to ApiMap. I'm sure those requires get pulled in eventually, but we go through at least one catalog cycle without it happening. Found while trying to test a different issue but not being able to get completions from a gem in a spec. * Ensure backport is pre-cached * Remove Library#folding_ranges (#904) * Complain in strong type-checking if an @sg-ignore line is not needed (#1011) * Complain in strong type-checking if an @sg-ignore line is not needed * Fix return type * Fix spec * Linting/coverage fixes * Coverage fix * Document a log level env variable (#894) * Document a log level env variable * Fix logger reference * Fix env var name * Populate location information from RBS files (#768) * Populate location information from RBS files The 'rbs' gem maps the location of different definitions to the relevant point in the RGS files themselves - this change provides the ability to jump into the right place in those files to see the type definition via the LSP. * Prefer source location in language server * Resolve merge issue * Fix Path vs String type error * Consolidate parameter handling into Pin::Callable (#844) * Consolidate parameter handling into Pin::Closure * Clarify clobbered variable names * Fix bug in to_rbs, add spec, then fix new bug found after running spec * Catch one more Signature.new to translate from strict typechecking * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Use Pin::Callable type in args_node.rb * Select String#each_line overload with mandatory vs optional arg info * Adjust local variable presence to start after assignment, not before (#864) * Adjust local variable presence to start after assignment, not before * Add regression test around assignment in return position * Fix assignment visibility code, which relied on bad asgn semantics * Resolve params from ref tags (#872) * Resolve params from ref tags * Resolve ref tags with namespaces * Fix merge issue * RuboCop fixes * Add @sg-ignore * Linting * Linting fix * Linting fix --------- Co-authored-by: Fred Snyder <fsnyder@castwide.com> * Fix hole in type checking evaluation (#1009) * Fix hole in type checking evaluation The call to `bar()` in `[ bar('string') ].compact` is not currently type-checked due to a missed spot in `NodeMethods#call_nodes_from(node)` * Avoid over-reporting call issues * Fix annotation * Add nocov markers around unreachable area * Fix a coverage issue * Cover more paths in type checking * Fix a code coverage issue * Drop blank line * Ratchet Rubocop todo * Fix missing coverage * Improve typechecking error message (#1014) If we know the target of an unresolved method call, include it in the error message. * Internal strict type-checking fixes (#1013) * Internal strict type-checking fixes * Add annotation * Add annotation * Add @sg-ignores for now * Reproduce and fix a ||= (or-asgn) evaluation issue (#1017) * Reproduce and fix a ||= (or-asgn) evaluation issue * Fix linting issue * Define closure for Pin::Symbol, for completeness (#1027) This isn't used anywhere to my knowledge, but it makes sense to think of symbols as being in the global namespace, helps guarantee that closure is always available on a pin, and of course keeps the assert happy ;) * Fix 'all!' config to reporters (#1018) * Fix 'all!' config to reporters Solargraph found the type error here! * Linting fixes * Fix DocMap.all_rbs_collection_gems_in_memory return type (#1037) * Fix RuboCop linting errors in regular expressions (#1038) * Fix RuboCop linting errors in regular expressions * Continue on rubocop_todo errors * Move configuration * Continue on undercover errors * Resolve class aliases via Constant pins (#1029) * Resolve class aliases via Constant pins This also eliminates the need for Parser::NodeMethods as a searately defined class. * Resolve merge issues * Resolve Solargraph strong complaint * Add @sg-ignore * Fix RuboCop issues * Drop unused method * Ratchet .rubocop_todo.yml * Speed-up LSP completion response times (#1035) * Improve performance of resolve_method_aliases method - Add indexed lookups for methods and aliases by name - Cache ancestor traversal to avoid repeated computations - Separate regular pins from aliases for more efficient processing - Replace linear search with direct indexed method lookup - Add fast path for creating resolved alias pins without individual lookups Generated with Claude Code * Update .rubocop_todo.yml * Fix typechecking - get_method_stack order `get_method_stack` returns the following order for `Enumerable#select`: - master branch: => ["Enumerable#select", "Kernel#select"] - current branch: => ["Kernel#select", "Enumerable#select"] * Avoid redundant indexing methods_by_name loop through ancestors and rely on store.get_path_pins * RuboCop todo update * Try rbs collection update before specs * RuboCop fixes * Add @sg-ignores * Fix typo * Exclude problematic combinations on Ruby head * Fix indentation * method_pin -> pin, hide command * Fix type * RuboCop todo file stability To avoid merge conflicts and contributors having to deal with non-intuitive RuboCop todo changes: * Lock down development versions of RuboCop and plugins so that unrelated PRs aren't affected by newly implemented RuboCop rules. * Exclude rule entirely if more than 5 files violate it today, so that PRs are less likely to cause todo file changes unless they are specifically targeted at cleanup. * Clarify guidance on RuboCop todo file in CI error message. * Fix to hopefully ensure guidance always appears in CI error message. * Fix merge issue * Add --references flag (superclass for now) * Add another @sg-ignore * Catch up with .rubocop_todo.yml * Add another @sg-ignore * Tolerate case statement in specs * Rerun rubocop todo * Force build * Restore * install -> update with rbs collection * Try Ruby 3.2 * Update solargraph * Re-add bundle install * Drop MATRIX_SOLARGRAPH_VERSION * Drop debugging changes * Update expectations from master branch * Update rubocop todo * Fix merge failure * Allow more valid method pin paths * RuboCop fix * Linting * Reproduce solargraph-rspec rspec failure * Trigger build * Fix new bundler issue * Debug * Turn off warning diagnostics in CLI * Debug * Fix pin merging bug * Add @sg-ignore * Allow levels to be changed for typechecking rules in .solargraph.yml Suggested updates for https://solargraph.org/guides/configuration: 1) Change block in Defaults section to: ``` include: - "**/*.rb" exclude: - spec/**/* - test/**/* - vendor/**/* - ".bundle/**/*" require: [] domains: [] reporters: - rubocop - require_not_found formatter: rubocop: cops: safe except: [] only: [] extra_args: [] type_checker: rules: {} max_files: 5000 ``` 2) Add section 'formatter' (hadn't been added) Specify configuration for code formatters used in the LSP. Currently supports 'rubocop' as the subsection, with the following keys: * `cops`: Valid values: 'all', 'safe' * `except`: List of cops to pass to the --except argument in the RuboCop CLI * `only`: List of cops to pass to the --only argument in the RuboCop CLI * `extra_args`: Additional arguments to pass to the RuboCop CLI 3) Add section 'type_checker.rules' Override which rules are applied at a given typechecking level. Example: ``` type_checker: rules: validate_calls: typed # make 'typed' level more strict without # bringing in other rules ``` For the current list of typechecking rules, see [rules.rb](https://github.com/castwide/solargraph/blob/master/lib/solargraph/type_checker/rules.rb) in the Solargraph source. * Fix merge * Fix merge --------- Co-authored-by: Fred Snyder <fsnyder@castwide.com> Co-authored-by: Lekë Mula <l.mula@finlink.de>
diff --git a/lib/solargraph/shell.rb b/lib/solargraph/shell.rb
@@ -173,6 +173,9 @@ def reporters
     # @return [void]
     def typecheck *files
       directory = File.realpath(options[:directory])
+      workspace = Solargraph::Workspace.new(directory)
+      level = options[:level].to_sym
+      rules = workspace.rules(level)
       api_map = Solargraph::ApiMap.load_with_cache(directory, $stdout)
       probcount = 0
       if files.empty?
@@ -184,7 +187,7 @@ def typecheck *files
 
       time = Benchmark.measure {
         files.each do |file|
-          checker = TypeChecker.new(file, api_map: api_map, level: options[:level].to_sym)
+          checker = TypeChecker.new(file, api_map: api_map, level: options[:level].to_sym, workspace: workspace)
           problems = checker.problems
           next if problems.empty?
           problems.sort! { |a, b| a.location.range.start.line <=> b.location.range.start.line }
diff --git a/lib/solargraph/source.rb b/lib/solargraph/source.rb
@@ -15,7 +15,7 @@ class Source
 
     include EncodingFixes
 
-    # @return [String]
+    # @return [String, nil]
     attr_reader :filename
 
     # @return [String]
diff --git a/lib/solargraph/type_checker.rb b/lib/solargraph/type_checker.rb
@@ -21,14 +21,23 @@ class TypeChecker
     # @return [ApiMap]
     attr_reader :api_map
 
-    # @param filename [String]
+    # @param filename [String, nil]
     # @param api_map [ApiMap, nil]
-    # @param level [Symbol]
-    def initialize filename, api_map: nil, level: :normal
+    # @param level [Symbol] Don't complain about anything above this level
+    # @param workspace [Workspace, nil] Workspace to use for loading
+    #   type checker rules modified by user config
+    # @param type_checker_rules [Hash{Symbol => Symbol}] Overrides for
+    #   type checker rules - e.g., :report_undefined => :strong
+    # @param rules [Rules] Type checker rules object
+    def initialize filename,
+                   api_map: nil,
+                   level: :normal,
+                   workspace: filename ? Workspace.new(File.dirname(filename)) : nil,
+                   rules: workspace ? workspace.rules(level) : Rules.new(level, {})
       @filename = filename
       # @todo Smarter directory resolution
       @api_map = api_map || Solargraph::ApiMap.load(File.dirname(filename))
-      @rules = Rules.new(level)
+      @rules = rules
       # @type [Array<Range>]
       @marked_ranges = []
     end
diff --git a/lib/solargraph/type_checker/rules.rb b/lib/solargraph/type_checker/rules.rb
@@ -20,50 +20,64 @@ class Rules
       attr_reader :rank
 
       # @param level [Symbol]
-      def initialize level
+      # @param overrides [Hash{Symbol => Symbol}]
+      def initialize level, overrides
         @rank = if LEVELS.key?(level)
           LEVELS[level]
         else
           Solargraph.logger.warn "Unrecognized TypeChecker level #{level}, assuming normal"
           0
         end
         @level = LEVELS[LEVELS.values.index(@rank)]
+        @overrides = overrides
       end
 
       def ignore_all_undefined?
-        rank < LEVELS[:strict]
+        !report_undefined?
+      end
+
+      def report_undefined?
+        report?(:report_undefined, :strict)
       end
 
       def validate_consts?
-        rank >= LEVELS[:strict]
+        report?(:validate_consts, :strict)
       end
 
       def validate_calls?
-        rank >= LEVELS[:strict]
+        report?(:validate_calls, :strict)
       end
 
       def require_type_tags?
-        rank >= LEVELS[:strong]
+        report?(:validate_type_tags, :strong)
       end
 
       def must_tag_or_infer?
-        rank > LEVELS[:typed]
+        report?(:must_tag_or_infer, :strict)
       end
 
       def validate_tags?
-        rank > LEVELS[:normal]
+        report?(:validate_tags, :typed)
       end
 
       def require_all_return_types_match_inferred?
-        rank >= LEVELS[:alpha]
+        report?(:require_all_return_types_match_inferred, :alpha)
       end
 
       # We keep this at strong because if you added an @ sg-ignore to
       # address a strong-level issue, then ran at a lower level, you'd
       # get a false positive - we don't run stronger level checks than
       # requested for performance reasons
       def validate_sg_ignores?
-        rank >= LEVELS[:strong]
+        report?(:validate_sg_ignores, :strong)
+      end
+
+      private
+
+      # @param type [Symbol]
+      # @param level [Symbol]
+      def report?(type, level)
+        rank >= LEVELS[@overrides.fetch(type, level)]
       end
     end
   end
diff --git a/lib/solargraph/workspace.rb b/lib/solargraph/workspace.rb
@@ -50,6 +50,12 @@ def config
       @config ||= Solargraph::Workspace::Config.new(directory)
     end
 
+    # @param level [Symbol]
+    # @return [TypeChecker::Rules]
+    def rules(level)
+      @rules ||= TypeChecker::Rules.new(level, config.type_checker_rules)
+    end
+
     # Merge the source. A merge will update the existing source for the file
     # or add it to the sources if the workspace is configured to include it.
     # The source is ignored if the configuration excludes it.
diff --git a/lib/solargraph/workspace/config.rb b/lib/solargraph/workspace/config.rb
@@ -115,6 +115,15 @@ def max_files
         raw_data['max_files']
       end
 
+      # @return [Hash{Symbol => Symbol}]
+      def type_checker_rules
+        # @type [Hash{String => String}]
+        raw_rules = raw_data.fetch('type_checker', {}).fetch('rules', {})
+        raw_rules.to_h do |k, v|
+          [k.to_sym, v.to_sym]
+        end
+      end
+
       private
 
       # @return [String]
@@ -168,6 +177,9 @@ def default_config
               'extra_args' =>[]
             }
           },
+          'type_checker' => {
+            'rules' => { }
+          },
           'require_paths' => [],
           'plugins' => [],
           'max_files' => MAX_FILES
diff --git a/spec/type_checker/rules_spec.rb b/spec/type_checker/rules_spec.rb
@@ -1,6 +1,6 @@
 describe Solargraph::TypeChecker::Rules do
   it 'sets normal rules' do
-    rules = Solargraph::TypeChecker::Rules.new(:normal)
+    rules = Solargraph::TypeChecker::Rules.new(:normal, {})
     expect(rules.ignore_all_undefined?).to be(true)
     expect(rules.must_tag_or_infer?).to be(false)
     expect(rules.require_type_tags?).to be(false)
@@ -9,7 +9,7 @@
   end
 
   it 'sets typed rules' do
-    rules = Solargraph::TypeChecker::Rules.new(:typed)
+    rules = Solargraph::TypeChecker::Rules.new(:typed, {})
     expect(rules.ignore_all_undefined?).to be(true)
     expect(rules.must_tag_or_infer?).to be(false)
     expect(rules.require_type_tags?).to be(false)
@@ -18,7 +18,7 @@
   end
 
   it 'sets strict rules' do
-    rules = Solargraph::TypeChecker::Rules.new(:strict)
+    rules = Solargraph::TypeChecker::Rules.new(:strict, {})
     expect(rules.ignore_all_undefined?).to be(false)
     expect(rules.must_tag_or_infer?).to be(true)
     expect(rules.require_type_tags?).to be(false)
@@ -27,7 +27,7 @@
   end
 
   it 'sets strong rules' do
-    rules = Solargraph::TypeChecker::Rules.new(:strong)
+    rules = Solargraph::TypeChecker::Rules.new(:strong, {})
     expect(rules.ignore_all_undefined?).to be(false)
     expect(rules.must_tag_or_infer?).to be(true)
     expect(rules.require_type_tags?).to be(true)
