@ttsc/vscode 0.13.1 → 0.14.0-dev.20250530.1

package/README.md

@@ -2,72 +2,62 @@
 
 ![banner of @ttsc/vscode](https://ttsc.dev/og.jpg)
 
-MIT licensed · [npm](https://www.npmjs.com/package/@ttsc/vscode) · [docs](https://ttsc.dev/docs) · [Discord](https://discord.gg/E94XhzrUCZ)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/ttsc/blob/master/LICENSE) [![NPM Version](https://img.shields.io/npm/v/@ttsc/vscode.svg)](https://www.npmjs.com/package/@ttsc/vscode) [![NPM Downloads](https://img.shields.io/npm/dm/@ttsc/vscode.svg)](https://www.npmjs.com/package/@ttsc/vscode) [![Build Status](https://github.com/samchon/ttsc/workflows/test/badge.svg)](https://github.com/samchon/ttsc/actions?query=workflow%3Atest) [![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://ttsc.dev/docs) [![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
 
-VSCode extension for [`ttsc`](https://ttsc.dev) projects.
+VS Code extension for [`ttsc`](https://ttsc.dev) projects. It shows TypeScript-Go diagnostics and `@ttsc/lint` lint and format inside your editor.
 
-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.
+## Setup
 
-## Requirements
+### 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
+- **`ttsc`, `@ttsc/lint`, and `@typescript/native-preview` in your project.** `@typescript/native-preview` is the TypeScript-Go engine `ttsc` runs on; it is a separate package that `ttsc` does not bundle.
 
 ```bash
 npm install -D ttsc @ttsc/lint @typescript/native-preview
 ```
 
-## Install
+### Install
 
-The extension is not on the VS Code Marketplace yet. For now it ships as an npm package with a one-shot installer:
+Not on the VS Code Marketplace yet. Run `npx @ttsc/vscode`; it downloads the package and installs the bundled `.vsix` into VS Code, nothing to keep as a dependency:
 
 ```bash
-npm install -D @ttsc/vscode
-npx 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`, run **Shell Command: Install 'code' command in PATH** from VS Code's command palette, then re-run `npx @ttsc/vscode`.
 
-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/`.)
+### Format on save
 
-To uninstall:
+Set `samchon.ttsc` as the default formatter and turn on `editor.formatOnSave` in `.vscode/settings.json`:
 
-```bash
-npx ttsc-vscode uninstall
+```jsonc
+"[typescript][typescriptreact]": {
+  "editor.defaultFormatter": "samchon.ttsc",
+  "editor.formatOnSave": true
+}
 ```
 
-Marketplace release is tracked for v1; once it lands, the `npx` step goes away.
-
-## What it adds
-
-The extension activates on any TypeScript, JavaScript, TSX, or JSX file inside a project that has `ttsc` installed.
+Lint **fixes** stay off-save by default because they can change code meaning. Run `ttsc: Fix all lint issues` from the command palette, or opt in with `"editor.codeActionsOnSave": { "source.fixAll.ttsc": "explicit" }`.
 
-- **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 format rules come from your project's `lint.config`, so format-on-save does nothing until that config has a `format` block.
 
-The extension's identifier inside VS Code is `samchon.ttsc`.
+## What it adds
 
-## Settings
+- TypeScript-Go diagnostics, hover, navigation, and completions.
+- `@ttsc/lint` lint diagnostics, plus `ttsc: Fix all lint issues` and `ttsc: Format document` in the command palette.
+- Format on save with `@ttsc/lint`'s rules, shown above.
+- Monorepo-aware: each package uses its own `tsconfig` and `lint.config`.
 
-Open VS Code's settings (`Ctrl+,` / `Cmd+,`) and search for `ttsc`, or edit `settings.json` directly:
+## Troubleshooting
 
-| Setting | Default | Effect |
-| --- | --- | --- |
-| `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. |
+No diagnostics? Confirm `ttsc` runs in the project (`npx ttsc --version`), then check **View → Output → ttsc** for the server log. For LSP tracing, set `ttsc.trace.server` to `"verbose"`.
 
-## Troubleshooting
+## Sponsors
 
-If lint underlines don't appear after install:
+[![Sponsors](https://raw.githubusercontent.com/samchon/sponsor-images/refs/heads/master/public/circle.png)](https://github.com/sponsors/samchon)
 
-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.
+Thanks for your support.
 
-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.
+Your [donation](https://github.com/sponsors/samchon) encourages `ttsc` development.

package/bin/install.js

@@ -6,39 +6,105 @@ const path = require("node:path");
 const pkgRoot = path.resolve(__dirname, "..");
 const distDir = path.join(pkgRoot, "dist");
 const extensionId = "samchon.ttsc";
-
-const sub = process.argv[2] ?? "install";
+const version = require(path.join(pkgRoot, "package.json")).version;
 
 function findVsix() {
   if (!fs.existsSync(distDir)) return null;
-  const hits = fs.readdirSync(distDir).filter((f) => f.endsWith(".vsix"));
-  return hits.length ? path.join(distDir, hits[0]) : null;
+  const expected = path.join(distDir, `ttsc-vscode-${version}.vsix`);
+  return fs.existsSync(expected) ? expected : null;
 }
 
-function runCode(args, vsixForFallback) {
-  const r = cp.spawnSync("code", args, { stdio: "inherit" });
+function createCodeCommand(
+  args,
+  platform = process.platform,
+  env = process.env,
+) {
+  if (platform === "win32") {
+    return {
+      command: env.ComSpec || "cmd.exe",
+      args: ["/d", "/s", "/c", quoteWindowsCommand(["code", ...args])],
+    };
+  }
+  return { command: "code", args };
+}
+
+function quoteWindowsCommand(args) {
+  return `"${args.map(quoteWindowsArg).join(" ")}"`;
+}
+
+function quoteWindowsArg(arg) {
+  return `"${String(arg).replace(/"/g, '\\"').replace(/%/g, "%%")}"`;
+}
+
+function spawnCode(args, vsixForFallback) {
+  const command = createCodeCommand(args);
+  const r = cp.spawnSync(command.command, command.args, { stdio: "inherit" });
   if (r.error && r.error.code === "ENOENT") {
-    console.error("`code` CLI not found on PATH.");
-    console.error("Either:");
-    console.error("  - Open VSCode, then run \"Shell Command: Install 'code' command in PATH\" from the command palette.");
-    if (vsixForFallback) {
-      console.error(`  - Or install manually: VSCode > Extensions > \"...\" menu > Install from VSIX > ${vsixForFallback}`);
-    }
+    printCodeNotFound(vsixForFallback);
     process.exit(1);
   }
-  process.exit(r.status ?? 1);
+  return r.status ?? 1;
+}
+
+function runCode(args, vsixForFallback) {
+  const status = spawnCode(args, vsixForFallback);
+  if (process.platform === "win32" && status !== 0) {
+    printCodeFailed(status, vsixForFallback);
+  }
+  process.exit(status);
+}
+
+function printCodeNotFound(vsixForFallback) {
+  console.error("`code` CLI not found on PATH.");
+  console.error("Either:");
+  console.error(
+    "  - Open VS Code, then run \"Shell Command: Install 'code' command in PATH\" from the command palette.",
+  );
+  if (vsixForFallback) {
+    console.error(
+      `  - Or install manually: VS Code > Extensions > \"...\" menu > Install from VSIX > ${vsixForFallback}`,
+    );
+  }
+}
+
+function printCodeFailed(status, vsixForFallback) {
+  console.error(`VS Code CLI exited with status ${status}.`);
+  if (vsixForFallback) {
+    console.error(
+      `Install manually: VS Code > Extensions > "..." menu > Install from VSIX > ${vsixForFallback}`,
+    );
+  }
 }
 
-if (sub === "install") {
-  const vsix = findVsix();
-  if (!vsix) {
-    console.error(`No .vsix bundled in ${distDir}. Reinstall @ttsc/vscode or report a packaging bug.`);
+function main(argv = process.argv.slice(2)) {
+  const sub = argv[0] ?? "install";
+  if (sub === "install") {
+    const vsix = findVsix();
+    if (!vsix) {
+      console.error(
+        `No .vsix bundled in ${distDir}. Reinstall @ttsc/vscode or report a packaging bug.`,
+      );
+      process.exit(1);
+    }
+    // Remove any previously installed version first so versions do not pile up
+    // in VS Code. Ignore its exit status: the extension may not be installed.
+    spawnCode(["--uninstall-extension", extensionId], vsix);
+    runCode(["--install-extension", vsix, "--force"], vsix);
+  } else if (sub === "uninstall") {
+    runCode(["--uninstall-extension", extensionId]);
+  } else {
+    console.error(`Usage: npx @ttsc/vscode <install|uninstall>`);
     process.exit(1);
   }
-  runCode(["--install-extension", vsix, "--force"], vsix);
-} else if (sub === "uninstall") {
-  runCode(["--uninstall-extension", extensionId]);
-} else {
-  console.error(`Usage: ttsc-vscode <install|uninstall>`);
-  process.exit(1);
 }
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = {
+  createCodeCommand,
+  findVsix,
+  main,
+  quoteWindowsCommand,
+};