@ttsc/vscode 0.11.0 → 0.12.0

package/README.md

@@ -1,39 +1,73 @@
-# @ttsc/vscode
+# `@ttsc/vscode`
 
-VSCode extension that runs the `ttscserver` Language Server for TypeScript-Go
-projects. It surfaces ttsc plugin (lint/format) diagnostics alongside the
-tsgo type-check diagnostics in the same publishDiagnostics stream and
-exposes ttsc-owned code actions and commands.
+![banner of @ttsc/vscode](https://ttsc.dev/og.jpg)
 
-## What it does
+MIT licensed · [npm](https://www.npmjs.com/package/@ttsc/vscode) · [docs](https://ttsc.dev/docs) · [Discord](https://discord.gg/E94XhzrUCZ)
 
-- Spawns `ttscserver` from the workspace's installed `ttsc` package (or a
-  user-supplied absolute path).
-- Receives merged diagnostics, hovers, completions, definitions from the
-  embedded tsgo LSP server.
-- Adds the ttsc-owned commands `ttsc.lint.fixAll`, `ttsc.format.document`,
-  and `ttsc.server.restart` to the command palette.
+VSCode extension for [`ttsc`](https://ttsc.dev) projects.
 
-## Local install (testing)
+Lint diagnostics, format hints, and plugin code actions appear in your editor live — the same diagnostics `ttsc` would emit at build time, shown as you type.
+
+## Requirements
+
+- **VS Code** 1.94 or later
+- **Node.js** 18 or later
+- **`ttsc` installed in your project** — the extension uses the language server that ships with your project's `ttsc` package
 
 ```bash
-# from the repo root
-pnpm install
-pnpm -F @ttsc/vscode build
+npm install -D ttsc @ttsc/lint @typescript/native-preview
 ```
 
-Then in VSCode:
+## Install
+
+The extension is not on the VS Code Marketplace yet. For now it ships as an npm package with a one-shot installer:
+
+```bash
+npm install -D @ttsc/vscode
+npx ttsc-vscode
+```
+
+`npx ttsc-vscode` calls `code --install-extension` with the `.vsix` bundled in the npm tarball — VS Code picks it up immediately, no restart needed.
+
+If the `code` CLI isn't on your `PATH`, open VS Code first, run **Shell Command: Install 'code' command in PATH** from the command palette, then re-run `npx ttsc-vscode`. (As a manual fallback, VS Code → Extensions → "…" menu → **Install from VSIX** also works on the file `npx ttsc-vscode` would have used — it lives under `node_modules/@ttsc/vscode/dist/`.)
+
+To uninstall:
 
 ```bash
-code --extensionDevelopmentPath=packages/vscode <your-project>
+npx ttsc-vscode uninstall
 ```
 
-The extension activates on any TypeScript / TSX / JS / JSX file inside the
-project. The Output channel "ttsc" shows the language server log.
+Marketplace release is tracked for v1; once it lands, the `npx` step goes away.
 
-## Configuration
+## What it adds
 
-| Setting | Default | Purpose |
+The extension activates on any TypeScript, JavaScript, TSX, or JSX file inside a project that has `ttsc` installed.
+
+- **Live lint underlines.** Violations from `@ttsc/lint` (and any third-party rule plugins you've installed) appear in the same gutter as TypeScript type errors — same `error TSxxxxx` shape.
+- **Quick fixes** for autofixable rules under the lightbulb menu.
+- **Command palette entries:**
+  - `ttsc: Apply lint fixes to current file`
+  - `ttsc: Format current document`
+  - `ttsc: Restart language server`
+
+The extension's identifier inside VS Code is `samchon.ttsc`.
+
+## Settings
+
+Open VS Code's settings (`Ctrl+,` / `Cmd+,`) and search for `ttsc`, or edit `settings.json` directly:
+
+| Setting | Default | Effect |
 | --- | --- | --- |
-| `ttsc.serverPath` | `""` | Absolute path to the `ttscserver` binary. Empty means resolve from the workspace `ttsc` install. |
-| `ttsc.trace.server` | `"off"` | LSP message tracing — set to `"messages"` or `"verbose"` for debugging. |
+| `ttsc.serverPath` | `""` | Absolute path to a language-server binary. Empty means use the one bundled with the project's `ttsc` install — almost always what you want. |
+| `ttsc.trace.server` | `"off"` | Set to `"messages"` or `"verbose"` to log LSP traffic. The log goes to **View → Output → ttsc**. Useful when diagnostics don't show up. |
+
+## Troubleshooting
+
+If lint underlines don't appear after install:
+
+1. **Check the project has `ttsc`:** `npx ttsc --version`. If this errors, install `ttsc @ttsc/lint @typescript/native-preview` in the project first.
+2. **Read the server log:** open **View → Output**, pick **ttsc** from the dropdown.
+3. **Restart the server:** command palette → `ttsc: Restart language server`.
+4. **Verbose tracing:** set `ttsc.trace.server` to `"verbose"`, repeat step 2.
+
+If `npx ttsc-vscode` errors with `\`code\` CLI not found on PATH`: open VS Code → command palette → **Shell Command: Install 'code' command in PATH**, then retry the install.

package/lib/extension.js

@@ -18118,14 +18118,16 @@ var client;
 function resolveServerLauncher() {
   const config = import_vscode.workspace.getConfiguration("ttsc");
   const explicit = config.get("serverPath", "").trim();
+  const bases = collectResolutionBases();
   if (explicit && path.isAbsolute(explicit)) {
     return {
       command: explicit,
       args: ["--stdio"],
+      options: serverProcessOptions(bases[0]),
       transport: import_node.TransportKind.stdio
     };
   }
-  for (const base of collectResolutionBases()) {
+  for (const base of bases) {
     try {
       const launcher = require.resolve("ttsc/lib/launcher/ttscserver.js", {
         paths: [base]
@@ -18133,6 +18135,7 @@ function resolveServerLauncher() {
       return {
         module: launcher,
         args: ["--stdio"],
+        options: serverProcessOptions(base),
         transport: import_node.TransportKind.stdio
       };
     } catch {
@@ -18140,6 +18143,40 @@ function resolveServerLauncher() {
   }
   return void 0;
 }
+function serverProcessOptions(base) {
+  const tsgo = base ? resolveTsgoBinary(base) : void 0;
+  if (!base && !tsgo) {
+    return void 0;
+  }
+  return {
+    cwd: base,
+    env: tsgo ? {
+      ...process.env,
+      TTSC_TSGO_BINARY: tsgo
+    } : process.env
+  };
+}
+function resolveTsgoBinary(base) {
+  try {
+    const packageJson = require.resolve(
+      "@typescript/native-preview/package.json",
+      { paths: [base] }
+    );
+    const packageRoot = path.dirname(packageJson);
+    const platformPackage = `@typescript/native-preview-${process.platform}-${process.arch}`;
+    const platformPackageJson = require.resolve(
+      `${platformPackage}/package.json`,
+      { paths: [packageRoot] }
+    );
+    return path.join(
+      path.dirname(platformPackageJson),
+      "lib",
+      process.platform === "win32" ? "tsgo.exe" : "tsgo"
+    );
+  } catch {
+    return void 0;
+  }
+}
 function collectResolutionBases() {
   const bases = [];
   const active = import_vscode.window.activeTextEditor?.document.uri;