Is there source map support for typescript in node / nodemon?

Question

I have a node project written in typescript@2.

My tsconfig has sourceMap set to true and the *.map.js files are generated. When I execute my transpiled *.js JavaScript files via node or nodemon, I only see the error messages relative to the js file and not to the mapped typescript files; I assume it's completely ignored.

Is sourceMap support only intended for browser-support? Or can I use it together with node or nodemon? If the latter, how would I enable it?

I want to see runtime errors detected from an executed javascript file relative to the original typescript file.

Inigo · Accepted Answer · 2022-03-04 09:16:38Z

44

🚩 for Node versions since v12.12, there is an easier and better solution.

I recently got this working in my express app. Steps as follows:

Install the required library:

npm install --save-dev source-map-support

In your entry point (eg app.ts):

require('source-map-support').install();

In your app.ts, you may also require better logging for errors within promises:

process.on('unhandledRejection', console.log);

In your tsconfig, under compilerOptions:

"inlineSourceMap": true

edited Mar 4, 2022 at 9:16

Inigo

15.7k5 gold badges54 silver badges86 bronze badges

answered May 16, 2017 at 7:22

Stephen Paul

39.4k18 gold badges99 silver badges76 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

david.barkhuizen Over a year ago

inlineSourceMap and sourceMap compiler options are mutually exclusive

k0pernikus Over a year ago

If you add the cli usage to your answer (as I pointed out in my own), I will accept yours and delete my own. ( stackoverflow.com/a/58455205/457268 )

Stephen Paul Over a year ago

@k0pernikus thanks. Apologies, not 100% sure I understand. Feel free to edit to my answer to show what you mean.

Tiago Over a year ago

Any way to do this natively without bloating a package with source-map-support?

Richard Over a year ago

From node v12, you can use the flag --enable-source-maps

Community · Accepted Answer · 2024-04-11 07:16:22Z

33

The answers here are correct for Node versions before v12.12.0, which added the --enable-source-maps flag (experimental until v15.11.0, v14.18.0). With that enabled, source maps are applied to stack traces without an additional dependency. As demonstrated in this article, it has the slightly different and possibly beneficial behavior of including both the generated .js file location and the source file location. For example:

Error: not found
    at Object.<anonymous> (/Users/bencoe/oss/source-map-testing/test.js:29:7)
        -> /Users/bencoe/oss/source-map-testing/test.ts:13:7

edited Apr 11, 2024 at 7:16

CommunityBot

11 silver badge

answered Nov 6, 2020 at 20:25

Trevor Robinson

16.7k5 gold badges80 silver badges78 bronze badges

3 Comments

user3064538 Over a year ago

NODE_OPTIONS=--enable-source-maps npm test is the command I was looking for

Clonkex Over a year ago

I found that this didn't work unless I put --enable-source-maps BEFORE the path to the script file. Perhaps this is normal for Node command line switches; I'm not sure.

vamsiampolu Over a year ago

Note: There are complaints of --enable-source-maps slowing down requests (See github.com/nodejs/node/issues/41541). Maybe a little bit of polishing is required before we can use this in production.

k0pernikus · Accepted Answer · 2020-03-15 22:02:41Z

Install source map support:

npm install source-map-support

(I run in in production as well, as it immensely helps finding bugs from the logs of when an error an occurs. I did not experience a large performance impact, yet your experience may be different.)

Add to your tsconfig.json:

{
   "compilerOptions": {
      "sourceMap": true
   }
}

When running your JavaScript file, add the require parameter:

nodemon -r source-map-support/register dist/pathToJson.js

node -r source-map-support/register dist/pathToJson.js

Alternatively, you add in your entry call:

require('source-map-support').install()

yet I find this tedious is projects with multiple entry points.

Sidenote: mocha also supports the --require / -r option, so to have the sourcemap support in mocha you can also call your tests with it, e.g. similar to:

NODE_ENV=test npx mocha --forbid-only --require source-map-support/register --exit --recursive ./path/to/your/tests/

mvermand · Accepted Answer · 2017-02-15 11:36:34Z

18

I found this npm module which seems to do the trick:

https://github.com/evanw/node-source-map-support

run npm install source-map-support --save at the root of your node project and add import 'source-map-support/register' to your main.ts or index.ts file.

That's it.

edited Feb 15, 2017 at 11:36

answered Feb 15, 2017 at 10:12

mvermand

6,1578 gold badges50 silver badges79 bronze badges

Comments

Astra Bear · Accepted Answer · 2021-11-04 23:08:10Z

10

For Node versions from v12.12.0 use the --enable-source-maps flag when you run node.

Example: node --enable-source-maps main.js

Do not install "source-map-support" for Node versions from v12.12.0

answered Nov 4, 2021 at 23:08

Astra Bear

2,7481 gold badge24 silver badges28 bronze badges

Comments

Bruno Grieder · Accepted Answer · 2017-09-15 03:11:03Z

6

Source map support works perfectly fine with node

All you need to do is add

"source-map-support": "0.4.11",

to dependencies or dev-dependencies in package.json by running

npm install --save source-map-support

And in your entry point ts file, simply add at the top

require('source-map-support').install()

(note: this is calling nodeJS require - there is no need for source-map-support definition files)

edited Sep 15, 2017 at 3:11

answered Feb 15, 2017 at 10:22

Bruno Grieder

30k10 gold badges73 silver badges104 bronze badges

2 Comments

Sev Over a year ago

Any downsides to using this in production? (server side)

Bruno Grieder Over a year ago

@Sev Not as far as we know (we do use it in production)

JRichardsz · Accepted Answer · 2024-01-07 20:54:33Z

1

If you are using node (16.20.2) nyc(15.1.0) and mocha(8.1.3) this worked for me.

The error stack pointed me to the line 4:

Solution

npm install --save-dev source-map-support

.nycrc.json

{
  "include": "src/main",  
  "all": true
}

package.json

  "scripts": {    
    "test": "NODE_OPTIONS=--enable-source-maps nyc --reporter=html --reporter=json-summary mocha 'src/test/node/**/*.test.js' --exit"
  }

The result error show the exact line 45 and extra information

edited Jan 7, 2024 at 20:54

answered Jan 7, 2024 at 20:48

JRichardsz

16.9k9 gold badges70 silver badges118 bronze badges

1 Comment

Stanisław Over a year ago

Looks like that with such settings nyc doesn't report coverage

Collectives™ on Stack Overflow

Is there source map support for typescript in node / nodemon?

7 Answers 7

5 Comments

3 Comments

Comments

Comments

Comments

2 Comments

Solution

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

5 Comments

3 Comments

Comments

Comments

Comments

2 Comments

Solution

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related