Add pipeline for linting and formatting

Author: jakubno

.eslintrc.cjs

@@ -0,0 +1,26 @@
+module.exports = {
+  env: {
+    node: true,
+    browser: true,
+    es6: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  ignorePatterns: ['dist/', 'node_modules/', '*.gen.ts'],
+  plugins: ['@typescript-eslint', 'unused-imports', '@stylistic/ts'],
+  rules: {
+    '@typescript-eslint/member-ordering': 'error',
+    '@typescript-eslint/ban-ts-comment': 'off', // "move fast" mode
+    '@typescript-eslint/no-explicit-any': 'off', // "move fast" mode
+    'linebreak-style': ['error', 'unix'],
+    'unused-imports/no-unused-imports': 'error',
+    // No double quotes
+    quotes: ['error', 'single', { avoidEscape: true }],
+    // No extra semicolon
+    '@stylistic/ts/semi': ['error', 'never'],
+  },
+}

.github/workflows/lint.yml

@@ -0,0 +1,68 @@
+name: Lint
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.15.5
+
+      - name: Setup Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: pnpm
+
+      - name: Configure pnpm
+        run: |
+          pnpm config set auto-install-peers true
+          pnpm config set exclude-links-from-lockfile true
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Install Python dependencies
+        working-directory: python
+        run: |
+          poetry install --with dev
+
+      - name: Run linting
+        run: |
+          pnpm run lint
+
+      - name: Run formatting
+        run: |
+          pnpm run format
+
+      - name: Check for uncommitted changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "❌ Files are not formatted properly:"
+            git status --short
+            git diff
+            exit 1
+          else
+            echo "✅ No changes detected."
+          fi

package.json

@@ -4,12 +4,19 @@
   "scripts": {
     "version": "changeset version && pnpm run -r postVersion",
     "publish": "changeset publish && pnpm run -r postPublish",
-    "rm-node-modules": "find . -name 'node_modules' -type d -prune -exec rm -rf '{}' +"
+    "rm-node-modules": "find . -name 'node_modules' -type d -prune -exec rm -rf '{}' +",
+    "lint": "pnpm --if-present --recursive run lint",
+    "format": "pnpm --if-present --recursive run format"
   },
-  "packageManager": "pnpm@8.7.6",
+  "packageManager": "pnpm@9.15.5",
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "@changesets/read": "^0.6.5",
-    "changeset": "^0.2.6"
+    "changeset": "^0.2.6",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
+    "eslint": "^8.57.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "@stylistic/eslint-plugin-ts": "^1.6.2"
   }
 }

packages/js-sdk/.eslintrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: '../../.eslintrc.cjs',
+}

packages/js-sdk/example.mts

@@ -2,47 +2,44 @@ import { config } from 'dotenv'
 
 config()
 import { Sandbox } from './dist'
-import { writeFileSync } from 'fs';
+import { writeFileSync } from 'fs'
 
+console.log('Starting desktop sandbox...')
 
-console.log("Starting desktop sandbox...")
+console.time('--> Sandbox creation time')
+const desktop = await Sandbox.create()
+console.timeEnd('--> Sandbox creation time')
 
-console.time('--> Sandbox creation time');
-const desktop = await Sandbox.create();
-console.timeEnd('--> Sandbox creation time');
-
-console.log("Desktop Sandbox started, ID:", desktop.sandboxId)
-console.log("Screen size:", await desktop.getScreenSize())
+console.log('Desktop Sandbox started, ID:', desktop.sandboxId)
+console.log('Screen size:', await desktop.getScreenSize())
 
 await desktop.stream.start({
-  requireAuth: true
+  requireAuth: true,
 })
 
 const authKey = await desktop.stream.getAuthKey()
-console.log("Stream URL:", desktop.stream.getUrl({ authKey }))
+console.log('Stream URL:', desktop.stream.getUrl({ authKey }))
 
-await new Promise(resolve => setTimeout(resolve, 5000));
+await new Promise((resolve) => setTimeout(resolve, 5000))
 
 console.log("Moving mouse to 'Applications' and clicking...")
 await desktop.moveMouse(100, 100)
 await desktop.leftClick()
-console.log("Cursor position:", await desktop.getCursorPosition())
-
-await new Promise(resolve => setTimeout(resolve, 1000));
+console.log('Cursor position:', await desktop.getCursorPosition())
 
-const screenshot = await desktop.screenshot("bytes")
-writeFileSync('1.png', Buffer.from(screenshot));
+await new Promise((resolve) => setTimeout(resolve, 1000))
 
+const screenshot = await desktop.screenshot('bytes')
+writeFileSync('1.png', Buffer.from(screenshot))
 
 for (let i = 0; i < 20; i++) {
-  const x = Math.floor(Math.random() * 1024);
-  const y = Math.floor(Math.random() * 768);
-  await desktop.moveMouse(x, y);
-  await new Promise(resolve => setTimeout(resolve, 2000));
-  await desktop.rightClick();
+  const x = Math.floor(Math.random() * 1024)
+  const y = Math.floor(Math.random() * 768)
+  await desktop.moveMouse(x, y)
+  await new Promise((resolve) => setTimeout(resolve, 2000))
+  await desktop.rightClick()
   console.log('right clicked', i)
 }
 
-
 await desktop.stream.stop()
 await desktop.kill()

packages/js-sdk/package.json

@@ -49,7 +49,9 @@
     "dev": "tsup --watch",
     "test": "vitest run --disable-console-intercept",
     "example": "npx tsx example.mts",
-    "generate-ref": "./scripts/generate_sdk_ref.sh"
+    "generate-ref": "./scripts/generate_sdk_ref.sh",
+    "lint": "eslint src/ tests/",
+    "format": "prettier --write src/ tests/ example.mts"
   },
   "devDependencies": {
     "@types/node": "^22.13.9",

packages/js-sdk/src/index.ts

@@ -1,3 +1,3 @@
 export * from 'e2b'
 
-export { Sandbox } from './sandbox'
+export { Sandbox } from './sandbox'

packages/js-sdk/src/sandbox.ts

@@ -143,9 +143,9 @@ export interface SandboxBetaCreateOpts extends SandboxBetaCreateOptsBase {
 
 export class Sandbox extends SandboxBase {
   protected static override readonly defaultTemplate: string = 'desktop'
-  private lastXfce4Pid: number | null = null
   public display: string = ':0'
   public stream: VNCServer = new VNCServer(this)
+  private lastXfce4Pid: number | null = null
 
   /**
    * Use {@link Sandbox.create} to create a new Sandbox instead.
@@ -323,28 +323,6 @@ export class Sandbox extends SandboxBase {
     return false
   }
 
-  /**
-   * Start xfce4 session if logged out or not running.
-   */
-  private async startXfce4(): Promise<void> {
-    if (
-      this.lastXfce4Pid === null ||
-      (
-        await this.commands.run(
-          `ps aux | grep ${this.lastXfce4Pid} | grep -v grep | head -n 1`
-        )
-      ).stdout
-        .trim()
-        .includes('[xfce4-session] <defunct>')
-    ) {
-      const result = await this.commands.run('startxfce4', {
-        background: true,
-        timeoutMs: 0,
-      })
-      this.lastXfce4Pid = result.pid
-    }
-  }
-
   /**
    * Take a screenshot and save it to the given name.
    * @param format - The format of the screenshot.
@@ -507,26 +485,6 @@ export class Sandbox extends SandboxBase {
     }
   }
 
-  private *breakIntoChunks(text: string, n: number): Generator<string> {
-    for (let i = 0; i < text.length; i += n) {
-      yield text.slice(i, i + n)
-    }
-  }
-
-  private quoteString(s: string): string {
-    if (!s) {
-      return "''"
-    }
-
-    if (!/[^\w@%+=:,./-]/.test(s)) {
-      return s
-    }
-
-    // use single quotes, and put single quotes into double quotes
-    // the string $'b is then quoted as '$'"'"'b'
-    return "'" + s.replace(/'/g, "'\"'\"'") + "'"
-  }
-
   /**
    * Write the given text at the current cursor position.
    * @param text - The text to write.
@@ -708,47 +666,6 @@ class VNCServer {
     return this.password
   }
 
-  /**
-   * Set the VNC command to start the VNC server.
-   */
-  private async getVNCCommand(windowId?: string): Promise<string> {
-    let pwdFlag = '-nopw'
-    if (this.novncAuthEnabled) {
-      // Create .vnc directory if it doesn't exist
-      await this.desktop.commands.run('mkdir -p ~/.vnc')
-      await this.desktop.commands.run(
-        `x11vnc -storepasswd ${this.password} ~/.vnc/passwd`
-      )
-      pwdFlag = '-usepw'
-    }
-
-    return (
-      `x11vnc -bg -display ${this.desktop.display} -forever -wait 50 -shared ` +
-      `-rfbport ${this.vncPort} ${pwdFlag} 2>/tmp/x11vnc_stderr.log` +
-      (windowId ? ` -id ${windowId}` : '')
-    )
-  }
-
-  private async waitForPort(port: number): Promise<boolean> {
-    return await this.desktop.waitAndVerify(
-      `netstat -tuln | grep ":${port} "`,
-      (r: CommandResult) => r.stdout.trim() !== ''
-    )
-  }
-
-  /**
-   * Check if the VNC server is running.
-   * @returns Whether the VNC server is running.
-   */
-  private async checkVNCRunning(): Promise<boolean> {
-    try {
-      const result = await this.desktop.commands.run('pgrep -x x11vnc')
-      return result.stdout.trim() !== ''
-    } catch (error) {
-      return false
-    }
-  }
-
   /**
    * Get the URL to a web page with a stream of the desktop sandbox.
    * @param autoConnect - Whether to automatically connect to the server after opening the URL.
@@ -767,7 +684,7 @@ class VNCServer {
       throw new Error('Server is not running')
     }
 
-    let url = new URL(this.url)
+    const url = new URL(this.url)
     if (autoConnect) {
       url.searchParams.set('autoconnect', 'true')
     }
@@ -823,4 +740,45 @@ class VNCServer {
       this.novncHandle = null
     }
   }
+
+  /**
+   * Set the VNC command to start the VNC server.
+   */
+  private async getVNCCommand(windowId?: string): Promise<string> {
+    let pwdFlag = '-nopw'
+    if (this.novncAuthEnabled) {
+      // Create .vnc directory if it doesn't exist
+      await this.desktop.commands.run('mkdir -p ~/.vnc')
+      await this.desktop.commands.run(
+        `x11vnc -storepasswd ${this.password} ~/.vnc/passwd`
+      )
+      pwdFlag = '-usepw'
+    }
+
+    return (
+      `x11vnc -bg -display ${this.desktop.display} -forever -wait 50 -shared ` +
+      `-rfbport ${this.vncPort} ${pwdFlag} 2>/tmp/x11vnc_stderr.log` +
+      (windowId ? ` -id ${windowId}` : '')
+    )
+  }
+
+  private async waitForPort(port: number): Promise<boolean> {
+    return await this.desktop.waitAndVerify(
+      `netstat -tuln | grep ":${port} "`,
+      (r: CommandResult) => r.stdout.trim() !== ''
+    )
+  }
+
+  /**
+   * Check if the VNC server is running.
+   * @returns Whether the VNC server is running.
+   */
+  private async checkVNCRunning(): Promise<boolean> {
+    try {
+      const result = await this.desktop.commands.run('pgrep -x x11vnc')
+      return result.stdout.trim() !== ''
+    } catch (error) {
+      return false
+    }
+  }
 }