Project must list all files or use an 'include' pattern

Question

I see this warning thrown in VSCode:

This is the line that throws the ts warning:

import packageJson from "../package.json";

Weirdly, building and linting the project works fine:

$ tsc --project .
✨  Done in 1.16s.

$ tslint --config ../../tslint.json --project .
✨  Done in 1.59s.

Is this a warning caused by the VSCode parser, or is there something wrong in my tsconfig.json file?

// tsconfig.json
{
  "exclude": [
    "node_modules"
  ],
  "extends": "../../tsconfig.json",
  "files": [
    "package.json"
  ],
  "include": [
    "src/**/*"
  ],
  "compilerOptions": {
    /* Basic Options */
    "outDir": "dist",
    /* Module Resolution Options */
    "baseUrl": ".",
  }
}

Martguerita

Answer 1

In my case I was builiding a monorepo and referencing one of the packages into another package.

All I had to do was remove composite: true from tsconfig.json and it worked.

Lelahleland

It works! Why this is not accepted answer? or maybe it raise another problem for others? – Indopacific

This worked for me, but what functionality are we losing by removing composite? I'm referring to my package tsconfig.json from a base tsconfig.json using references. – Lugworm

why does it work?! – Paramatta

You shouldn't do this. Setting composite to false disables enforcement of includes patterns (see docs). It's not clear to me why JSON files aren't included by default when writing wildcard globs, but specifically including *.json files seems to work fine (TS 5.2.2). – Yardman

Answer 2

As dumb as it sounds, restarting VSCode fixed this for me.

Milker

unbeliveable, but same for me :D – Resiniferous

worked in my Jetbrains IDE (PyCharm) as well – Sprit

same for me :))) – Legitimatize

Same here. You don't have to re-start though. You can re-load the window: hit F1, serach for "reload developer window", select the entry and hit Enter. This solves a lot of issues with false errors in VSCode. – Depressor

worked for me to restart aswell – Veratridine

Have you tried turning it off and on again? – Spires

Even better than the suggestion from @Fred, from the command palette, run Typescript: Restart TS Server to quickly restart the TS language server only. – Lafontaine

@JoeSadoski awesome, thanks for sharing! This avoids all the popups from re-loaded plugins :-D – Depressor

Answer 3

Samuel's suggestion works great for me.

I got the same error for another reason, I use .json files as static mocks for tests - importing them as modules. In my case the files are nested inside src, and adding an explicit pattern to include .json files did the trick for me.

Here's the relevant part in my tsconfig.json:

{
  "include": [
    // ...other includes
    "src/**/*.json"
  ]
}

Referring to the question asked - this should work:

{
  "include": [
    "src/**/*",
    "package.json" // <---
  ]
}

Guthrey

This answer isn't very useful since you don't mention which file the above code is meant to go into. – Extern

@Extern Obviously tsconfig – Markus

@Markus Nothing ever is obvious – Depressor

didn't work unfortunately – Grivation

Answer 4

Open your tsconfig.node.json, and add your files path in the includes just like "include": ["vite.config.ts", "yourFilePath"],

Yoshieyoshiko

Adding "src/folderName/*.json" on tsconfig.include worked for me – Waugh

Answer 5

Add package.json to your includes. It out of src dir.

{ 
    "include": [
      "src/**/*",
      "package.json"
    ]
}

Azeotrope

but I got: error TS6059: File 'package.json' is not under 'rootDir' 'src'. 'rootDir' is expected to contain all source files. – Sideshow

Is your rootDir set to src? If so it won't work, remove rootDir or set to "." – Quent

Answer 6

This can happen if your server is running when you add new files. If this is the case, simply stop it and start it again so that is can rebuild and include the new files.

Climacteric

Answer 7

Try adding:

"resolveJsonModule": true,
"esModuleInterop": true 

to your compiler options

Manolo

I already had these in the topmost tsconfig.json file, but to make sure I also dropped it in the nested one (the file from the OP); it did NOT work – Martguerita

If this doesn’t work, you’re most likely running into this bug: github.com/microsoft/TypeScript/pull/… – Antiseptic

Answer 8

On WebStorm

After including the file in tsconfig.app.json, I also had to do "File" > "Invalidate Caches and Restart" before the error went away.

EDIT: Sometimes it's enough to just restart the Vue Language Server (at the bottom right)

Cheetah

Thanks! Not sure I would have ever figured this one out on my own. – Tetryl

Answer 9

There's an incredibly long thread about this issue in the TypeScript repository.

Although not a permanent fix, the easiest solution is restarting your TypeScript server.

Ctrl + Shift + P > TypeScript: Restart TS Server With this, you don't have to restart vscode or reinstall node_modules.

Mindoro