TypeScript: Building composite project with resolveJsonModule fails

This works for me:

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

This is still an issue

I was spending time fiddling around with this until I realized it was a TS issue.

It is confusing and not intuitive to have to write something like

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

@sheetalkamat Thank you for the comment, I see your point.

Let me explain my use case. In LoopBack, we have a concept of a data source - a class providing access to a database, web service, etc. An application (a LoopBack/TypeScript project) can have multiple datasources. Each datasource is implemented in two files: a JSON file with the configuration (to make it easy to edit programmatically) and a TypeScript file exporting the datasource class.

The TypeScript code in src/datasources/db.datasource.ts (full version):

import * as config from './db.datasource.json';

export class DbDataSource extends juggler.DataSource {
  constructor() {
    super(dsConfig);
  }
}

JSON config in src/datasources/db.datasource.json (full version):

{
  "name": "db",
  "connector": "memory"
}

Relevant parts of tsconfig (we are not using project references yet):

{
  "$schema": "http://json.schemastore.org/tsconfig",
  "compilerOptions": {
    "rootDir": "."
    "resolveJsonModule": true,

    "lib": ["es2018", "dom", "esnext.asynciterable"],
    "module": "commonjs",
    "moduleResolution": "node"
  },
  "include": ["index.ts", "src", "test"]
}

Now back to the topic of this issue:

1. When the project is not composite and compiler is running in the “classic” mode (without -b), it correctly understands that db.datasource.ts is importing db.datasource.json and therefore the JSON file needs to be included in the compilation too.

   I find it confusing that composite/build mode changes this behavior.

2. When the project is switched to composite mode (the only change being adding composite: true to compilerConfig), the compilation starts failing with error TS6307. Despite this error, the actual JSON file is correctly copied to the output directory.

   I find it confusing that the compiler understands that a JSON file is imported and thus needs to be copied to the output directory, yet it complains that it was not explicitly listed in tsconfig’s files section.

3. I find the requirement to explicitly add all JSON files one by one as a poor user experience. For applications (projects) containing many JSON files, the tsconfig content can become large and difficult to maintain.

If my first two arguments above are not convincing enough and/or there are other reasons explaining why JSON files must be treated differently in composite vs. non-composite projects: Can we at least allow JSON files to be specified via an explicit pattern in include, e.g. src/datasources/*.datasource.json? By explicit I mean that the pattern must match JSON files only (i.e. the pattern string must end with .json).

We do not want to add json files in compilation accidently and want users to explicitly specify them instead of using the include/exclude pattern.

I’m experiencing the same issue my project is setup as followed:

.
├── @types
├── package.json
├── src
│   ├── consts.json
│   ├── main
│   │   ├── index.ts
│   │   └── tsconfig.json
│   ├── tsconfig.json
│   ├── utils
│   │   ├── html-template.ts
│   │   └── tsconfig.json
│   └── worker
│       ├── state.ts
│       └── tsconfig.json
└── tsconfig.base.json

My main entry configuration file is src/tsconfig.json which only have references to other sub projects localized in src/main, src/worker and src/utils and in the main project I’m trying to access the src/consts.json file and I’m getting the error:

File '/workspace/src/consts.json' is not listed within the file list of project '/workspace/src/main/tsconfig.json'. Projects must list all files or use an 'include' pattern.

Although I’ve listed it explicitly through files in src/main/tsconfig

{
  "extends": "../../tsconfig.base.json",
  "files": [
    "./index.ts",
    "../consts.json",
  ],
  "references": [
    {"path": "../worker"},
    {"path": "../utils"}
  ]
}

@strax @sheetalkamat @mhegazy Is this problem fixed in TypeScript 3.1.1?

I have tried to use TypeScript 3.1.1 in the repro project, TypeScript gives the following error:

error TS6307: File '/src/hello.json' is not in project file list. Projects must list all files or use an 'include' pattern.

It seems to this problem is still exist.

this still an issue 2021 … why this been closed?

@trusktr’s solution worked, but I had to restart my IDE.

Why is this issue closed?

@sheetalkamat We ran into a similar issue as @cockscomb. tsc complains about json files not in project file list no matter how we tweak tsconfig.json:

{
  "$schema": "http://json.schemastore.org/tsconfig",
  "compilerOptions": {
    "rootDir": "src",
    "composite": true,
    "target": "es2017",
    "outDir": "dist"
  },
  "references": [
    ...
  ],
  "include": [
    "**/*"
  ]
}

None of the following works:

• "include": ["**/*"]
• "include": ["**/*.json", "**/*.ts"]

Do we have to use files to include json files?

@cockscomb you need to have files clause to have the json file("files": ["src/hello.json"] in the tsconfig file). The issue here was it reported unsupported extension (which is not what you are seeing) In your cc: @RyanCavanaugh

we should allow .json in files list if --resolveJsonModules is enabled.

There is still the issue of JSON files in node_modules not working.

@zerubeus & anyone reading this in the future - I just checked after running into this issue now, it seem like @TsaiTsaiChieh 's PR above fixes the issue by allowing a glob pattern in tsconfig’s include property:

include: [“**/*.json”]

https://github.com/TsaiTsaiChieh/never-stray/commit/ac22f38c00a0a7f997ee3ca1a7c9eb6b90feee50

Confirmed working on typescript 4.5.4

Just add this to the root of tsconfig.json:

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