If your repository is a multi package repository (via lerna.js or yarn workspaces) in combination with project references from TypeScript, this tool will be very helpful by reading dependencies out of the package.json and applying them to the tsconfig.json as references.
There's a blog post that's a good introduction to it Optimizing multi-package apps with TypeScript Project References.
You can just use it via npx
npx update-ts-references --help
Usage: update-ts-references [options]
Options:
--help Show help
--cwd Set working directory. Default: [current path]
--discardComments Discards comments when updating tsconfigs. Default: false
--verbose Show verbose output. Default: false
or you add it as dev dependency and include it in the postinstall script in the package.json
yarn add update-ts-references --dev -W
"scripts": {
"postinstall": "update-ts-references"
},
Where are the comments from my tsconfig?
update-ts-references is not able to preserve comments in tsconfig files when it is updating the references. If you need comments for the case like, explaining why compiler options are set, please move this part including comments into a second file and use the extends functionallity (see here).
Copyright 2020 mobile.de Developer: Mirko Kruschke
Use of this source code is governed by an MIT-style license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.