DEV Community

TypeScript + Yarn Workspace Monorepo

t7yang on March 15, 2020

When you have serveral highly coupled projects which you want to organize them together, you can consider a monorepo. Yarn (1.x) provide the works...

Read full post

Ivan Wang • Jul 7 '20

Thanks for the nice article. Wondering if you also have experience of implementing hot reload with TS composite approach? For the context, I am particularly interested at NextJS hot reload when shared module (aka package or workspace) updated. Thanks in advance.

t7yang • Jul 8 '20

I'm not working with NextJS before, but I don't think they going to support this.
github.com/vercel/next.js/issues/8708

Wise Introvert • Oct 20 '20

Great article. Can you please help me with this error: Could not find a declaration file for module '@my-organisation/common'. I followed your article to the teeth but can't seem to find a solution to this issue.

t7yang • Oct 21 '20

You can check the node_modules folder first to make sure @my-organisation/common existed. Somehow after yarn install / update some packages just "disappear". If so, you can do a yarn install --force to force yarn install again.

Aral Roca • Mar 16 '23

In my case I checked an exist inside the node_modules, but without the dist folder.

shared package tsconfig.json:

{
  "compilerOptions": {
    "declaration": true,
    "declarationMap": true,
    "sourceMap": true,
    "composite": true,
    "outDir": "dist",
    "rootDir": "src"
  },
  "include": [
    "src"
  ]
}

and shared package.json:

{
  "name": "shared",
  "version": "1.0.0",
  "license": "MIT",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "files": [
    "dist"
  ],
  "devDependencies": {
    "typescript": "4.9.5"
  }
}

Do you know why this can happen? Thanks!

Aral Roca • Mar 16 '23

@t7yang I updated your example from typescript 3.8.3 to 4.9.5 and is not working either. Do you know how to fix it for TypeScript v.4.9.5?

t7yang • Mar 18 '23

have you run the build cmd? you need to build at least once to generate the dist folder. the final solution is run the tsc in your shared folder.

wiseintrovert • Oct 21 '20

Thanks!

Yashua • Sep 6 '21

For those that get an issue with Cannot find module "shared" or its corresponding type declarations when it is not yet built when you try to build the backend... I had this in my base config: "lib": ["es6", "es2015"],. Changing it to "lib": ["ESNext"], fixed the issue.

Josh Pollock • May 26 '20

This is my go-to, quick guide to setting up TypeScript in a monorepo. Thank you

Marais Rossouw • Apr 20 '20

Great read man! Might also be worth mentioning here that projectReferences are a thing - helps speed up building too.

Dmytro Dmytro • Jul 12 '20

Sounds pro! Thanks. In the following article, I consider the same topic, but from the aliases issue perspective: webman.pro/blog/how-to-setup-types....