Adjust monorepo configurations (#1414)

Author: vinistock

vscode/.devcontainer/devcontainer.json .devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
 {
-  "name": "Node.js & TypeScript",
+  "name": "ruby-lsp",
   // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
   "image": "mcr.microsoft.com/devcontainers/typescript-node:0-20",
   "features": {

.github/ISSUE_TEMPLATE/bug_template.yml

@@ -8,33 +8,39 @@ body:
     attributes:
       value: >
         Thank you for filing a bug report! Please answer the following questions to help us understand the issue.
-  - type: input
-    attributes:
-      label: Ruby version
-      description: The Ruby version being used to run the LSP
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Code snippet
-      description: A code snippet that reproduces the issue
-      placeholder: >
-        If applicable, please include the smallest code snippet that reproduces the issue.
   - type: textarea
     attributes:
       label: Description
-      description: Reproduction steps and an explanation of the observed behavior
-      placeholder: >
-        Before submitting the issue report, please try updating the ruby-lsp gem first. If the bug is related to a
-        feature that involves automatically changing code, such as refactors or formatting, please include an example of
-        the resulting code. You may want to include a screenshot or GIF of the issue.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Expected output
-      description: A description of the expected behavior
+      description: Reproduction steps
       placeholder: >
-        Describe what you expected to happen.
+        ### Before submitting
+
+        Please follow the instructions on
+        [troubleshooting](https://github.com/Shopify/ruby-lsp/blob/main/TROUBLESHOOTING.md) and make sure you
+        are:
+        1. On the latest version of the Ruby LSP VS Code extension
+        2. On the latest version of the Ruby LSP server gem
+        3. On the latest version of VS Code
+
+        If the issue persist, please deleted this section and submit the report.
+
+        ### Reproduction steps
+
+        <!--
+        **IMPORTANT NOTE**
+        Please provide as much detail about your development setup as possible. Often issues with the Ruby LSP are
+        specific to a combination of operating system, Ruby version, Ruby version manager, the editor being used and
+        project setup. The easier it is to reproduce the problem, the quicker it will likely take to fix it.
+        -->
+
+        <!-- Suggested structure -->
+        1. Start the Ruby LSP using a certain editor
+        2. Open a Ruby file
+        3. Do something
+        4. See unexpected behavior
+
+        **Code snippet or error message**
+        ```ruby
+        ```
     validations:
       required: true

.github/dependabot.yml

@@ -16,6 +16,19 @@ updates:
           - "patch"
         exclude-patterns:
           - "prism"
+  - package-ecosystem: "npm"
+    directory: "vscode/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "Shopify/ruby-dev-exp"
+    ignore:
+      - dependency-name: "@types/vscode"
+    groups:
+      minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"
   - package-ecosystem: "gitsubmodule"
     directory: "/"
     schedule:

.github/pull_request_template.md

@@ -1,5 +1,7 @@
 ### Motivation
 
+<!-- Closes # -->
+
 <!-- Explain why you are making this change. Include links to issues or describe the problem being solved, not the solution. -->
 
 ### Implementation

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  lint:
+  lint_ruby:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -24,7 +24,7 @@ jobs:
 
       - name: Lint Ruby files and RBI shims
         run: bundle exec rubocop
-  build:
+  build_ruby:
     strategy:
       fail-fast: false
       matrix:
@@ -49,3 +49,51 @@ jobs:
 
       - name: Run index troubleshooting tool
         run: bundle exec ruby-lsp-doctor
+  lint_node:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "yarn"
+          cache-dependency-path: "vscode"
+
+      - name: Lint
+        working-directory: ./vscode
+        run: |
+          yarn --frozen-lockfile
+          yarn run lint
+  build_node:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "yarn"
+          cache-dependency-path: "vscode"
+
+      # We need some Ruby installed for the environment activation tests
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+
+      - name: Run tests
+        working-directory: ./vscode
+        env:
+          DISPLAY: ":99.0"
+        run: |
+          yarn --frozen-lockfile
+          /usr/bin/Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
+          yarn run test

vscode/.github/workflows/publish.yml .github/workflows/publish.yml

@@ -17,9 +17,7 @@ jobs:
         with:
           node-version: "18"
           cache: "yarn"
-
-      - name: 📦 Install dependencies
-        run: yarn --frozen-lockfile
+          cache-dependency-path: "vscode"
 
       - name: Create CHANGELOG.md
         uses: actions/github-script@v6
@@ -36,15 +34,27 @@ jobs:
             const includePrereleases = context.payload.release.prerelease;
 
             const changelog = releases
-              .filter((release) => includePrereleases || !release.prerelease)
+              .filter((release) => release.tag_name.startsWith?("vscode-ruby-lsp") && (includePrereleases || !release.prerelease))
               .map((release) => `# ${release.tag_name}\n${release.body}\n`)
               .join("\n");
 
-            fs.writeFileSync("CHANGELOG.md", changelog);
+            fs.writeFileSync("vscode/CHANGELOG.md", changelog);
+
+      - name: Copy files needed for release
+        run: |
+          cp LICENSE.txt vscode/LICENSE.txt
+          cp README.md vscode/README.md
+          cp CODE_OF_CONDUCT.md vscode/CODE_OF_CONDUCT.md
+          cp TROUBLESHOOTING.md vscode/TROUBLESHOOTING.md
+
+      - name: 📦 Install dependencies
+        working-directory: ./vscode
+        run: yarn --frozen-lockfile
 
       # Stable releases
       - name: Publish extension in the marketplace
         if: "!github.event.release.prerelease"
+        working-directory: ./vscode
         run: |
           yarn run package
           node_modules/.bin/vsce publish --packagePath vscode-ruby-lsp.vsix
@@ -54,6 +64,7 @@ jobs:
       # Prereleases
       - name: Package and publish prerelease extension in the marketplace
         if: "github.event.release.prerelease"
+        working-directory: ./vscode
         run: |
           yarn run package_prerelease
           node_modules/.bin/vsce publish --pre-release --packagePath vscode-ruby-lsp.vsix
@@ -63,6 +74,7 @@ jobs:
       # Stable releases for OpenVSX
       - name: Publish extension on OpenVSX
         if: "!github.event.release.prerelease"
+        working-directory: ./vscode
         run: |
           yarn run package
           node_modules/.bin/ovsx publish vscode-ruby-lsp.vsix -p ${{ secrets.OPENVSX_TOKEN }} --yarn

.gitignore

@@ -8,3 +8,9 @@
 /**/tmp/
 /**/.dev/
 /docs
+
+vscode/out
+vscode/dist
+vscode/node_modules
+vscode/.vscode-test/
+vscode/*.vsix

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "shopify.ruby-extensions-pack",
+    "dbaeumer.vscode-eslint",
     "streetsidesoftware.code-spell-checker"
   ]
 }

.vscode/settings.json

@@ -5,28 +5,43 @@
     "editor.defaultFormatter": "Shopify.ruby-lsp"
   },
   // So features like completion can still be displayed with Sorbet in the dependencies
-  "rubyLsp.bypassTypechecker": true,
   "search.exclude": {
-    "**/test/fixtures/prism": true
+    "**/test/fixtures/prism": true,
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "[typescript]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    },
   },
   "cSpell.languageSettings": [
     {
       "languageId": "*",
       "locale": "en",
-      "dictionaries": ["wordsEn"]
+      "dictionaries": [
+        "wordsEn"
+      ]
     },
     {
       "languageId": "*",
       "locale": "en-US",
-      "dictionaries": ["wordsEn"]
+      "dictionaries": [
+        "wordsEn"
+      ]
     },
     {
       "languageId": "*",
-      "dictionaries": ["companies", "softwareTerms", "misc"]
+      "dictionaries": [
+        "companies",
+        "softwareTerms",
+        "misc"
+      ]
     },
     {
       "languageId": "ruby",
-      "dictionaries": ["ruby"]
+      "dictionaries": [
+        "ruby"
+      ]
     }
   ]
 }

CONTRIBUTING.md

@@ -1,6 +1,19 @@
 # CONTRIBUTING
 
-## Manually testing a change
+## Testing changes
+
+### Tracing LSP requests and responses
+
+LSP server tracing (logging) can be controlled through the `ruby lsp.trace.server` config key in the
+`.vscode/settings.json` config file.
+
+Possible values are:
+
+- `off`: no tracing
+- `messages`: display requests and responses notifications
+- `verbose`: display each request and response as JSON
+
+### Manually testing a change
 
 There are a few options for manually testing changes to Ruby LSP:
 
@@ -14,9 +27,7 @@ gem "ruby-lsp", path: "../../Shopify/ruby-lsp"
 
 With both approaches, there is a risk of 'breaking' your local development experience, so keep an eye on the Ruby LSP output panel for exceptions as your make changes.
 
-You can also refer to the advice about [Debugging and Tracing](https://github.com/Shopify/vscode-ruby-lsp#debugging).
-
-## Running the test suite
+### Running the test suite
 
 The test suite can be executed by running
 ```shell
@@ -30,7 +41,7 @@ VERBOSE=1 bin/test
 bin/test test/requests/diagnostics_expectations_test.rb test_diagnostics__def_bad_formatting
 ```
 
-## Expectation testing
+### Expectation testing
 
 To simplify the way we run tests over different pieces of Ruby code, we use a custom expectations test framework against
 a set of Ruby fixtures.
@@ -99,14 +110,14 @@ end
 2. Set breakpoints in the code as desired
 3. Click the debug button on top of test examples
 
-## Debugging Running Ruby LSP Process
+## Live debugging
 
-1. Open [vscode-ruby-lsp](https://github.com/Shopify/vscode-ruby-lsp) in VS Code
-2. Under `Run and Debug`, select `Run extension` and click the start button (or press F5)
-3. The extension host window opened will be running a Ruby LSP process with the debugger attached. To start debugging
-the live process, go under `Run and Debug`, select `Attach to existing server` and click the start button (or
-press F5)
-4. Add breakpoints and perform the actions necessary for triggering the requests you wish to debug
+1. Under `Run and Debug`, select `Run extension` and click the start button (or press F5)
+2. The extension host window opened will be running the development version of the VS Code extension. Putting break
+points in the extension code will allow debugging
+3. If you wish to debug the server process, go under `Run and Debug` in the extension host window,
+select `Attach to existing server` and click the start button (or press F5)
+3. Add breakpoints and perform the actions necessary for triggering the requests you wish to debug
 
 ## Screen Captures
 

EDITORS.md

@@ -1,7 +1,7 @@
 # Editors
 
 This file contains community driven instructions on how to set up the Ruby LSP in editors other than VS Code. For VS
-Code, use the official [Ruby LSP extension](https://github.com/Shopify/vscode-ruby-lsp).
+Code, use the official [Ruby LSP extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp).
 
 <!-- When adding a new editor to the list, either link directly to a website containing the instructions or link to a
 new H2 header in this file containing the instructions. -->

LICENSE.txt

@@ -20,3 +20,23 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
+================================================================================
+The following files and related configuration in vscode/package.json are based
+on a sequence of adaptions: vscode/grammars/ruby.cson.json,
+vscode/grammars/erb.cson.json, vscode/languages/erb.json.
+
+Copyright (c) 2016 Peng Lv
+Copyright (c) 2017-2019 Stafford Brunk
+https://github.com/rubyide/vscode-ruby
+
+    Released under the MIT license
+    https://github.com/rubyide/vscode-ruby/blob/main/LICENSE.txt
+
+Copyright (c) 2014 GitHub Inc.
+https://github.com/atom/language-ruby
+
+    Released under the MIT license
+    https://github.com/atom/language-ruby/blob/master/LICENSE.md
+
+https://github.com/textmate/ruby.tmbundle
+    https://github.com/textmate/ruby.tmbundle#license