chore: Add formatting step in pyright-scip & update CI pipeline (#185)

* chore: Add linting and formatting commands to pyright-scip
* chore: Add AGENT.md for pyright-scip development instructions
* chore: Format pyright-scip with prettier
* chore: Add .git-blame-ignore-revs to ignore formatting commit
* chore: Add CI workflow for pyright-scip linting and formatting checks
* chore: Disable eslint checking -- too many issues
* chore: Run formatting & test checks on all PRs & commits
* chore: Replace asdf->mise

Author: varungandhi-src

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Format pyright-scip with prettier
+47615dfee4d2beea57b3ba61f97c1f14d035c9f5

.github/workflows/scip-docker.yml

@@ -14,17 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Install asdf.
-        uses: asdf-vm/actions/[email protected]
-      - name: Cache asdf and asdf-managed tools.
-        uses: actions/cache@v4
-        id: asdf-cache
+      - name: Install mise
+        uses: jdx/[email protected]
         with:
-          path: ${{ env.ASDF_DIR }}
-          key: asdf-${{ runner.os}}-${{ hashFiles('**/.tool-versions') }}
-      - name: Install asdf tools (if not cached).
-        if: steps.asdf-cache.outputs.cache-hit != 'true'
-        uses: asdf-vm/actions/[email protected]
+          version: 2025.8.10
       - name: Get npm cache directory
         id: npm-cache
         run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT

.github/workflows/scip-snapshot.yml

@@ -1,32 +1,24 @@
-name: scip-snapshots
+name: test
 
 on:
   push:
     branches:
+      - main
       - scip
   pull_request:
-    branches:
-      - scip
 
 jobs:
-  build:
+  check:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
-      - name: Install asdf.
-        uses: asdf-vm/actions/[email protected]
-      - name: Cache asdf and asdf-managed tools.
-        uses: actions/cache@v4
-        id: asdf-cache
+      - name: Install mise
+        uses: jdx/[email protected]
         with:
-          path: ${{ env.ASDF_DIR }}
-          key: asdf-${{ runner.os}}-${{ hashFiles('**/.tool-versions') }}
-      - name: Install asdf tools (if not cached).
-        if: steps.asdf-cache.outputs.cache-hit != 'true'
-        uses: asdf-vm/actions/[email protected]
+          version: 2025.8.10
       - name: Get npm cache directory
         id: npm-cache
         run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT

.github/workflows/scip-style.yml

@@ -0,0 +1,29 @@
+name: 'formatting'
+
+on:
+  push:
+    branches:
+      - main
+      - scip
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    name: check
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: jdx/[email protected]
+        with:
+          version: 2025.8.10
+
+      - run: npm install
+
+      - run: npm install
+        working-directory: packages/pyright-scip
+
+      - name: Check prettier formatting
+        run: npm run check:prettier
+        working-directory: packages/pyright-scip

packages/pyright-scip/.eslintrc.js

@@ -9,4 +9,5 @@ module.exports = {
     },
     ignorePatterns: ['temp', 'lsif.ts', 'snapshots'],
     rules: {},
+    root: true,
 };

packages/pyright-scip/.prettierignore

@@ -0,0 +1,5 @@
+*.md
+*.markdown
+dist/
+node_modules/
+snapshots/

packages/pyright-scip/AGENT.md

@@ -0,0 +1,26 @@
+# Agent Instructions for pyright-scip
+
+## Development Commands
+
+### Testing
+
+-   `npm test` - Run Jest tests
+-   `npm run check-snapshots` - Check snapshot tests
+-   `npm run update-snapshots` - Update snapshot tests
+
+### Building
+
+-   `npm run webpack` - Development build
+-   `npm run build` - Production build
+-   `npm run watch` - Development build with watch mode
+
+### Formatting
+
+-   `npm run fix:prettier` - Fix prettier formatting issues
+-   `npm run check:prettier` - Check prettier formatting
+
+## Code Style
+
+-   Follow existing TypeScript patterns in the codebase
+-   Use the Sourcegraph ESLint config and Prettier config
+-   When modifying pyright-internal code, keep changes minimal and add `NOTE(scip-python):` prefix to comments

packages/pyright-scip/CONTRIBUTING.md

@@ -1,46 +1,41 @@
 # Contributing to scip-python
 
-- [Development](#development)
-  - [Installing dependencies](#installing-dependencies)
-  - [Building the code](#building-the-code)
-  - [Running tests](#running-tests)
-- [Publishing releases](#publishing-releases)
+-   [Development](#development)
+    -   [Installing dependencies](#installing-dependencies)
+    -   [Building the code](#building-the-code)
+    -   [Running tests](#running-tests)
+    -   [Formatting](#formatting)
+-   [Publishing releases](#publishing-releases)
 
 ## Development
 
 ### Installing dependencies
 
-1. Install [ASDF](https://asdf-vm.com/guide/getting-started.html).
+1. Install [mise](https://mise.jdx.dev/getting-started.html).
 2. Install the correct versions of Node and Python:
+
     ```bash
-    asdf plugin add nodejs
-    asdf plugin add python
+    mise plugin install nodejs
+    mise plugin install python
     # Install appropriate Node and Python versions based on .tool-versions
-    asdf install
-    ````
-   You may need to restart your shell for the changes to take effect.
-
-   NOTE: On Linux, ASDF may try to install Python from source instead of
-   using prebuilt binaries. In that case, you need to install a bunch of
-   other dependencies first:
-   ```bash
-   sudo apt update
-   sudo apt install -y build-essential zlib1g-dev libssl-dev libbz2-dev libsqlite3-dev libncurses-dev libffi-dev readline-common libreadline-dev liblzma-dev
-   ```
+    mise install
+    ```
+
+    You may need to restart your shell for the changes to take effect.
+
 3. Install dependencies:
-   ```bash
-   # From the root of the repo
-   npm install
-   cd packages/pyright-scip
-   npm install
-   ```
+    ```bash
+    # From the root of the repo
+    npm install
+    cd packages/pyright-scip
+    npm install
+    ```
 
 All the other commands should be run from the `packages/pyright-scip`
 subdirectory.
 
 ### Building the code
 
-
 ```bash
 # Build in development mode once
 npm run webpack
@@ -76,6 +71,7 @@ npm run check-snapshots
 #### Filter specific snapshot tests
 
 Use the `--filter-tests` flag to run only specific snapshot tests:
+
 ```bash
 # Using npm scripts (note the -- to pass arguments)
 npm run check-snapshots -- --filter-tests test1,test2,test3
@@ -86,6 +82,22 @@ Available snapshot tests can be found in `snapshots/input/`.
 Using a different Python version other than the one specified
 in `.tool-versions` may also lead to errors.
 
+### Formatting
+
+To check for formatting issues:
+
+```bash
+# Check prettier formatting
+npm run check:prettier
+```
+
+To fix formatting issues:
+
+```bash
+# Fix prettier formatting issues
+npm run fix:prettier
+```
+
 ## Making changes to Pyright internals
 
 When modifying code in the `pyright-internal` package:

packages/pyright-scip/index.js

@@ -15,9 +15,13 @@ if (typeof module.setSourceMapsSupport === 'function') {
     const nodeOptions = process.env.NODE_OPTIONS || '';
     if (!nodeOptions.includes('--enable-source-maps')) {
         if (nodeOptions) {
-            console.warn('Source maps support not available. Consider adding --enable-source-maps to the existing NODE_OPTIONS environment variable.');
+            console.warn(
+                'Source maps support not available. Consider adding --enable-source-maps to the existing NODE_OPTIONS environment variable.'
+            );
         } else {
-            console.warn('Source maps support not available. Consider setting the NODE_OPTIONS environment variable to "--enable-source-maps".');
+            console.warn(
+                'Source maps support not available. Consider setting the NODE_OPTIONS environment variable to "--enable-source-maps".'
+            );
         }
     }
 }