nuxt / nuxt/module-builder

What is the correct configuration for tsconfig.json?

Open
#668 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
275
Forks
35
Avg merge
4h 42m
Merged PRs (30d)
6

Description

I noticed that it is not typed correctly and when I do the build it produces a different output than when I open the vscode window which types by itself.

Actual configration tsconfig.json is there:

{
  "extends": "./.nuxt/tsconfig.json",
  "exclude": [
    "dist",
    "node_modules",
    "playground",
  ]
}
Updated

When opening a .vue file or restarting the TS server with the Vue Volar plugin, a .vue-global-types folder is created in node_modules, and thanks to its base definitions, typing works completely.

However, when building, I cannot rely on the Vue Volar plugin.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with tsconfig.json and the referenced .nuxt/tsconfig.json, then compare the build's TypeScript behavior with the typing provided by the Vue Volar plugin and its generated .vue-global-types folder. Reproduce the discrepancy through the build and a VS Code session; done means the supported configuration and resulting typing behavior are consistent without relying on the plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxtjs, typescript, vscode
Domain
build-system, developer-experience
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.