yeuimu
6c61a4e871
- Debian-based api image (bookworm-slim), docker/debian mirrors, prisma binaryTargets for openssl 3.0 - nginx: admin SPA under /admin, TLS via acme.sh (ZeroSSL) + auto-renewal cron, http->https redirect - prisma: add origin_goods.delisted migration, sync missing schema (good_image/tag_font_color/good_tags), fix users.createdAt Timestamptz - api: CORS wildcard reflection, helmet CORP cross-origin, price backfill in persistProductDetail, categoryIcon ancestor fallback, mediaByColor per-color gallery in public goods detail - admin: /admin base path (vite + router) - import-data.mjs: udt_name casting, serial sequence advance fix
145 lines
3.4 KiB
Markdown
145 lines
3.4 KiB
Markdown
# TypeScript Configuration
|
|
|
|
## Library Base Config
|
|
|
|
```json
|
|
{
|
|
"compilerOptions": {
|
|
"target": "ESNext",
|
|
"module": "ESNext",
|
|
"moduleResolution": "Bundler",
|
|
"lib": ["ESNext"],
|
|
"strict": true,
|
|
"strictNullChecks": true,
|
|
"noImplicitOverride": true,
|
|
"noUnusedLocals": true,
|
|
"esModuleInterop": true,
|
|
"skipLibCheck": true,
|
|
"noEmit": true,
|
|
"isolatedDeclarations": true,
|
|
"verbatimModuleSyntax": true
|
|
},
|
|
"include": ["src"],
|
|
"exclude": ["node_modules", "dist"]
|
|
}
|
|
```
|
|
|
|
## Key Options Explained
|
|
|
|
| Option | Value | Why |
|
|
| ---------------------- | ------- | ------------------------------------------------ |
|
|
| `target` | ESNext | Modern output, bundlers downgrade |
|
|
| `module` | ESNext | ESM output |
|
|
| `moduleResolution` | Bundler | Works with modern bundlers, allows no extensions |
|
|
| `strict` | true | Catch errors early |
|
|
| `noEmit` | true | Build tool handles emit |
|
|
| `isolatedDeclarations` | true | Faster DTS generation |
|
|
| `verbatimModuleSyntax` | true | Explicit `import type` required |
|
|
| `skipLibCheck` | true | Faster builds |
|
|
|
|
## Monorepo Config
|
|
|
|
### Root tsconfig.json
|
|
|
|
```json
|
|
{
|
|
"compilerOptions": {
|
|
"composite": true,
|
|
"declaration": true,
|
|
"target": "ESNext",
|
|
"module": "ESNext",
|
|
"moduleResolution": "Bundler",
|
|
"strict": true,
|
|
"verbatimModuleSyntax": true
|
|
}
|
|
}
|
|
```
|
|
|
|
### Package tsconfig.json
|
|
|
|
```json
|
|
{
|
|
"extends": "../../tsconfig.json",
|
|
"compilerOptions": {
|
|
"outDir": "dist",
|
|
"rootDir": "src"
|
|
},
|
|
"include": ["src"],
|
|
"references": [
|
|
{ "path": "../utils" }
|
|
]
|
|
}
|
|
```
|
|
|
|
## Path Aliases
|
|
|
|
For internal imports in monorepos:
|
|
|
|
```json
|
|
{
|
|
"compilerOptions": {
|
|
"paths": {
|
|
"@my-lib/core": ["./packages/core/src"],
|
|
"@my-lib/utils": ["./packages/utils/src"],
|
|
"#internal/*": ["./virtual-shared/*"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Bundler vs Node Resolution
|
|
|
|
**Use `Bundler`** for libraries consumed by bundlers (Vite, webpack, etc.):
|
|
|
|
- Allows importing without extensions
|
|
- Supports `exports` field in package.json
|
|
- Modern, simpler setup
|
|
|
|
**Use `Node16/NodeNext`** for Node.js-only libraries:
|
|
|
|
- Requires explicit extensions (`.js`)
|
|
- Stricter, matches Node.js behavior exactly
|
|
|
|
## Type Declarations
|
|
|
|
Let build tool generate declarations:
|
|
|
|
```typescript
|
|
// tsdown.config.ts
|
|
export default defineConfig({
|
|
dts: true, // Generate .d.ts
|
|
dts: { resolve: ['@antfu/utils'] } // Inline specific types
|
|
})
|
|
```
|
|
|
|
Or with unbuild:
|
|
|
|
```typescript
|
|
// build.config.ts
|
|
export default defineBuildConfig({
|
|
declaration: 'node16', // For Node.js compatibility
|
|
declaration: true, // For bundler resolution
|
|
})
|
|
```
|
|
|
|
## Common Issues
|
|
|
|
### Module not found errors
|
|
|
|
Check `moduleResolution` matches your target:
|
|
|
|
- Bundler: `"Bundler"`
|
|
- Node.js: `"Node16"` or `"NodeNext"`
|
|
|
|
### Type imports not working
|
|
|
|
Enable `verbatimModuleSyntax` and use explicit:
|
|
|
|
```typescript
|
|
import type { Foo } from './types'
|
|
```
|
|
|
|
### Slow type checking
|
|
|
|
Enable `skipLibCheck: true` and `isolatedDeclarations: true`.
|