2025-07-02 dev branch

.github/workflows/plugins.yml

@@ -1,16 +1,21 @@
-name: Plugin Backwards Compatibility Tests
+---
+name: Plugin
+
+# To debug locally:
+#   npm install -g act
+#   cd /Users/broz/src/solargraph/ && act pull_request -j run_solargraph_rails_specs # e.g.
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 permissions:
   contents: read
 
 jobs:
-  test:
+  regression:
     runs-on: ubuntu-latest
 
     steps:
@@ -19,7 +24,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3.0'
-        bundler-cache: false
+        bundler-cache: true
     - uses: awalsh128/cache-apt-pkgs-action@latest
       with:
         packages: yq
@@ -29,14 +34,154 @@ jobs:
         echo 'gem "solargraph-rails"' > .Gemfile
         echo 'gem "solargraph-rspec"' >> .Gemfile
         bundle install
+        bundle update rbs
+    - name: Configure to use plugins
+      run: |
+        bundle exec solargraph config
+        yq -yi '.plugins += ["solargraph-rails"]' .solargraph.yml
+        yq -yi '.plugins += ["solargraph-rspec"]' .solargraph.yml
+    - name: Install gem types
+      run: bundle exec rbs collection update
+    - name: Ensure typechecking still works
+      run: bundle exec solargraph typecheck --level typed
+    - name: Ensure specs still run
+      run: bundle exec rake spec
+  rails:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: false
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: yq
+        version: 1.0
+    - name: Install gems
+      run: |
+        echo 'gem "solargraph-rails"' > .Gemfile
+        bundle install
+        bundle update rbs
     - name: Configure to use plugins
       run: |
         bundle exec solargraph config
         yq -yi '.plugins += ["solargraph-rails"]' .solargraph.yml
+    - name: Install gem types
+      run: bundle exec rbs collection update
+    - name: Ensure typechecking still works
+      run: bundle exec solargraph typecheck --level typed
+    - name: Ensure specs still run
+      run: bundle exec rake spec
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: false
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: yq
+        version: 1.0
+    - name: Install gems
+      run: |
+        echo 'gem "solargraph-rspec"' >> .Gemfile
+        bundle install
+        bundle update rbs
+    - name: Configure to use plugins
+      run: |
+        bundle exec solargraph config
         yq -yi '.plugins += ["solargraph-rspec"]' .solargraph.yml
     - name: Install gem types
-      run: bundle exec rbs collection install
+      run: bundle exec rbs collection update
     - name: Ensure typechecking still works
       run: bundle exec solargraph typecheck --level typed
     - name: Ensure specs still run
       run: bundle exec rake spec
+
+  # run_solargraph_rspec_specs:
+  #   # check out solargraph-rspec as well as this project, and point the former to use the latter as a local gem
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v3
+  #   - name: clone https://github.com/lekemula/solargraph-rspec/
+  #     run: |
+  #      cd ..
+  #      git clone https://github.com/lekemula/solargraph-rspec.git
+  #      cd solargraph-rspec
+  #   - name: Set up Ruby
+  #     uses: ruby/setup-ruby@v1
+  #     with:
+  #       ruby-version: '3.0'
+  #       bundler-cache: false
+  #   - name: Install gems
+  #     run: |
+  #      cd ../solargraph-rspec
+  #      echo "gem 'solargraph', path: '../solargraph'" >> Gemfile
+  #      bundle install
+  #   - name: Run specs
+  #     run: |
+  #       cd ../solargraph-rspec
+  #       bundle exec rake spec
+
+  run_solargraph_rails_specs:
+    # check out solargraph-rails as well as this project, and point the former to use the latter as a local gem
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: clone solargraph-rails
+      run: |
+       cd ..
+       git clone https://github.com/iftheshoefritz/solargraph-rails.git
+       cd solargraph-rails
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        # solargraph-rails supports Ruby 3.0+
+        ruby-version: '3.0'
+        bundler-cache: false
+        bundler: latest
+      env:
+        MATRIX_SOLARGRAPH_VERSION: '>=0.56.0.pre1'
+        MATRIX_RAILS_VERSION: "7.0"
+    - name: Install gems
+      run: |
+       set -x
+       BUNDLE_PATH="${GITHUB_WORKSPACE:?}/vendor/bundle"
+       export BUNDLE_PATH
+       cd ../solargraph-rails
+       echo "gem 'solargraph', path: '${GITHUB_WORKSPACE:?}'" >> Gemfile
+       bundle install
+       bundle update rbs
+       RAILS_DIR="$(pwd)/spec/rails7"
+       export RAILS_DIR
+       cd ${RAILS_DIR}
+       bundle install
+       bundle exec --gemfile ../../Gemfile rbs --version
+       bundle exec --gemfile ../../Gemfile rbs collection install
+       cd ../../
+       # bundle exec rbs collection init
+       # bundle exec rbs collection install
+      env:
+        MATRIX_SOLARGRAPH_VERSION: '>=0.56.0.pre1'
+        MATRIX_RAILS_VERSION: "7.0"
+        MATRIX_RAILS_MAJOR_VERSION: '7'
+    - name: Run specs
+      run: |
+        BUNDLE_PATH="${GITHUB_WORKSPACE:?}/vendor/bundle"
+        export BUNDLE_PATH
+        cd ../solargraph-rails
+        bundle exec solargraph --version
+        bundle info solargraph
+        bundle info rbs
+        bundle info yard
+        bundle exec rake spec
+      env:
+        MATRIX_SOLARGRAPH_VERSION: '>=0.56.0.pre1'
+        MATRIX_RAILS_VERSION: "7.0"

.github/workflows/rspec.yml

@@ -21,14 +21,29 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4', 'head']
+        ruby-version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
+          # - 'head' - see https://github.com/castwide/solargraph/issues/1022
         rbs-version: ['3.6.1', '3.9.4', '4.0.0.dev.4']
         # Ruby 3.0 doesn't work with RBS 3.9.4 or 4.0.0.dev.4
         exclude:
+          # Ruby 3.0 doesn't work with RBS 3.9.4 or 4.0.0.dev.4
           - ruby-version: '3.0'
             rbs-version: '3.9.4'
           - ruby-version: '3.0'
             rbs-version: '4.0.0.dev.4'
+          # Missing require in 'rbs collection update' - hopefully
+          # fixed in next RBS release
+          - ruby-version: 'head'
+            rbs-version: '4.0.0.dev.4'
+          - ruby-version: 'head'
+            rbs-version: '3.9.4'
+          - ruby-version: 'head'
+            rbs-version: '3.6.1'
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
@@ -47,7 +62,8 @@ jobs:
     - name: Install gems
       run: |
         bundle install
-        bundle update rbs # use latest available for this Ruby version
+    - name: Install types
+      run: bundle exec rbs collection update
     - name: Run tests
       run: bundle exec rake spec
   undercover:
@@ -64,7 +80,11 @@ jobs:
         ruby-version: '3.4'
         bundler-cache: false
     - name: Install gems
-      run: bundle install
+      run: |
+        bundle install
+        bundle update rbs # use latest available for this Ruby version
+    - name: Install types
+      run: bundle exec rbs collection update
     - name: Run tests
       run: bundle exec rake spec
     - name: Check PR coverage

.github/workflows/typecheck.yml

@@ -36,4 +36,4 @@ jobs:
     - name: Install gem types
       run: bundle exec rbs collection install
     - name: Typecheck self
-      run: SOLARGRAPH_ASSERTS=on bundle exec solargraph typecheck --level typed
+      run: SOLARGRAPH_ASSERTS=on bundle exec solargraph typecheck --level strong

.rubocop.yml

@@ -34,6 +34,10 @@ Metrics/ParameterLists:
   Max: 7
   CountKeywordArgs: false
 
+# we don't use the spec/solargraph directory, instead keeping things
+# directly under spec.
+RSpec/SpecFilePathFormat:
+  Enabled: false
 
 # we tend to use @@ and the risk doesn't seem high
 Style/ClassVars: