Add CI, formatting, and linting

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[*.md]
+indent_size = 2
+
+[*.{yml, yaml}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,6 @@
+* text=auto eol=lf
+
+# Older git versions try to fix line endings on images, this prevents it.
+*.png binary
+*.jpg binary
+*.ico binary

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a bug report for surrealql-lsp.
+title: ''
+labels: 'C-bug'
+assignees: ''
+
+---
+
+<!--
+Please try to provide information which will help us to fix the issue faster. Minimal reproducible examples with few dependencies are especially lovely <3.
+-->
+
+**rustc version**: (eg. output of `rustc -V`)
+
+**editor or extension**: (eg. VSCode, Vim, Emacs, etc. For VSCode users, specify your extension version; for users of other editors, provide the distribution if applicable)
+
+**repository link (if public, optional)**: (eg. [surrealql-lsp](https://github.com/Ce11an/surrealql-lsp))
+
+**code snippet to reproduce**:
+```sql
+-- add your code here
+
+```

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,8 @@
+---
+name: Feature Request
+about: Create a feature request for surrealql-lsp.
+itle: ''
+labels: 'C-feature'
+assignees: ''
+
+---

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,8 @@
+---
+name: Support Question
+about: A question regarding functionality of surrealql-lsp.
+title: ''
+labels: 'C-support'
+assignees: ''
+
+---

.github/rust.json

@@ -0,0 +1,33 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "rustfmt",
+            "severity": "warning",
+            "pattern": [
+                {
+                    "regexp": "^(Diff in (.+)) at line (\\d+):$",
+                    "message": 1,
+                    "file": 2,
+                    "line": 3
+                }
+            ]
+        },
+        {
+            "owner": "clippy",
+            "pattern": [
+                {
+                    "regexp": "^(?:\\x1b\\[[\\d;]+m)*(warning|warn|error)(?:\\x1b\\[[\\d;]+m)*(\\[(.*)\\])?(?:\\x1b\\[[\\d;]+m)*:(?:\\x1b\\[[\\d;]+m)* ([^\\x1b]*)(?:\\x1b\\[[\\d;]+m)*$",
+                    "severity": 1,
+                    "message": 4,
+                    "code": 3
+                },
+                {
+                    "regexp": "^(?:\\x1b\\[[\\d;]+m)*\\s*(?:\\x1b\\[[\\d;]+m)*\\s*--> (?:\\x1b\\[[\\d;]+m)*(.*):(\\d*):(\\d*)(?:\\x1b\\[[\\d;]+m)*$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3
+                }
+            ]
+        }
+    ]
+}

.github/workflows/ci.yaml

@@ -0,0 +1,158 @@
+# Please make sure that the `needs` fields for both `end-success` and `end-failure`
+# are updated when adding new jobs!
+
+name: CI
+on:
+  pull_request:
+
+env:
+  CARGO_INCREMENTAL: 0
+  CARGO_NET_RETRY: 10
+  CI: 1
+  RUST_BACKTRACE: short
+  RUSTFLAGS: "-D warnings -W unreachable-pub -W bare-trait-objects"
+  RUSTUP_MAX_RETRIES: 10
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    permissions:
+     pull-requests: read
+    outputs:
+      typescript: ${{ steps.filter.outputs.typescript }}
+      proc_macros: ${{ steps.filter.outputs.proc_macros }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@1441771bbfdd59dcd748680ee64ebd8faab1a242
+        id: filter
+        with:
+          filters: |
+            typescript:
+              - 'editors/code/**'
+
+  rust:
+    needs: changes
+    name: Rust
+    runs-on: ${{ matrix.os }}
+    env:
+      RUST_CHANNEL: "${{ 'nightly' || 'stable' }}"
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install Rust toolchain
+        run: |
+          rustup update --no-self-update ${{ env.RUST_CHANNEL }}
+          rustup default ${{ env.RUST_CHANNEL }}
+          rustup component add --toolchain ${{ env.RUST_CHANNEL }} rustfmt rust-src
+        # https://github.com/actions-rust-lang/setup-rust-toolchain/blob/main/rust.json
+      - name: Install Rust Problem Matcher
+        if: matrix.os == 'ubuntu-latest'
+        run: echo "::add-matcher::.github/rust.json"
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@9bdad043e88c75890e36ad3bbc8d27f0090dd609
+        with:
+          key: ${{ env.RUST_CHANNEL }}
+
+      - name: Bump opt-level
+        if: matrix.os == 'ubuntu-latest'
+        run: sed -i '/\[profile.dev]/a opt-level=1' Cargo.toml
+
+      - name: Compile (tests)
+        run: cargo test --no-run --locked
+
+      # It's faster to `test` before `build` ¯\_(ツ)_/¯
+      - name: Compile (surrealql-lsp)
+        if: matrix.os == 'ubuntu-latest'
+        run: cargo build --quiet
+
+      - name: Test
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'windows-latest' || github.event_name == 'push'
+        run: cargo test -- --nocapture --quiet
+
+      - name: Switch to stable toolchain
+        run: |
+          rustup update --no-self-update stable
+          rustup component add --toolchain stable rust-src clippy
+          rustup default stable
+
+      - name: clippy
+        if: matrix.os == 'windows-latest'
+        run: cargo clippy --all-targets
+
+      - name: rustfmt
+        if: matrix.os == 'ubuntu-latest'
+        run: cargo fmt -- --check
+
+  typescript:
+    needs: changes
+    name: TypeScript
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        if: needs.changes.outputs.typescript == 'true'
+
+      - name: Install Nodejs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+        if: needs.changes.outputs.typescript == 'true'
+
+      - run: npm ci
+        working-directory: ./editors/code
+        if: needs.changes.outputs.typescript == 'true'
+
+      # If this steps fails, your code's type integrity might be wrong at some places at TypeScript level.
+      - run: npm run typecheck
+        working-directory: ./editors/code
+        if: needs.changes.outputs.typescript == 'true'
+
+      # You may fix the code automatically by running `npm run lint:fix` if this steps fails.
+      - run: npm run lint:check
+        working-directory: ./editors/code
+        if: needs.changes.outputs.typescript == 'true'
+
+      # To fix this steps, please run `npm run format`.
+      - run: npm run format:check
+        working-directory: ./editors/code
+        if: needs.changes.outputs.typescript == 'true'
+
+      - run: npm run package --scripts-prepend-node-path
+        working-directory: ./editors/code
+        if: needs.changes.outputs.typescript == 'true'
+
+  typo-check:
+    name: Typo Check
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    env:
+      FORCE_COLOR: 1
+      TYPOS_VERSION: v1.18.0
+    steps:
+      - name: download typos
+        run: curl -LsSf https://github.com/crate-ci/typos/releases/download/$TYPOS_VERSION/typos-$TYPOS_VERSION-x86_64-unknown-linux-musl.tar.gz | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: check for typos
+        run: typos
+

.vscode/extensions.json

@@ -1,9 +1,9 @@
-{
-  // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
-  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
-
-  // List of extensions which should be recommended for users of this workspace.
-  "recommendations": ["vadimcn.vscode-lldb", "rust-lang.rust-analyzer"],
-  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
-  "unwantedRecommendations": []
-}
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": ["vadimcn.vscode-lldb", "rust-lang.rust-analyzer"],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
+}

.vscode/launch.json

@@ -1,27 +1,27 @@
-// A launch configuration that compiles the extension and then opens it inside a new window
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      // Used for testing the extension with a local build of the LSP server (in `target/debug`).
-      "name": "Run Extension (Debug Build)",
-      "type": "extensionHost",
-      "request": "launch",
-      "runtimeExecutable": "${execPath}",
-      "args": [
-        "--disable-extensions",
-        "--extensionDevelopmentPath=${workspaceFolder}/editors/code"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/editors/code/out/**/*.js"
-      ],
-      "preLaunchTask": "Build Server and Extension",
-      "env": {
-        "SERVER_PATH": "${workspaceRoot}/target/debug/surrealql-lsp-server"
-      },
-      "skipFiles": [
-        "<node_internals>/**/*.js"
-      ],
-    },
-  ]
-}
+// A launch configuration that compiles the extension and then opens it inside a new window
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+    // Used for testing the extension with a local build of the LSP server (in `target/debug`).
+    "name": "Run Extension (Debug Build)",
+    "type": "extensionHost",
+    "request": "launch",
+    "runtimeExecutable": "${execPath}",
+    "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}/editors/code"
+    ],
+    "outFiles": [
+        "${workspaceFolder}/editors/code/out/**/*.js"
+    ],
+    "preLaunchTask": "Build Server and Extension",
+    "env": {
+        "SERVER_PATH": "${workspaceRoot}/target/debug/surrealql-lsp-server"
+    },
+    "skipFiles": [
+        "<node_internals>/**/*.js"
+    ],
+    },
+  ]
+}

.vscode/tasks.json

@@ -1,26 +1,26 @@
-{
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "label": "Build Extension",
-      "group": "build",
-      "type": "npm",
-      "script": "build",
-      "path": "editors/code/",
-      "problemMatcher": {
-        "base": "$tsc",
-        "fileLocation": ["relative", "${workspaceFolder}/editors/code/"]
-      },
-    },
-    {
-      "label": "Build Server",
-      "group": "build",
-      "type": "shell",
-      "command": "cargo build --package surrealql-lsp-server",
-    },
-    {
-      "label": "Build Server and Extension",
-      "dependsOn": ["Build Server", "Build Extension"],
-    }
-  ]
-}
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+    "label": "Build Extension",
+    "group": "build",
+    "type": "npm",
+    "script": "build",
+    "path": "editors/code/",
+    "problemMatcher": {
+        "base": "$tsc",
+        "fileLocation": ["relative", "${workspaceFolder}/editors/code/"]
+    },
+    },
+    {
+    "label": "Build Server",
+    "group": "build",
+    "type": "shell",
+    "command": "cargo build --package surrealql-lsp-server",
+    },
+    {
+    "label": "Build Server and Extension",
+    "dependsOn": ["Build Server", "Build Extension"],
+    }
+  ]
+}