lintcn 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+## 0.4.0
+
+1. **Simpler rule imports** — rules now import from `pkg/rule`, `pkg/utils`, etc. instead of `internal/rule`. The `internal/` child-module-path hack is gone. Your `.go` files use clean import paths:
+   ```go
+   import (
+       "github.com/typescript-eslint/tsgolint/pkg/rule"
+       "github.com/typescript-eslint/tsgolint/pkg/utils"
+   )
+   ```
+
+2. **Simpler codegen** — uses a tsgolint fork with `pkg/runner.Run()`, eliminating all regex surgery on main.go. The generated binary entry point is a 15-line template instead of a patched copy of tsgolint's main.go.
+
+## 0.3.0
+
+1. **Only custom rules run by default** — previously the binary included all 44 built-in tsgolint rules, producing thousands of noisy errors. Now only your `.lintcn/` rules run. True shadcn model: explicitly add each rule you want.
+
+   Before (0.2.0): `Found 2315 errors (linted 193 files with 45 rules)`
+   After (0.3.0): `Found 8 errors (linted 193 files with 1 rule)`
+
+2. **Run `lintcn lint` from any subdirectory** — uses `find-up` to walk parent directories for `.lintcn/`. You no longer need to be at the project root:
+   ```bash
+   cd packages/my-app
+   lintcn lint   # finds .lintcn/ in parent
+   ```
+
+3. **No git required** — tsgolint source is now downloaded as a tarball from GitHub instead of cloned. Patches applied with `patch -p1`. Faster first setup, works without git installed.
+
+4. **Fixed stale binary cache** — added `CACHE_SCHEMA_VERSION` to the content hash. Upgrading lintcn now correctly invalidates cached binaries built by older versions.
+
+5. **Fixed partial download corruption** — if the tsgolint download fails midway, the partial directory is cleaned up so the next run starts fresh instead of failing repeatedly.
+
+6. **Fixed GitHub URLs with `/` in branch names** — `lintcn add` now correctly handles branch names like `feature/my-branch` in GitHub blob URLs.
+
 ## 0.2.0
 
 1. **Pinned tsgolint version** — each lintcn release bundles a specific tsgolint version (`v0.9.2`). Builds are now reproducible: everyone on the same lintcn version compiles against the same tsgolint API. Previously used `main` branch which was non-deterministic.

package/dist/cache.d.ts

@@ -1,4 +1,4 @@
-export declare const DEFAULT_TSGOLINT_VERSION = "v0.9.2";
+export declare const DEFAULT_TSGOLINT_VERSION = "a93604379da2631b70332a65bc47eb5ced689a3b";
 export declare function getCacheDir(): string;
 export declare function getTsgolintSourceDir(version: string): string;
 export declare function getBinDir(): string;

package/dist/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,wBAAwB,WAAW,CAAA;AAEhD,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAED,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA2D3E;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAQ/D"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,wBAAwB,6CAA6C,CAAA;AAQlF,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAqCD,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA2D3E;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAQ/D"}

package/dist/cache.js

@@ -1,16 +1,24 @@
-// Manage cached tsgolint source clone and compiled binaries.
-// Cache lives in ~/.cache/lintcn/ with structure:
-//   tsgolint/<version>/   — cloned tsgolint source (read-only)
-//   bin/<content-hash>    — compiled binaries
+// Manage cached tsgolint source and compiled binaries.
+// Downloads tsgolint fork + typescript-go as tarballs from GitHub,
+// applies tsgolint's patches to typescript-go, and copies collections.
+//
+// Cache layout:
+//   ~/.cache/lintcn/tsgolint/<version>/   — extracted source (read-only)
+//   ~/.cache/lintcn/bin/<content-hash>    — compiled binaries
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
+import { pipeline } from 'node:stream/promises';
 import { execAsync } from "./exec.js";
-// Pinned tsgolint version — updated with each lintcn release.
-// This ensures reproducible builds: every user on the same lintcn version
-// compiles rules against the same tsgolint API. Changing this is a conscious
-// decision — tsgolint API changes can break user rules.
-export const DEFAULT_TSGOLINT_VERSION = 'v0.9.2';
+// Pinned tsgolint fork commit — updated with each lintcn release.
+// Uses remorses/tsgolint fork which exposes pkg/runner.Run() and
+// moves internal/ packages to pkg/ for clean external imports.
+export const DEFAULT_TSGOLINT_VERSION = 'a93604379da2631b70332a65bc47eb5ced689a3b';
+// Pinned typescript-go base commit from microsoft/typescript-go (before patches).
+// Patches from tsgolint/patches/ are applied on top during setup.
+// This is the upstream commit the tsgolint submodule was forked from.
+// Must be updated when DEFAULT_TSGOLINT_VERSION changes.
+const TYPESCRIPT_GO_COMMIT = '1b7eabe122e1575a0df9c77eccdf4e063c623224';
 export function getCacheDir() {
     return path.join(os.homedir(), '.cache', 'lintcn');
 }
@@ -26,54 +34,85 @@ export function getBinaryPath(contentHash) {
 export function getBuildDir() {
     return path.join(getCacheDir(), 'build');
 }
+/** Download a tarball from URL and extract it to targetDir.
+ *  GitHub tarballs have a top-level directory like `repo-ref/`,
+ *  so we strip the first path component during extraction. */
+async function downloadAndExtract(url, targetDir) {
+    const response = await fetch(url);
+    if (!response.ok || !response.body) {
+        throw new Error(`Failed to download ${url}: ${response.status} ${response.statusText}`);
+    }
+    fs.mkdirSync(targetDir, { recursive: true });
+    const tmpTarGz = path.join(os.tmpdir(), `lintcn-${Date.now()}.tar.gz`);
+    const fileStream = fs.createWriteStream(tmpTarGz);
+    // @ts-ignore ReadableStream vs NodeJS.ReadableStream mismatch
+    await pipeline(response.body, fileStream);
+    await execAsync('tar', ['xzf', tmpTarGz, '--strip-components=1', '-C', targetDir]);
+    fs.rmSync(tmpTarGz, { force: true });
+}
+/** Apply git-format patches using `patch -p1` (no git required).
+ *  Patches are standard unified diff format, `patch` ignores the git metadata. */
+async function applyPatches(patchesDir, targetDir) {
+    const patches = fs.readdirSync(patchesDir)
+        .filter((f) => { return f.endsWith('.patch'); })
+        .sort();
+    for (const patchFile of patches) {
+        const patchPath = path.join(patchesDir, patchFile);
+        await execAsync('patch', ['-p1', '--batch', '-i', patchPath], { cwd: targetDir });
+    }
+    return patches.length;
+}
 export async function ensureTsgolintSource(version) {
     const sourceDir = getTsgolintSourceDir(version);
     const readyMarker = path.join(sourceDir, '.lintcn-ready');
     if (fs.existsSync(readyMarker)) {
         return sourceDir;
     }
-    console.log(`Cloning tsgolint@${version}...`);
-    fs.mkdirSync(sourceDir, { recursive: true });
-    // clone with depth 1 for speed — --branch works with tags and branches
-    const cloneArgs = [
-        'clone', '--depth', '1',
-        '--branch', version,
-        '--recurse-submodules', '--shallow-submodules',
-        'https://github.com/oxc-project/tsgolint.git', sourceDir,
-    ];
-    await execAsync('git', cloneArgs);
-    // apply patches if they exist
-    const patchesDir = path.join(sourceDir, 'patches');
-    if (fs.existsSync(patchesDir)) {
-        const patches = fs.readdirSync(patchesDir).filter((f) => {
-            return f.endsWith('.patch');
-        }).sort();
-        if (patches.length > 0) {
-            console.log(`Applying ${patches.length} patches...`);
-            const patchPaths = patches.map((p) => {
-                return path.join('..', 'patches', p);
-            });
-            await execAsync('git', ['am', '--3way', '--no-gpg-sign', ...patchPaths], {
-                cwd: path.join(sourceDir, 'typescript-go'),
+    // clean up any partial previous attempt so we start fresh
+    if (fs.existsSync(sourceDir)) {
+        fs.rmSync(sourceDir, { recursive: true });
+    }
+    try {
+        // download tsgolint fork tarball
+        console.log(`Downloading tsgolint@${version.slice(0, 8)}...`);
+        const tsgolintUrl = `https://github.com/remorses/tsgolint/archive/${version}.tar.gz`;
+        await downloadAndExtract(tsgolintUrl, sourceDir);
+        // download typescript-go from microsoft (base commit before patches)
+        const tsGoDir = path.join(sourceDir, 'typescript-go');
+        console.log('Downloading typescript-go...');
+        const tsGoUrl = `https://github.com/microsoft/typescript-go/archive/${TYPESCRIPT_GO_COMMIT}.tar.gz`;
+        await downloadAndExtract(tsGoUrl, tsGoDir);
+        // apply tsgolint's patches to typescript-go
+        const patchesDir = path.join(sourceDir, 'patches');
+        if (fs.existsSync(patchesDir)) {
+            const count = await applyPatches(patchesDir, tsGoDir);
+            if (count > 0) {
+                console.log(`Applied ${count} patches`);
+            }
+        }
+        // copy internal/collections from typescript-go (required by tsgolint, done by `just init`)
+        const collectionsDir = path.join(sourceDir, 'internal', 'collections');
+        const tsGoCollections = path.join(tsGoDir, 'internal', 'collections');
+        if (fs.existsSync(tsGoCollections)) {
+            fs.mkdirSync(collectionsDir, { recursive: true });
+            const files = fs.readdirSync(tsGoCollections).filter((f) => {
+                return f.endsWith('.go') && !f.endsWith('_test.go');
             });
+            for (const file of files) {
+                fs.copyFileSync(path.join(tsGoCollections, file), path.join(collectionsDir, file));
+            }
         }
+        // write ready marker
+        fs.writeFileSync(readyMarker, new Date().toISOString());
+        console.log('tsgolint source ready');
     }
-    // copy internal/collections from typescript-go (required by tsgolint, done by `just init`)
-    const collectionsDir = path.join(sourceDir, 'internal', 'collections');
-    const tsGoCollections = path.join(sourceDir, 'typescript-go', 'internal', 'collections');
-    if (!fs.existsSync(collectionsDir) && fs.existsSync(tsGoCollections)) {
-        fs.mkdirSync(collectionsDir, { recursive: true });
-        const files = fs.readdirSync(tsGoCollections).filter((f) => {
-            return f.endsWith('.go') && !f.endsWith('_test.go');
-        });
-        for (const file of files) {
-            fs.copyFileSync(path.join(tsGoCollections, file), path.join(collectionsDir, file));
+    catch (err) {
+        // clean up partial download so next run starts fresh
+        if (fs.existsSync(sourceDir)) {
+            fs.rmSync(sourceDir, { recursive: true });
         }
-        console.log(`Copied ${files.length} collection files`);
+        throw err;
     }
-    // write ready marker
-    fs.writeFileSync(readyMarker, new Date().toISOString());
-    console.log('tsgolint source ready');
     return sourceDir;
 }
 export function cachedBinaryExists(contentHash) {

package/dist/codegen.d.ts

@@ -1,14 +1,9 @@
 import type { RuleMetadata } from './discover.ts';
-/** Generate .lintcn/go.work and .lintcn/go.mod for editor/gopls support.
- *
- *  Key learnings from testing:
- *  - Module name MUST be a child path of github.com/typescript-eslint/tsgolint
- *    so Go allows importing internal/ packages across the module boundary.
- *  - go.work must `use` both .tsgolint AND .tsgolint/typescript-go since
- *    tsgolint's own go.work (which does this) is ignored by the outer workspace.
- *  - go.mod should be minimal (no requires) — the workspace resolves everything. */
+/** Generate .lintcn/go.work and .lintcn/go.mod for editor/gopls support. */
 export declare function generateEditorGoFiles(lintcnDir: string): void;
-/** Generate build workspace in cache dir for compiling the custom binary */
+/** Generate build workspace for compiling the custom binary.
+ *  With pkg/runner.Run(), the generated main.go is a static template —
+ *  no regex surgery or file copying needed. */
 export declare function generateBuildWorkspace({ buildDir, tsgolintDir, lintcnDir, rules, }: {
     buildDir: string;
     tsgolintDir: string;

package/dist/codegen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../src/codegen.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAiGjD;;;;;;;oFAOoF;AACpF,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAiC7D;AAED,4EAA4E;AAC5E,wBAAgB,sBAAsB,CAAC,EACrC,QAAQ,EACR,WAAW,EACX,SAAS,EACT,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB,GAAG,IAAI,CAgDP"}
+{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../src/codegen.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AA2BjD,4EAA4E;AAC5E,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAkC7D;AAED;;+CAE+C;AAC/C,wBAAgB,sBAAsB,CAAC,EACrC,QAAQ,EACR,WAAW,EACX,SAAS,EACT,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB,GAAG,IAAI,CA2CP"}