Skip to content

CLAUDE.md

Latest commit

 

History

History
41 lines (28 loc) · 2.8 KB

CLAUDE.md

File metadata and controls

41 lines (28 loc) · 2.8 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

VS Code extension providing Hack language and HHVM debugger support. Published to the VS Code Marketplace as pranayagarwal.vscode-hack. Repository owned by Slack (slackhq/vscode-hack).

Build & Development Commands

  • Install dependencies: npm install
  • Compile: npm run compile (runs tsc -p ./)
  • Watch mode: npm run watch (runs tsc -watch -p ./)
  • Run tests: npm test (compiles first via pretest, then runs integration tests using @vscode/test-electron which downloads a VS Code instance). In headless environments (e.g. CI, VMs without a display), prefix with xvfb-run: xvfb-run npm test
  • Grammar snapshot tests: npm run test:grammar (uses vscode-tmgrammar-snap to verify TextMate tokenization of test/grammar/*.hack files against corresponding .hack.snap snapshots). To update snapshots after changing the grammar (syntaxes/hack.json), run npm run test:grammar:update. Grammar tests also run as part of npm test.
  • Package extension: npm run package (uses vsce package)

To debug the extension in VS Code, use the "Run Extension" launch configuration which opens a new Extension Host window.

Architecture

The extension activates when a workspace contains a .hhconfig file. Entry point is src/main.ts.

Key modules:

  • src/LSPHackTypeChecker.ts — Typechecker integration using hh_client in LSP mode via vscode-languageclient.
  • src/Config.ts — Reads all hack.* VS Code settings at extension startup (not dynamically reloaded except for hack.remote.* which prompts a window reload)
  • src/proxy.ts — Wraps hh_client CLI invocations (version check, type-at-pos, autocomplete, format, etc.), always passing --json
  • src/remote.ts — Translates commands/args for SSH or Docker remote execution based on hack.remote.* config
  • src/LSPHHASTLint.ts — Separate LSP client for HHAST linting
  • src/debugger.ts — Standalone debug adapter (thin TCP-to-stdin/stdout bridge since HHVM speaks the debug protocol over TCP). Runs as a separate Node process (out/debugger)
  • src/coveragechecker.ts — Hack type coverage percentage display using LSP typeCoverage capability

Type definitions are in src/types/hack.d.ts (Hack tool response types) and src/types/lsp.d.ts (custom LSP extensions).

TypeScript Configuration

  • Target: ES2020, Module: NodeNext
  • Strict mode enabled
  • Uses project references: root tsconfig.json has no include of its own and references src/tsconfig.json and test/tsconfig.json as composite sub-projects
  • Source in src/, tests in test/, compiled output in out/src/ and out/test/ respectively