tsref is a Bun CLI for finding references to exported TypeScript APIs.
init
Rui Duarte
(May 25, 2026, 11:24 AM +0100)
a8f42d29
+223
+34
.gitignore
+34
.gitignore
···
1
+
# dependencies (bun install)
2
+
node_modules
3
+
4
+
# output
5
+
out
6
+
dist
7
+
*.tgz
8
+
9
+
# code coverage
10
+
coverage
11
+
*.lcov
12
+
13
+
# logs
14
+
logs
15
+
_.log
16
+
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
17
+
18
+
# dotenv environment variable files
19
+
.env
20
+
.env.development.local
21
+
.env.test.local
22
+
.env.production.local
23
+
.env.local
24
+
25
+
# caches
26
+
.eslintcache
27
+
.cache
28
+
*.tsbuildinfo
29
+
30
+
# IntelliJ based IDEs
31
+
.idea
32
+
33
+
# Finder (MacOS) folder config
34
+
.DS_Store
+106
CLAUDE.md
+106
CLAUDE.md
···
1
+
2
+
Default to using Bun instead of Node.js.
3
+
4
+
- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
5
+
- Use `bun test` instead of `jest` or `vitest`
6
+
- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
7
+
- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
8
+
- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
9
+
- Use `bunx <package> <command>` instead of `npx <package> <command>`
10
+
- Bun automatically loads .env, so don't use dotenv.
11
+
12
+
## APIs
13
+
14
+
- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
15
+
- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
16
+
- `Bun.redis` for Redis. Don't use `ioredis`.
17
+
- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
18
+
- `WebSocket` is built-in. Don't use `ws`.
19
+
- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
20
+
- Bun.$`ls` instead of execa.
21
+
22
+
## Testing
23
+
24
+
Use `bun test` to run tests.
25
+
26
+
```ts#index.test.ts
27
+
import { test, expect } from "bun:test";
28
+
29
+
test("hello world", () => {
30
+
expect(1).toBe(1);
31
+
});
32
+
```
33
+
34
+
## Frontend
35
+
36
+
Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
37
+
38
+
Server:
39
+
40
+
```ts#index.ts
41
+
import index from "./index.html"
42
+
43
+
Bun.serve({
44
+
routes: {
45
+
"/": index,
46
+
"/api/users/:id": {
47
+
GET: (req) => {
48
+
return new Response(JSON.stringify({ id: req.params.id }));
49
+
},
50
+
},
51
+
},
52
+
// optional websocket support
53
+
websocket: {
54
+
open: (ws) => {
55
+
ws.send("Hello, world!");
56
+
},
57
+
message: (ws, message) => {
58
+
ws.send(message);
59
+
},
60
+
close: (ws) => {
61
+
// handle close
62
+
}
63
+
},
64
+
development: {
65
+
hmr: true,
66
+
console: true,
67
+
}
68
+
})
69
+
```
70
+
71
+
HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
72
+
73
+
```html#index.html
74
+
<html>
75
+
<body>
76
+
<h1>Hello, world!</h1>
77
+
<script type="module" src="./frontend.tsx"></script>
78
+
</body>
79
+
</html>
80
+
```
81
+
82
+
With the following `frontend.tsx`:
83
+
84
+
```tsx#frontend.tsx
85
+
import React from "react";
86
+
import { createRoot } from "react-dom/client";
87
+
88
+
// import .css files directly and it works
89
+
import './index.css';
90
+
91
+
const root = createRoot(document.body);
92
+
93
+
export default function Frontend() {
94
+
return <h1>Hello, world!</h1>;
95
+
}
96
+
97
+
root.render(<Frontend />);
98
+
```
99
+
100
+
Then, run index.ts
101
+
102
+
```sh
103
+
bun --hot ./index.ts
104
+
```
105
+
106
+
For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.
+15
README.md
+15
README.md
+26
bun.lock
+26
bun.lock
···
1
+
{
2
+
"lockfileVersion": 1,
3
+
"configVersion": 1,
4
+
"workspaces": {
5
+
"": {
6
+
"name": "tsref",
7
+
"devDependencies": {
8
+
"@types/bun": "latest",
9
+
},
10
+
"peerDependencies": {
11
+
"typescript": "^5",
12
+
},
13
+
},
14
+
},
15
+
"packages": {
16
+
"@types/bun": ["@types/bun@1.3.14", "", { "dependencies": { "bun-types": "1.3.14" } }, "sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw=="],
17
+
18
+
"@types/node": ["@types/node@25.9.1", "", { "dependencies": { "undici-types": ">=7.24.0 <7.24.7" } }, "sha512-xfrlY7UD5rMJk3ZVJP8BNzS28J36YJg+xp+LPXV1TdWxr8uMH5A860QNxYDGQe/ylDSgjxE52Q9VnO7p75tJxg=="],
19
+
20
+
"bun-types": ["bun-types@1.3.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-4N0ig0fEomHt5R0KCFWjovxow98rIoRwKolrYdCcknNwMekCXRnWEUvgu5soYV8QXtVsrUD8B95MBOZGPvr6KQ=="],
21
+
22
+
"typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
23
+
24
+
"undici-types": ["undici-types@7.24.6", "", {}, "sha512-WRNW+sJgj5OBN4/0JpHFqtqzhpbnV0GuB+OozA9gCL7a993SmU+1JBZCzLNxYsbMfIeDL+lTsphD5jN5N+n0zg=="],
25
+
}
26
+
}
+1
index.ts
+1
index.ts
···
1
+
console.log("Hello via Bun!");
+12
package.json
+12
package.json
+29
tsconfig.json
+29
tsconfig.json
···
1
+
{
2
+
"compilerOptions": {
3
+
// Environment setup & latest features
4
+
"lib": ["ESNext"],
5
+
"target": "ESNext",
6
+
"module": "Preserve",
7
+
"moduleDetection": "force",
8
+
"jsx": "react-jsx",
9
+
"allowJs": true,
10
+
11
+
// Bundler mode
12
+
"moduleResolution": "bundler",
13
+
"allowImportingTsExtensions": true,
14
+
"verbatimModuleSyntax": true,
15
+
"noEmit": true,
16
+
17
+
// Best practices
18
+
"strict": true,
19
+
"skipLibCheck": true,
20
+
"noFallthroughCasesInSwitch": true,
21
+
"noUncheckedIndexedAccess": true,
22
+
"noImplicitOverride": true,
23
+
24
+
// Some stricter flags (disabled by default)
25
+
"noUnusedLocals": false,
26
+
"noUnusedParameters": false,
27
+
"noPropertyAccessFromIndexSignature": false
28
+
}
29
+
}