@tspub-dev/tspub 0.1.1 → 0.1.3

package/README.md

@@ -1,359 +1,94 @@
 <div align="center">
 
-<br>
-
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="docs/terminal.svg">
   <source media="(prefers-color-scheme: light)" srcset="docs/terminal.svg">
   <img alt="tspub terminal demo" src="docs/terminal.svg" width="600">
 </picture>
 
-<br>
-<br>
-
 # tspub
 
-**Stop. Publishing. Broken. Packages.**
-
-<br>
+Replaces tsup + publint + attw + changesets. One dependency, 70 lint rules, zero config.
 
 [![npm](https://img.shields.io/npm/v/@tspub-dev/tspub?style=flat-square&color=cc3534)](https://www.npmjs.com/package/@tspub-dev/tspub)
 [![downloads](https://img.shields.io/npm/dm/@tspub-dev/tspub?style=flat-square)](https://www.npmjs.com/package/@tspub-dev/tspub)
 [![tests](https://img.shields.io/github/actions/workflow/status/tspub/tspub/ci.yml?style=flat-square&label=tests)](https://github.com/tspub/tspub/actions)
-[![coverage](https://img.shields.io/badge/coverage-88%25-brightgreen?style=flat-square)](https://github.com/tspub/tspub)
 [![license](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE)
-[![docs](https://img.shields.io/badge/docs-tspub.dev-blueviolet?style=flat-square)](https://tspub.dev)
+
+[Docs](https://tspub.dev) · [Playground](https://tspub.dev/playground) · [npm](https://npmjs.com/package/@tspub-dev/tspub)
 
 </div>
 
-<br>
+## Why
 
-## Install
+Publishing a TypeScript package correctly means juggling tsup, publint, attw, changesets, and a bunch of config files. tspub replaces all of them.
 
-```bash
-npm i -D @tspub-dev/tspub
-```
-
-```bash
-pnpm add -D @tspub-dev/tspub
-```
-
-```bash
-yarn add -D @tspub-dev/tspub
-```
-
-```bash
-bun add -D @tspub-dev/tspub
-```
+| Before | After |
+|:--|:--|
+| tsup + publint + arethetypeswrong + changesets + np | `tspub` |
 
-Or just run directly — no install needed:
+## Install
 
 ```bash
-npx tspub check
-```
-
-<br>
-
----
-
-<br>
-
-<table>
-<tr>
-<td width="60%">
-
-### The scene
-
-It's 6 PM on a Friday. You've just shipped v2.0.0 of your library.
-
-You feel good. You grab your coffee. You check Twitter.
-
-<br>
-
-**@frustrated_dev:** *"Just updated to v2.0.0 and now I'm getting `Cannot use import statement outside a module`. Anyone else?"*
-
-**@another_dev:** *"Same. Also my types aren't working anymore."*
-
-**@your_biggest_user:** *"Is this package abandoned? v2 is completely broken."*
-
-<br>
-
-Your stomach drops.
-
-</td>
-<td width="40%" align="center">
-
-<br>
-
-```
-npm publish
-```
-
-↓
-
-```
-🔥🔥🔥
-```
-
-↓
-
-```
-npm publish (patch)
-npm publish (patch)
-npm publish (patch)
+npm i -D @tspub-dev/tspub
+# or: pnpm add -D @tspub-dev/tspub
+# or: yarn add -D @tspub-dev/tspub
 ```
 
-<br>
-
-</td>
-</tr>
-</table>
-
-<br>
-
----
+Or run directly: `npx tspub check`
 
-<br>
+## What it does
 
-### What if you could know before they do?
+**70 rules** that catch broken exports, bad types, missing files, and metadata issues — before your users do.
 
 ```bash
-npx tspub check
-```
+$ npx tspub check
 
-```
 exports/types-order      "types" should be first in conditions
 exports/file-exists      ./dist/index.js doesn't exist
-types/false-esm          types say ESM, but it's actually CJS
+types/false-cjs-esm      types say ESM, but it's actually CJS
 metadata/license         missing license field
 
 4 problems found (3 auto-fixable)
 ```
 
 ```bash
-npx tspub check --fix
-```
+$ npx tspub check --fix
 
+Fixed 3 problems. 1 requires manual fix (types/false-esm).
 ```
-✓ Fixed 3 problems
-⚠ 1 requires manual fix (types/false-esm)
-
-Your package is ready.
-```
-
-**That's tspub.** One command that catches the 70 ways your package can break.
-
-<br>
-
----
-
-<br>
-
-<div align="center">
-
-## The full picture
-
-</div>
-
-<br>
-
-<table>
-<tr>
-<td align="center" width="33%">
-
-**70 rules**
-
-Covers publint.
-Covers attw.
-Plus our own checks.
-
-</td>
-<td align="center" width="33%">
-
-**Auto-fix**
-
-Most problems are one
-config tweak away.
-We just do it for you.
-
-</td>
-<td align="center" width="33%">
-
-**One tool**
-
-Build. Check. Publish.
-No more 5-tool dance.
-No more glue scripts.
-
-</td>
-</tr>
-</table>
 
-<br>
-
-<div align="center">
-
-| You currently use | Just use |
-|:--|:--|
-| tsup + publint + arethetypeswrong + np + changesets | `tspub` |
-
-</div>
-
-<br>
-
----
-
-<br>
-
-## The commands
-
-<br>
-
-<details open>
-<summary><b>tspub check</b> — Find what's broken</summary>
-
-<br>
-
-```bash
-tspub check                    # find problems
-tspub check --fix              # fix the safe ones
-tspub check --fix --unsafe     # fix everything
-tspub check --list-rules       # see all 70 rules
-```
-
-**What it catches:**
-
-| | |
-|:--|:--|
-| **exports** (28 rules) | Types not first, missing files, ESM/CJS issues, condition ordering |
-| **imports** (6 rules) | Import map validation, resolution checks |
-| **types** (14 rules) | False ESM/CJS, resolution failures across node10/16/bundler |
-| **files** (10 rules) | .env leaked, wrong shebang, format inconsistencies |
-| **metadata** (11 rules) | Missing license, bad engines, deprecated fields |
-| **size** (1 rule) | Package too big |
-
-<br>
-
-</details>
-
-<details>
-<summary><b>tspub build</b> — Bundle it properly</summary>
-
-<br>
+## Commands
 
 ```bash
-tspub build                    # ESM + types
-tspub build --format esm,cjs   # dual
-tspub build --dts-bundle       # single .d.ts file
-tspub build --minify           # production
-tspub build --watch            # dev mode
-```
-
-- Powered by esbuild — tspub builds itself
-- Infers entries from your package.json
-- CJS interop that actually works (no `.default` nonsense)
-- Size budgets — build fails if too big
-
-<br>
-
-</details>
-
-<details>
-<summary><b>tspub publish</b> — Ship with a safety net</summary>
-
-<br>
-
-```bash
-tspub publish patch            # bump + ship
-tspub publish minor --dry-run  # preview first
-tspub publish --prerelease beta
-tspub publish --provenance     # npm attestation
-```
-
-**What happens:**
-
-```
-┌─────────┐   ┌───────┐   ┌───────┐   ┌──────┐   ┌─────────┐
-│ 5 Gates │ → │ Build │ → │ Check │ → │ Bump │ → │ Publish │
-└─────────┘   └───────┘   └───────┘   └──────┘   └─────────┘
-     │                                                 │
-     ↓                                                 ↓
-  STOP if                                        ROLLBACK if
-  not ready                                      npm fails
-```
-
-The 5 gates: clean git, right branch, npm reachable, logged in, check passes.
-
-If npm publish fails → git tag deleted, version reverted. No half-broken releases.
-
-<br>
-
-</details>
-
-<details>
-<summary><b>tspub doctor</b> — Debug the weird stuff</summary>
-
-<br>
-
-```bash
-tspub doctor                   # full scan
-tspub doctor --fix             # fix what's fixable
-```
-
-```
-environment/node-version    ✓ v20.10.0 (matches engines)
-environment/lockfiles       ✗ found package-lock.json AND yarn.lock
-typescript/strict           ✗ strict mode not enabled
-typescript/declaration      ✗ declaration not enabled
-build/output-fresh          ✗ dist/ older than src/
-dependencies/duplicates     ✗ react in deps AND devDeps
-```
-
-<br>
-
-</details>
-
-<details>
-<summary><b>tspub scan</b> — Audit any repo</summary>
-
-<br>
-
-```bash
-tspub scan https://github.com/someone/thing
-tspub scan --top 20            # top 20 TS repos on GitHub
-tspub scan --top 50 --concurrency 5
-```
-
-Great for auditing your dependencies before you `npm install` them.
-
-<br>
-
-</details>
-
-<details>
-<summary><b>tspub init</b> — Start fresh</summary>
-
-<br>
-
-```bash
-tspub init my-package
-tspub init my-package --cjs    # include CommonJS
-tspub init my-package --react  # React + JSX
-```
-
-<br>
-
-</details>
-
-<br>
-
----
-
-<br>
+tspub check                    # lint your package (70 rules)
+tspub check --fix              # auto-fix what's safe
+tspub build                    # bundle with esbuild (ESM + types)
+tspub build --format esm,cjs   # dual format
+tspub publish patch            # bump, build, check, publish
+tspub doctor                   # diagnose tsconfig/env issues
+tspub doctor --fix             # auto-repair
+tspub scan user/repo           # audit any GitHub repo
+tspub init my-package          # scaffold a new package
+tspub changeset add            # add a changeset for versioning
+```
+
+## Rules
+
+| Category | Count | Examples |
+|:--|:--|:--|
+| exports | 28 | types-first, file-exists, format-mismatch, ESM/CJS conditions |
+| types | 14 | false-cjs-esm, resolution failures, missing declarations |
+| metadata | 11 | license, engines, deprecated fields, repository format |
+| files | 10 | sensitive files leaked, wrong shebang, format validation |
+| imports | 6 | import map validation, resolution checks |
+| size | 1 | package size budget |
+
+Covers everything publint and attw check, plus more.
 
 ## Config
 
-Zero config works. But if you want control:
+Zero config by default. Customize if needed:
 
 ```ts
 // tspub.config.ts
@@ -361,147 +96,37 @@ export default {
   build: {
     formats: ["esm", "cjs"],
     entry: "src/index.ts",
-    sizeLimits: { "dist/index.js": "50kb" },
   },
   check: {
     severityOverrides: {
-      "exports/types-order": "off",  // don't care about this one
+      "exports/types-order": "off",
     },
   },
-  publish: {
-    access: "public",
-    branch: ["main"],
-  },
 };
 ```
 
-<br>
-
----
-
-<br>
-
-## Plugins
-
-Make your own rules:
-
-```js
-export const rules = [{
-  meta: { id: "custom/no-barrel-files", fixable: false },
-  check(ctx) {
-    // your logic here
-  },
-}];
-```
-
-```ts
-// tspub.config.ts
-export default {
-  check: { plugins: ["./my-rules.js"] },
-};
-```
-
-<br>
-
----
-
-<br>
-
 ## Monorepos
 
-It just works.
+Works with pnpm, yarn, and npm workspaces.
 
 ```bash
 tspub build --filter "@myorg/*"
 tspub check --filter "packages/core"
-tspub publish --filter "!docs"   # everything except docs
 ```
 
-pnpm, yarn, npm workspaces — all supported.
-
-<br>
-
----
-
-<br>
-
 ## API
 
 ```ts
-import { check, build, doctor, scan } from "tspub";
+import { check, build, doctor, scan } from "@tspub-dev/tspub";
 
-await check({ dir: ".", fix: true });
+const results = await check({ dir: ".", fix: true });
 await build({ formats: ["esm", "cjs"] });
-await doctor({ dir: "." });
-await scan({ url: "https://github.com/user/repo" });
 ```
 
-<br>
-
----
-
-<br>
-
-## FAQ
-
-<details>
-<summary><b>How is this different from publint?</b></summary>
-
-publint has 40 rules focused on exports and file formats. tspub has 70 rules covering exports, imports, types, files, metadata, and size. We check everything publint checks, plus type resolution (like attw), plus tsconfig validation, size budgets, and more. And we can auto-fix.
-
-</details>
-
-<details>
-<summary><b>How is this different from arethetypeswrong?</b></summary>
-
-attw only checks types. We check types + exports + files + metadata + size. And we can auto-fix.
-
-</details>
-
-<details>
-<summary><b>Does this replace tsup/unbuild?</b></summary>
-
-Yes. `tspub build` handles ESM, CJS, IIFE, DTS bundling, sourcemaps, minification, and watch mode.
-
-</details>
-
-<details>
-<summary><b>Does this work with monorepos?</b></summary>
-
-Yes. All commands accept `--filter` and process packages in topological order.
-
-</details>
-
-<br>
-
----
-
-<br>
-
 ## Requirements
 
-Node 18+ · TypeScript 5+ recommended
+Node 20+, TypeScript 5+ recommended.
 
-<br>
-
----
-
-<br>
-
-<div align="center">
-
-Made for the mass-publishers. The Friday deployers. The "it worked on my machine" crowd.
-
-We've all been there. Now we don't have to go back.
-
-<br>
-
-[Docs](https://tspub.dev) · [Playground](https://tspub.dev/playground) · [GitHub](https://github.com/tspub/tspub) · [Issues](https://github.com/tspub/tspub/issues) · [npm](https://npmjs.com/package/@tspub-dev/tspub)
-
-<br>
-
-<sub>If this saved your Friday, consider a ⭐</sub>
-
-</div>
+## License
 
-<br>
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tspub-dev/tspub",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "The unified TypeScript package toolkit — init, build, check, publish in one tool. tspub builds itself.",
   "type": "module",
   "bin": {
@@ -22,27 +22,11 @@
   },
   "files": [
     "dist",
-    "!dist/**/*.map"
+    "!dist/**/*.map",
+    "!dist/**/*.d.cts",
+    "!dist/src",
+    "!dist/tsconfig.tsbuildinfo"
   ],
-  "scripts": {
-    "build": "test -f dist/bin/tspub.js || node scripts/bootstrap.js && node dist/bin/tspub.js build",
-    "dev": "node dist/bin/tspub.js build --watch",
-    "bootstrap": "node scripts/bootstrap.js",
-    "test": "vitest",
-    "test:run": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "test:ecosystem": "vitest run --config vitest.ecosystem.config.ts",
-    "lint": "oxlint src/ bin/ test/",
-    "typecheck": "tsc --noEmit",
-    "check": "node ./dist/bin/tspub.js check",
-    "prepublishOnly": "npm run build && npm run check",
-    "release:patch": "npm version patch && git push --follow-tags",
-    "release:minor": "npm version minor && git push --follow-tags",
-    "release:major": "npm version major && git push --follow-tags",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
-  },
   "keywords": [
     "typescript",
     "publish",
@@ -79,12 +63,31 @@
     "@vercel/og": "^0.6.0",
     "@vitest/coverage-v8": "^3.2.4",
     "fflate": "^0.8.2",
+    "lefthook": "^2.1.1",
     "oxlint": "^1.16.0",
     "typescript": "^5.7.0",
     "vitepress": "^1.6.4",
     "vitest": "^3.0.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "test -f dist/bin/tspub.js || node scripts/bootstrap.js && node dist/bin/tspub.js build",
+    "dev": "node dist/bin/tspub.js build --watch",
+    "bootstrap": "node scripts/bootstrap.js",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:ecosystem": "vitest run --config vitest.ecosystem.config.ts",
+    "lint": "oxlint src/ bin/ test/",
+    "typecheck": "tsc --noEmit",
+    "check": "node ./dist/bin/tspub.js check",
+    "release:patch": "pnpm version patch && git push --follow-tags",
+    "release:minor": "pnpm version minor && git push --follow-tags",
+    "release:major": "pnpm version major && git push --follow-tags",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   }
-}
+}

package/dist/bin/tspub.d.cts

@@ -1,4 +0,0 @@
-// Auto-generated CJS declaration from tspub.d.ts
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=tspub.d.ts.map