Add documentation and example code for projectReferences #1184
Conversation
|
This is fantastic work! I need to give it a proper read but thanks so much already ❤️🌻 |
REFERENCES.md
Outdated
| @@ -0,0 +1,329 @@ | |||
|
|
|||
| # Using TypeScript Project References with ts-loader and Webpack | |||
There was a problem hiding this comment.
Lowercase w for webpack please; surprising though it may be, that's the official casing
There was a problem hiding this comment.
I'll make this change throughout the document.
|
|
||
| ### Configure and build the project references | ||
|
|
||
| This stage just involves following the directions from the TypeScript documentation: |
There was a problem hiding this comment.
As I understand it from the "Using ts-loader to build project references" section, following the approach prior to that is an alternative approach that could be used and also probably not the one people will likely go for. ts-loader building references is just going to be simpler (my presumption)
As such, is it worth calling out here that these docs are going to outline 2 approaches more explicitly?
There was a problem hiding this comment.
I wanted to show how to configure using tsc --build because you need to get that part right or nothing is going to work. It is also helpful to check that it is working with tsc independently if you are having problems. Once it is working I believe most people would use ts-loader.
I'll amend the docs to make it clear I am not proposing 2 alternatives.
|
This is awesome - thanks @appzuka! |
I have added a new document, REFERENCES.md and linked to it from the main README.md. I have also added an example to the examples/ folder.
Please feel free to make any changes to the wording/formatting/structure as appropriate.