@coralogix/tsgo-strict 0.0.0 → 0.1.0

package/README.md

@@ -1,3 +1,42 @@
 # @coralogix/tsgo-strict
 
-Placeholder `0.0.0` release that reserves this package name so trusted publishing (OIDC) can be configured. It contains no code. Install a real release (`>=0.1.0`) instead.
+Strict-only TypeScript checking powered by the [`tsgo`](https://www.npmjs.com/package/@typescript/native-preview) native compiler, reading `typescript-strict-plugin`-style config so you can adopt `strict: true` gradually.
+
+Ships a native Rust CLI plus an N-API addon via platform-specific subpackages; no Node runtime work on the hot path.
+
+## Install
+
+```sh
+npm install --save-dev @coralogix/tsgo-strict @typescript/native-preview
+```
+
+The correct native binary and addon for your platform are installed automatically through `optionalDependencies`.
+
+## CLI usage
+
+```sh
+tsgo-strict --project tsconfig.json
+tsgo-strict src/feature   # run strict check only against this subtree
+```
+
+## Programmatic API
+
+```js
+import { run } from '@coralogix/tsgo-strict';
+
+const result = await run({
+  project: 'tsconfig.json',
+  subset: ['src/feature'],
+});
+
+console.log(result.errorCount, result.diagnostics);
+```
+
+Full TypeScript types are shipped with the package.
+
+## Supported platforms
+
+- linux-x64 (gnu, musl)
+- linux-arm64 (gnu)
+- darwin-x64, darwin-arm64
+- win32-x64 (msvc)

package/bin/tsgo-strict

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+'use strict';
+
+// JS launcher shim. Follows the esbuild pattern: on *nix, `install.js` may
+// hard-link the platform-specific native binary over this file during
+// postinstall, turning this path into the native executable (one less
+// Node startup per invocation). On Windows, yarn, or when postinstall is
+// skipped, this shim stays in place and spawns the binary each time.
+
+const fs = require('node:fs');
+const { spawnSync } = require('node:child_process');
+const { resolveBinary } = require('../lib/resolve');
+
+try {
+  const binary = resolveBinary();
+  // GitHub Actions' upload-artifact strips the executable bit, so the
+  // published platform tarball can ship the binary at 0644. Ensure it's
+  // runnable before we spawn it. Best-effort: swallow chmod errors so we
+  // don't mask the real spawn error.
+  try {
+    const st = fs.statSync(binary);
+    if ((st.mode & 0o111) === 0) fs.chmodSync(binary, 0o755);
+  } catch {}
+  const result = spawnSync(binary, process.argv.slice(2), { stdio: 'inherit' });
+  if (result.error) {
+    process.stderr.write(`tsgo-strict: failed to launch native binary: ${result.error.message}\n`);
+    process.exit(2);
+  }
+  process.exit(result.status == null ? 2 : result.status);
+} catch (err) {
+  process.stderr.write(`${err.message}\n`);
+  process.exit(2);
+}

package/index.d.ts

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2026 Coralogix Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Type definitions for `@coralogix/tsgo-strict`.
+//
+// The runtime surface is implemented in `index.js` and backed by a native
+// N-API addon shipped in `@coralogix/tsgo-strict-<triple>` platform subpackages.
+
+export type Category = 'error' | 'warning' | 'message';
+
+export interface RunOptions {
+  /** Path to the project tsconfig, absolute or relative to `cwd`. Defaults to `tsconfig.json`. */
+  project?: string;
+  /** Working directory for binary and tsconfig resolution. Defaults to `process.cwd()`. */
+  cwd?: string;
+  /** Restrict the check to these files or directories. Empty / omitted means the full project. */
+  subset?: string[];
+}
+
+export interface RunDiagnostic {
+  /** Project-relative path, or `undefined` for global diagnostics. */
+  file?: string;
+  /** 1-based line number. */
+  line?: number;
+  /** 1-based column number. */
+  column?: number;
+  /** TypeScript diagnostic code (e.g. `2345`). */
+  code: number;
+  category: Category;
+  message: string;
+}
+
+export interface RunTiming {
+  label: string;
+  durationMs: number;
+}
+
+export interface RunResult {
+  /** Total diagnostic count. */
+  errorCount: number;
+  /** `0` clean, `1` strict errors, `2` internal failure. */
+  exitCode: number;
+  diagnostics: RunDiagnostic[];
+  timings: RunTiming[];
+}
+
+/** Run the strict checker programmatically. Resolves with structured diagnostics and per-phase timings. */
+export function run(options?: RunOptions): Promise<RunResult>;

package/index.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2026 Coralogix Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const { resolveNativeAddon } = require('./lib/resolve');
+
+let cachedAddon = null;
+function loadAddon() {
+  if (cachedAddon) return cachedAddon;
+  const addonPath = resolveNativeAddon();
+  cachedAddon = require(addonPath);
+  return cachedAddon;
+}
+
+async function run(options = {}) {
+  const addon = loadAddon();
+  return addon.run(options);
+}
+
+module.exports = { run };

package/install.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+/*
+ * Copyright 2026 Coralogix Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+// Postinstall optimizer (esbuild-style). The JS shim at `bin/tsgo-strict`
+// always works, but spawning a separate Node process per invocation adds
+// ~30-50ms of startup. On *nix, we hard-link the platform-specific native
+// binary directly over the shim so `node_modules/.bin/tsgo-strict` (which
+// symlinks to this file) resolves to the native ELF/Mach-O directly.
+//
+// This is a pure optimization — if it fails for any reason, the JS shim
+// is preserved and everything still works. On Windows, yarn, or when
+// installed with `--ignore-scripts`, the shim stays in place.
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+function isYarn() {
+  const ua = process.env.npm_config_user_agent;
+  return !!ua && /\byarn\//.test(ua);
+}
+
+function main() {
+  // Windows: keep the JS shim. npm on Windows generates `.cmd`/`.ps1`
+  // wrappers next to the shim — replacing it with a PE executable would
+  // break those wrappers.
+  if (process.platform === 'win32') return;
+  if (isYarn()) return;
+
+  let resolveBinary;
+  try {
+    ({ resolveBinary } = require('./lib/resolve'));
+  } catch {
+    return;
+  }
+
+  let binary;
+  try {
+    binary = resolveBinary();
+  } catch {
+    // Platform not supported, or the optional dep didn't install. The
+    // shim will surface a helpful error the first time it runs.
+    return;
+  }
+
+  if (!fs.existsSync(binary)) return;
+
+  try {
+    const st = fs.statSync(binary);
+    if ((st.mode & 0o111) === 0) fs.chmodSync(binary, 0o755);
+  } catch {}
+
+  const shim = path.join(__dirname, 'bin', 'tsgo-strict');
+  const tmp = path.join(__dirname, 'bin', 'tsgo-strict.tmp');
+  try {
+    try { fs.unlinkSync(tmp); } catch {}
+    fs.linkSync(binary, tmp);
+    fs.renameSync(tmp, shim);
+  } catch {
+    // Cross-device link, read-only fs, whatever — shim stays put.
+    try { fs.unlinkSync(tmp); } catch {}
+  }
+}
+
+main();

package/lib/resolve.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2026 Coralogix Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+// Internal platform-binary + N-API addon resolver. Not part of the public
+// package surface; the bin launcher and `index.js` import from here
+// directly.
+
+const path = require('node:path');
+const { familySync, MUSL } = require('detect-libc');
+
+function pickPackage() {
+  const platform = process.platform;
+  const arch = process.arch;
+  const family = platform === 'linux' ? familySync() : null;
+
+  if (platform === 'linux' && arch === 'x64') {
+    return family === MUSL
+      ? '@coralogix/tsgo-strict-linux-x64-musl'
+      : '@coralogix/tsgo-strict-linux-x64-gnu';
+  }
+  if (platform === 'linux' && arch === 'arm64') {
+    if (family === MUSL) return null;
+    return '@coralogix/tsgo-strict-linux-arm64-gnu';
+  }
+  if (platform === 'darwin' && arch === 'arm64') return '@coralogix/tsgo-strict-darwin-arm64';
+  if (platform === 'win32' && arch === 'x64') return '@coralogix/tsgo-strict-win32-x64-msvc';
+  return null;
+}
+
+function platformPackageJson() {
+  const name = pickPackage();
+  if (!name) {
+    throw new Error(
+      `tsgo-strict: unsupported platform ${process.platform}-${process.arch} (libc family: ${familySync() || 'n/a'})`
+    );
+  }
+  let packagePath;
+  try {
+    packagePath = require.resolve(`${name}/package.json`);
+  } catch {
+    throw new Error(
+      `tsgo-strict: expected platform package '${name}' is not installed. ` +
+        `This usually means 'optionalDependencies' was not installed (check npm/pnpm/yarn install logs).`
+    );
+  }
+  return { name, packagePath, pkg: require(packagePath) };
+}
+
+function resolveBinary() {
+  // Platform packages don't declare `bin` (that would collide with this
+  // launcher's own `bin` entry on hoist). Hard-code the staged path —
+  // it matches what the release workflow writes into
+  // `npm/platforms/<triple>/bin/`.
+  const { packagePath } = platformPackageJson();
+  const relative = process.platform === 'win32' ? 'bin/tsgo-strict.exe' : 'bin/tsgo-strict';
+  return path.resolve(path.dirname(packagePath), relative);
+}
+
+function resolveNativeAddon() {
+  const { pkg, packagePath } = platformPackageJson();
+  const relative = pkg.main || 'native/tsgo-strict.node';
+  return path.resolve(path.dirname(packagePath), relative);
+}
+
+module.exports = { pickPackage, resolveBinary, resolveNativeAddon };

package/package.json

@@ -1,14 +1,58 @@
 {
   "name": "@coralogix/tsgo-strict",
-  "version": "0.0.0",
-  "description": "Placeholder to reserve the package name. The first real release is 0.1.0 or later. Do not install 0.0.0.",
+  "version": "0.1.0",
+  "description": "High-performance strict-only TypeScript checking with tsgo and subset file support",
+  "keywords": [
+    "typescript",
+    "tsgo",
+    "typecheck",
+    "strict",
+    "cli"
+  ],
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/coralogix/tsgo-strict.git"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
+    "access": "public"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "bin": {
+    "tsgo-strict": "bin/tsgo-strict"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "lib",
+    "bin",
+    "install.js",
+    "index.js",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@coralogix/tsgo-strict-linux-x64-gnu": "0.1.0",
+    "@coralogix/tsgo-strict-linux-x64-musl": "0.1.0",
+    "@coralogix/tsgo-strict-linux-arm64-gnu": "0.1.0",
+    "@coralogix/tsgo-strict-darwin-arm64": "0.1.0",
+    "@coralogix/tsgo-strict-win32-x64-msvc": "0.1.0"
+  },
+  "dependencies": {
+    "detect-libc": "^2.0.3"
+  },
+  "peerDependencies": {
+    "@typescript/native-preview": ">=7.0.0-dev"
+  },
+  "peerDependenciesMeta": {
+    "@typescript/native-preview": {
+      "optional": true
+    }
   }
 }