Adopt Typescript 3.0 references and composite tsconfig.json setting?

[brioux]

@sichen1234
I propose we add references with the composite tsconfig.json setting to help structure the sub-typescript programs across the project... https://www.typescriptlang.org/docs/handbook/project-references.html
How to split up a large TypeScript project

I have setup a working branch here

This should help with production deployments improve code structure fro imports/exports across workspaces.

Will require significant refactoring throughout so wanted opinions from other contributors...

[brioux]

Finished updating the the working branch.

Improves code structure for imports/exports across workspaces.

Necessary for production staging of methane portal to heroku.

Will be helpful for future production deployment

[rybalko]

@brioux This sounds good, but I cannot understand in which cases "references" should be used
and should be not, for example you use it in the methane server and not in the client.

And how it is helpful for production deployment ?

[brioux]

@rybalko

I used references to help track the workspace structure while debugging issues with the production build (see below)
Referencing can be useful for smart incremental builds (-b option) to auto recompile changes to dependent workspaces ...
mono-repo npm run build should handle production deployment without references...

TBH i'm haven't fully grasped the full benefit of references. And, as you point out, I did not implement it for the client...

I faced the following issue when deploying production build of the methane app to heroku.
errors like : Cannot find module '@blockchain-carbon-accounting/data-postgres' or its corresponding type declarations .. and so on

issues included missing or bad tsconfig.json ...
Also when running production builds I had to point each package to the compiled output dir and setup the export index (i.e., dist/index.js)... to get cross workspace imports to work.

Importing from subdirs was not working in production builds. Probably a missing a package config option ... ?
I decided to go the index route to help track exports, and consolidate multiple imports from individual packages

These were the real fixes, references was a byproduct of debugging...