Add tsconfig-paths to documentation

[darcyparker]

I learned about tsconfig-paths in #138.

Path mappings are very useful, so using tsconfig-paths is often a must have for me when using ts-node.

I think it would be helpful to list of useful modules like tsconfig-paths in the README.md. (Similar to recommendations made for Watching and Restarting.)

EDIT from @cspotcode: marked this ticket as "help wanted" with a list of tasks here: #704 (comment)

[blakeembrey]

It is in the README under the tsconfig.json section. I’ll keep this issue open to refactor this into a “related” module area instead.

[cspotcode]

@blakeembrey do you think this is adequately covered by this page? https://typestrong.org/ts-node/docs/paths

[FossPrime]

@cspotcode it's informative... but it should probably contain some samples of common scenarios, known bugs and links to the issues about this.

#1007 (comment)

[cspotcode]

@rayfoss how about this as a plan forward? I think it strikes a balance between improving the docs, saving the team's limited time resources, and giving users agency to help each other. It effectively solves the core problem which is: "make this work for users"

• Create an official discussion thread for paths and tsconfig-paths usage
• Link to this discussion thread from that docs page
• Encourage users to share working configurations in that thread
• If / when certain configurations emerge as the best, clearest examples, we look at adding them to the website

If that plan sounds good, I can mark this ticket as "help wanted" and allow the community to tackle all of those tasks.