lintcn 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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.
+
+2. **`--tsgolint-version` flag** — override the pinned version for testing unreleased tsgolint:
+   ```bash
+   npx lintcn lint --tsgolint-version v0.10.0
+   ```
+
+3. **Version pinning docs** — README now explains why you should pin lintcn in `package.json` (no `^` or `~`) and how to update safely.
+
 ## 0.1.0
 
 1. **Initial release** — CLI for adding type-aware TypeScript lint rules as Go files to your project:

package/README.md

@@ -127,6 +127,30 @@ if (user instanceof Error) return user
 void getUser("id")
 ```
 
+## Version pinning
+
+**Pin lintcn in your `package.json`** — do not use `^` or `~`:
+
+```json
+{
+  "devDependencies": {
+    "lintcn": "0.1.0"
+  }
+}
+```
+
+Each lintcn release bundles a specific tsgolint version. Updating lintcn can change the underlying tsgolint API, which may cause your rules to no longer compile. Always update consciously:
+
+1. Check the [changelog](./CHANGELOG.md) for tsgolint version changes
+2. Run `npx lintcn build` after updating to verify your rules still compile
+3. Fix any compilation errors before committing
+
+You can test against an unreleased tsgolint version without updating lintcn:
+
+```bash
+npx lintcn lint --tsgolint-version v0.10.0
+```
+
 ## Prerequisites
 
 - **Node.js** — for the CLI

package/dist/cache.d.ts

@@ -1,4 +1,4 @@
-export declare const DEFAULT_TSGOLINT_VERSION = "main";
+export declare const DEFAULT_TSGOLINT_VERSION = "v0.9.2";
 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":"AAWA,eAAO,MAAM,wBAAwB,SAAS,CAAA;AAE9C,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,CA0D3E;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAQ/D"}
+{"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"}

package/dist/cache.js

@@ -6,8 +6,11 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import { execAsync } from "./exec.js";
-// Default tsgolint version — pinned to a known-good commit
-export const DEFAULT_TSGOLINT_VERSION = 'main';
+// 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';
 export function getCacheDir() {
     return path.join(os.homedir(), '.cache', 'lintcn');
 }
@@ -31,12 +34,13 @@ export async function ensureTsgolintSource(version) {
     }
     console.log(`Cloning tsgolint@${version}...`);
     fs.mkdirSync(sourceDir, { recursive: true });
-    // clone with depth 1 for speed
-    const cloneArgs = ['clone', '--depth', '1', '--recurse-submodules', '--shallow-submodules'];
-    if (version !== 'main') {
-        cloneArgs.push('--branch', version);
-    }
-    cloneArgs.push('https://github.com/oxc-project/tsgolint.git', sourceDir);
+    // 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');

package/dist/cli.js

@@ -7,6 +7,7 @@ import { addRule } from "./commands/add.js";
 import { lint, buildBinary } from "./commands/lint.js";
 import { listRules } from "./commands/list.js";
 import { removeRule } from "./commands/remove.js";
+import { DEFAULT_TSGOLINT_VERSION } from "./cache.js";
 const require = createRequire(import.meta.url);
 const packageJson = require('../package.json');
 const cli = goke('lintcn');
@@ -35,7 +36,9 @@ cli
     .option('--rebuild', 'Force rebuild even if cached binary exists')
     .option('--tsconfig <path>', 'Path to tsconfig.json')
     .option('--list-files', 'List matched files')
+    .option('--tsgolint-version [version]', 'Override the pinned tsgolint version (tag or commit). For testing unreleased tsgolint versions.')
     .action(async (options) => {
+    const tsgolintVersion = options.tsgolintVersion || DEFAULT_TSGOLINT_VERSION;
     const passthroughArgs = [];
     if (options.tsconfig) {
         passthroughArgs.push('--tsconfig', options.tsconfig);
@@ -50,6 +53,7 @@ cli
     }
     const exitCode = await lint({
         rebuild: !!options.rebuild,
+        tsgolintVersion,
         passthroughArgs,
     });
     process.exit(exitCode);
@@ -57,8 +61,10 @@ cli
 cli
     .command('build', 'Build the custom tsgolint binary without running it')
     .option('--rebuild', 'Force rebuild even if cached binary exists')
+    .option('--tsgolint-version [version]', 'Override the pinned tsgolint version (tag or commit). For testing unreleased tsgolint versions.')
     .action(async (options) => {
-    const binaryPath = await buildBinary({ rebuild: !!options.rebuild });
+    const tsgolintVersion = options.tsgolintVersion || DEFAULT_TSGOLINT_VERSION;
+    const binaryPath = await buildBinary({ rebuild: !!options.rebuild, tsgolintVersion });
     console.log(binaryPath);
 });
 cli.help();

package/dist/commands/lint.d.ts

@@ -1,8 +1,10 @@
-export declare function buildBinary({ rebuild }: {
+export declare function buildBinary({ rebuild, tsgolintVersion, }: {
     rebuild: boolean;
+    tsgolintVersion: string;
 }): Promise<string>;
-export declare function lint({ rebuild, passthroughArgs, }: {
+export declare function lint({ rebuild, tsgolintVersion, passthroughArgs, }: {
     rebuild: boolean;
+    tsgolintVersion: string;
     passthroughArgs: string[];
 }): Promise<number>;
 //# sourceMappingURL=lint.d.ts.map

package/dist/commands/lint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/commands/lint.ts"],"names":[],"mappings":"AAuBA,wBAAsB,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAoDpF;AAED,wBAAsB,IAAI,CAAC,EACzB,OAAO,EACP,eAAe,GAChB,EAAE;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,EAAE,CAAA;CAC1B,GAAG,OAAO,CAAC,MAAM,CAAC,CAkBlB"}
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/commands/lint.ts"],"names":[],"mappings":"AAuBA,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,eAAe,GAChB,EAAE;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;CACxB,GAAG,OAAO,CAAC,MAAM,CAAC,CAoDlB;AAED,wBAAsB,IAAI,CAAC,EACzB,OAAO,EACP,eAAe,EACf,eAAe,GAChB,EAAE;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,MAAM,EAAE,CAAA;CAC1B,GAAG,OAAO,CAAC,MAAM,CAAC,CAkBlB"}

package/dist/commands/lint.js

@@ -5,7 +5,7 @@ import { spawn } from 'node:child_process';
 import { getLintcnDir } from "../paths.js";
 import { discoverRules } from "../discover.js";
 import { generateBuildWorkspace } from "../codegen.js";
-import { ensureTsgolintSource, DEFAULT_TSGOLINT_VERSION, cachedBinaryExists, getBinaryPath, getBuildDir, getBinDir } from "../cache.js";
+import { ensureTsgolintSource, cachedBinaryExists, getBinaryPath, getBuildDir, getBinDir } from "../cache.js";
 import { computeContentHash } from "../hash.js";
 import { execAsync } from "../exec.js";
 async function checkGoInstalled() {
@@ -17,7 +17,7 @@ async function checkGoInstalled() {
             'Install from https://go.dev/dl/');
     }
 }
-export async function buildBinary({ rebuild }) {
+export async function buildBinary({ rebuild, tsgolintVersion, }) {
     await checkGoInstalled();
     const lintcnDir = getLintcnDir();
     if (!fs.existsSync(lintcnDir)) {
@@ -27,13 +27,13 @@ export async function buildBinary({ rebuild }) {
     if (rules.length === 0) {
         throw new Error('No rules found in .lintcn/. Run `lintcn add <url>` to add rules.');
     }
-    console.log(`Found ${rules.length} custom rule${rules.length === 1 ? '' : 's'}`);
+    console.log(`Found ${rules.length} custom rule${rules.length === 1 ? '' : 's'} (tsgolint ${tsgolintVersion})`);
     // ensure tsgolint source
-    const tsgolintDir = await ensureTsgolintSource(DEFAULT_TSGOLINT_VERSION);
+    const tsgolintDir = await ensureTsgolintSource(tsgolintVersion);
     // compute content hash
     const contentHash = await computeContentHash({
         lintcnDir,
-        tsgolintVersion: DEFAULT_TSGOLINT_VERSION,
+        tsgolintVersion,
     });
     // check cache
     if (!rebuild && cachedBinaryExists(contentHash)) {
@@ -60,8 +60,8 @@ export async function buildBinary({ rebuild }) {
     console.log('Build complete');
     return binaryPath;
 }
-export async function lint({ rebuild, passthroughArgs, }) {
-    const binaryPath = await buildBinary({ rebuild });
+export async function lint({ rebuild, tsgolintVersion, passthroughArgs, }) {
+    const binaryPath = await buildBinary({ rebuild, tsgolintVersion });
     // run the binary with passthrough args, inheriting stdio
     return new Promise((resolve) => {
         const proc = spawn(binaryPath, passthroughArgs, {

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export { addRule } from './commands/add.ts';
 export { lint, buildBinary } from './commands/lint.ts';
 export { listRules } from './commands/list.ts';
 export { removeRule } from './commands/remove.ts';
+export { DEFAULT_TSGOLINT_VERSION } from './cache.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC1E,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC1E,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -3,3 +3,4 @@ export { addRule } from "./commands/add.js";
 export { lint, buildBinary } from "./commands/lint.js";
 export { listRules } from "./commands/list.js";
 export { removeRule } from "./commands/remove.js";
+export { DEFAULT_TSGOLINT_VERSION } from "./cache.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lintcn",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "The shadcn for type-aware TypeScript lint rules. Browse, pick, and copy rules into your project.",
   "bin": "dist/cli.js",

package/src/cache.ts

@@ -8,8 +8,11 @@ import os from 'node:os'
 import path from 'node:path'
 import { execAsync } from './exec.ts'
 
-// Default tsgolint version — pinned to a known-good commit
-export const DEFAULT_TSGOLINT_VERSION = 'main'
+// 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'
 
 export function getCacheDir(): string {
   return path.join(os.homedir(), '.cache', 'lintcn')
@@ -43,12 +46,13 @@ export async function ensureTsgolintSource(version: string): Promise<string> {
 
   fs.mkdirSync(sourceDir, { recursive: true })
 
-  // clone with depth 1 for speed
-  const cloneArgs = ['clone', '--depth', '1', '--recurse-submodules', '--shallow-submodules']
-  if (version !== 'main') {
-    cloneArgs.push('--branch', version)
-  }
-  cloneArgs.push('https://github.com/oxc-project/tsgolint.git', sourceDir)
+  // 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)
 

package/src/cli.ts

@@ -9,6 +9,7 @@ import { addRule } from './commands/add.ts'
 import { lint, buildBinary } from './commands/lint.ts'
 import { listRules } from './commands/list.ts'
 import { removeRule } from './commands/remove.ts'
+import { DEFAULT_TSGOLINT_VERSION } from './cache.ts'
 
 const require = createRequire(import.meta.url)
 const packageJson = require('../package.json') as { version: string }
@@ -43,7 +44,9 @@ cli
   .option('--rebuild', 'Force rebuild even if cached binary exists')
   .option('--tsconfig <path>', 'Path to tsconfig.json')
   .option('--list-files', 'List matched files')
+  .option('--tsgolint-version [version]', 'Override the pinned tsgolint version (tag or commit). For testing unreleased tsgolint versions.')
   .action(async (options) => {
+    const tsgolintVersion = (options.tsgolintVersion as string) || DEFAULT_TSGOLINT_VERSION
     const passthroughArgs: string[] = []
     if (options.tsconfig) {
       passthroughArgs.push('--tsconfig', options.tsconfig as string)
@@ -58,6 +61,7 @@ cli
     }
     const exitCode = await lint({
       rebuild: !!options.rebuild,
+      tsgolintVersion,
       passthroughArgs,
     })
     process.exit(exitCode)
@@ -66,8 +70,10 @@ cli
 cli
   .command('build', 'Build the custom tsgolint binary without running it')
   .option('--rebuild', 'Force rebuild even if cached binary exists')
+  .option('--tsgolint-version [version]', 'Override the pinned tsgolint version (tag or commit). For testing unreleased tsgolint versions.')
   .action(async (options) => {
-    const binaryPath = await buildBinary({ rebuild: !!options.rebuild })
+    const tsgolintVersion = (options.tsgolintVersion as string) || DEFAULT_TSGOLINT_VERSION
+    const binaryPath = await buildBinary({ rebuild: !!options.rebuild, tsgolintVersion })
     console.log(binaryPath)
   })
 

package/src/commands/lint.ts

@@ -21,7 +21,13 @@ async function checkGoInstalled(): Promise<void> {
   }
 }
 
-export async function buildBinary({ rebuild }: { rebuild: boolean }): Promise<string> {
+export async function buildBinary({
+  rebuild,
+  tsgolintVersion,
+}: {
+  rebuild: boolean
+  tsgolintVersion: string
+}): Promise<string> {
   await checkGoInstalled()
 
   const lintcnDir = getLintcnDir()
@@ -34,15 +40,15 @@ export async function buildBinary({ rebuild }: { rebuild: boolean }): Promise<st
     throw new Error('No rules found in .lintcn/. Run `lintcn add <url>` to add rules.')
   }
 
-  console.log(`Found ${rules.length} custom rule${rules.length === 1 ? '' : 's'}`)
+  console.log(`Found ${rules.length} custom rule${rules.length === 1 ? '' : 's'} (tsgolint ${tsgolintVersion})`)
 
   // ensure tsgolint source
-  const tsgolintDir = await ensureTsgolintSource(DEFAULT_TSGOLINT_VERSION)
+  const tsgolintDir = await ensureTsgolintSource(tsgolintVersion)
 
   // compute content hash
   const contentHash = await computeContentHash({
     lintcnDir,
-    tsgolintVersion: DEFAULT_TSGOLINT_VERSION,
+    tsgolintVersion,
   })
 
   // check cache
@@ -77,12 +83,14 @@ export async function buildBinary({ rebuild }: { rebuild: boolean }): Promise<st
 
 export async function lint({
   rebuild,
+  tsgolintVersion,
   passthroughArgs,
 }: {
   rebuild: boolean
+  tsgolintVersion: string
   passthroughArgs: string[]
 }): Promise<number> {
-  const binaryPath = await buildBinary({ rebuild })
+  const binaryPath = await buildBinary({ rebuild, tsgolintVersion })
 
   // run the binary with passthrough args, inheriting stdio
   return new Promise((resolve) => {

package/src/index.ts

@@ -4,3 +4,4 @@ export { addRule } from './commands/add.ts'
 export { lint, buildBinary } from './commands/lint.ts'
 export { listRules } from './commands/list.ts'
 export { removeRule } from './commands/remove.ts'
+export { DEFAULT_TSGOLINT_VERSION } from './cache.ts'