mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-11 00:23:53 +00:00
feat(cli): generate tsconfig.json in prepare command (#822)
Co-authored-by: Daniel Roe <daniel@roe.dev> Co-authored-by: pooya parsa <pyapar@gmail.com>
This commit is contained in:
parent
39f7b83791
commit
31b12d04c0
@ -65,6 +65,18 @@ export default defineNuxtConfig({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Update `tsconfig.json`
|
||||||
|
|
||||||
|
If you are using TypeScript, you can edit your `tsconfig.json` to benefit from autogenerated Nuxt types:
|
||||||
|
|
||||||
|
**tsconfig.json**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
{
|
||||||
|
+ "extends": "./.nuxt/tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
```
|
||||||
|
|
||||||
### Avoid CommonJS syntax
|
### Avoid CommonJS syntax
|
||||||
|
|
||||||
Nuxt 3 natively supports TypeScript and ECMAScript Modules.
|
Nuxt 3 natively supports TypeScript and ECMAScript Modules.
|
||||||
|
3
examples/hello-world/tsconfig.json
Normal file
3
examples/hello-world/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/use-async-data/tsconfig.json
Normal file
3
examples/use-async-data/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/use-fetch/tsconfig.json
Normal file
3
examples/use-fetch/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/use-meta/tsconfig.json
Normal file
3
examples/use-meta/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/use-state/tsconfig.json
Normal file
3
examples/use-state/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/with-components/tsconfig.json
Normal file
3
examples/with-components/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/with-layouts/tsconfig.json
Normal file
3
examples/with-layouts/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/with-pages/tsconfig.json
Normal file
3
examples/with-pages/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
3
examples/with-wasm/tsconfig.json
Normal file
3
examples/with-wasm/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
@ -30,6 +30,7 @@
|
|||||||
"lodash.template": "^4.5.0",
|
"lodash.template": "^4.5.0",
|
||||||
"mlly": "^0.2.6",
|
"mlly": "^0.2.6",
|
||||||
"pathe": "^0.2.0",
|
"pathe": "^0.2.0",
|
||||||
|
"pkg-types": "^0.1.3",
|
||||||
"rc9": "^1.2.0",
|
"rc9": "^1.2.0",
|
||||||
"scule": "^0.2.1",
|
"scule": "^0.2.1",
|
||||||
"semver": "^7.3.5",
|
"semver": "^7.3.5",
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
import type { IncomingMessage, ServerResponse } from 'http'
|
import type { IncomingMessage, ServerResponse } from 'http'
|
||||||
import type { HookCallback } from 'hookable'
|
import type { HookCallback } from 'hookable'
|
||||||
import type { Compiler, Configuration, Stats } from 'webpack'
|
import type { Compiler, Configuration, Stats } from 'webpack'
|
||||||
|
import type { TSConfig } from 'pkg-types'
|
||||||
import type { NuxtConfig, NuxtOptions } from '..'
|
import type { NuxtConfig, NuxtOptions } from '..'
|
||||||
import type { ModuleContainer } from '../module/container'
|
import type { ModuleContainer } from '../module/container'
|
||||||
import type { NuxtTemplate, Nuxt, NuxtApp } from '../types/nuxt'
|
import type { NuxtTemplate, Nuxt, NuxtApp } from '../types/nuxt'
|
||||||
@ -61,7 +62,7 @@ export interface NuxtHooks extends Record<string, HookCallback> {
|
|||||||
'run:before': (options: { argv: string[], cmd: { name: string, usage: string, description: string, options: Record<string, any> }, rootDir: string }) => HookResult
|
'run:before': (options: { argv: string[], cmd: { name: string, usage: string, description: string, options: Record<string, any> }, rootDir: string }) => HookResult
|
||||||
|
|
||||||
// nuxi
|
// nuxi
|
||||||
'prepare:types': (options: { references: TSReference[], declarations: string[] }) => HookResult
|
'prepare:types': (options: { references: TSReference[], declarations: string[], tsConfig: TSConfig }) => HookResult
|
||||||
|
|
||||||
// @nuxt/core
|
// @nuxt/core
|
||||||
'ready': (nuxt: Nuxt) => HookResult
|
'ready': (nuxt: Nuxt) => HookResult
|
||||||
|
@ -42,6 +42,7 @@
|
|||||||
"mri": "^1.2.0",
|
"mri": "^1.2.0",
|
||||||
"p-debounce": "^4.0.0",
|
"p-debounce": "^4.0.0",
|
||||||
"pathe": "^0.2.0",
|
"pathe": "^0.2.0",
|
||||||
|
"pkg-types": "^0.1.3",
|
||||||
"scule": "^0.2.1",
|
"scule": "^0.2.1",
|
||||||
"superb": "^4.0.0",
|
"superb": "^4.0.0",
|
||||||
"unbuild": "latest"
|
"unbuild": "latest"
|
||||||
|
@ -2,6 +2,7 @@ import { promises as fsp } from 'fs'
|
|||||||
import { relative, resolve } from 'pathe'
|
import { relative, resolve } from 'pathe'
|
||||||
import { cyan } from 'colorette'
|
import { cyan } from 'colorette'
|
||||||
import { Nuxt, TSReference } from '@nuxt/kit'
|
import { Nuxt, TSReference } from '@nuxt/kit'
|
||||||
|
import type { TSConfig } from 'pkg-types'
|
||||||
import consola from 'consola'
|
import consola from 'consola'
|
||||||
import { getModulePaths, getNearestPackage } from './cjs'
|
import { getModulePaths, getNearestPackage } from './cjs'
|
||||||
|
|
||||||
@ -9,6 +10,38 @@ export const writeTypes = async (nuxt: Nuxt) => {
|
|||||||
const modulePaths = getModulePaths(nuxt.options.modulesDir)
|
const modulePaths = getModulePaths(nuxt.options.modulesDir)
|
||||||
const rootDir = nuxt.options.rootDir
|
const rootDir = nuxt.options.rootDir
|
||||||
|
|
||||||
|
const tsConfig: TSConfig = {
|
||||||
|
compilerOptions: {
|
||||||
|
target: 'ESNext',
|
||||||
|
module: 'ESNext',
|
||||||
|
moduleResolution: 'Node',
|
||||||
|
strict: true,
|
||||||
|
allowJs: true,
|
||||||
|
noEmit: true,
|
||||||
|
resolveJsonModule: true,
|
||||||
|
types: ['node'],
|
||||||
|
baseUrl: relative(nuxt.options.buildDir, nuxt.options.rootDir),
|
||||||
|
paths: {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const aliases = {
|
||||||
|
...nuxt.options.alias,
|
||||||
|
'#build': nuxt.options.buildDir
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const alias in aliases) {
|
||||||
|
const relativePath = relative(nuxt.options.rootDir, aliases[alias]).replace(/(?<=\w)\.\w+$/g, '') /* remove extension */ || '.'
|
||||||
|
tsConfig.compilerOptions.paths[alias] = [relativePath]
|
||||||
|
|
||||||
|
try {
|
||||||
|
const { isDirectory } = await fsp.stat(resolve(nuxt.options.rootDir, relativePath))
|
||||||
|
if (isDirectory) {
|
||||||
|
tsConfig.compilerOptions.paths[`${alias}/*`] = [`${relativePath}/*`]
|
||||||
|
}
|
||||||
|
} catch { }
|
||||||
|
}
|
||||||
|
|
||||||
const references: TSReference[] = [
|
const references: TSReference[] = [
|
||||||
...nuxt.options.buildModules,
|
...nuxt.options.buildModules,
|
||||||
...nuxt.options.modules,
|
...nuxt.options.modules,
|
||||||
@ -20,7 +53,7 @@ export const writeTypes = async (nuxt: Nuxt) => {
|
|||||||
const declarations: string[] = []
|
const declarations: string[] = []
|
||||||
|
|
||||||
await nuxt.callHook('builder:generateApp')
|
await nuxt.callHook('builder:generateApp')
|
||||||
await nuxt.callHook('prepare:types', { references, declarations })
|
await nuxt.callHook('prepare:types', { references, declarations, tsConfig })
|
||||||
|
|
||||||
const declarationPath = resolve(`${rootDir}/nuxt.d.ts`)
|
const declarationPath = resolve(`${rootDir}/nuxt.d.ts`)
|
||||||
|
|
||||||
@ -42,6 +75,10 @@ export const writeTypes = async (nuxt: Nuxt) => {
|
|||||||
await fsp.writeFile(declarationPath, declaration)
|
await fsp.writeFile(declarationPath, declaration)
|
||||||
|
|
||||||
consola.success('Generated', cyan(relative(process.cwd(), declarationPath)))
|
consola.success('Generated', cyan(relative(process.cwd(), declarationPath)))
|
||||||
|
|
||||||
|
const tsConfigPath = resolve(nuxt.options.buildDir, 'tsconfig.json')
|
||||||
|
await fsp.mkdir(nuxt.options.buildDir, { recursive: true })
|
||||||
|
await fsp.writeFile(tsConfigPath, JSON.stringify(tsConfig, null, 2))
|
||||||
}
|
}
|
||||||
|
|
||||||
function renderAttrs (obj: Record<string, string>) {
|
function renderAttrs (obj: Record<string, string>) {
|
||||||
|
3
playground/tsconfig.json
Normal file
3
playground/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
@ -2593,6 +2593,7 @@ __metadata:
|
|||||||
lodash.template: ^4.5.0
|
lodash.template: ^4.5.0
|
||||||
mlly: ^0.2.6
|
mlly: ^0.2.6
|
||||||
pathe: ^0.2.0
|
pathe: ^0.2.0
|
||||||
|
pkg-types: ^0.1.3
|
||||||
rc9: ^1.2.0
|
rc9: ^1.2.0
|
||||||
scule: ^0.2.1
|
scule: ^0.2.1
|
||||||
semver: ^7.3.5
|
semver: ^7.3.5
|
||||||
@ -13679,6 +13680,7 @@ fsevents@~2.3.2:
|
|||||||
mri: ^1.2.0
|
mri: ^1.2.0
|
||||||
p-debounce: ^4.0.0
|
p-debounce: ^4.0.0
|
||||||
pathe: ^0.2.0
|
pathe: ^0.2.0
|
||||||
|
pkg-types: ^0.1.3
|
||||||
scule: ^0.2.1
|
scule: ^0.2.1
|
||||||
superb: ^4.0.0
|
superb: ^4.0.0
|
||||||
unbuild: latest
|
unbuild: latest
|
||||||
@ -14568,6 +14570,13 @@ fsevents@~2.3.2:
|
|||||||
languageName: node
|
languageName: node
|
||||||
linkType: hard
|
linkType: hard
|
||||||
|
|
||||||
|
"pkg-types@npm:^0.1.3":
|
||||||
|
version: 0.1.3
|
||||||
|
resolution: "pkg-types@npm:0.1.3"
|
||||||
|
checksum: 3d1d9c9c39e8ed5299dbd1e729bca16154ae59b2dfe3703a8f24b1fe58280662663f7531b48a431feeecf4b5a7785a42f37cfe1541ff612ec6394bc5a1f61060
|
||||||
|
languageName: node
|
||||||
|
linkType: hard
|
||||||
|
|
||||||
"pkg-up@npm:^2.0.0":
|
"pkg-up@npm:^2.0.0":
|
||||||
version: 2.0.0
|
version: 2.0.0
|
||||||
resolution: "pkg-up@npm:2.0.0"
|
resolution: "pkg-up@npm:2.0.0"
|
||||||
|
Loading…
Reference in New Issue
Block a user