Skip to content

Add flag to skip source-map-support install() #1533

Open

Description

@cspotcode

Related:
#796
#1473
cspotcode/node-source-map-support#23

Add a configuration option, perhaps named installSourceMapSupport or sourceMapHooks, which can be used to disable require('@cspotcode/source-map-support').install()

Important things to consider:

  • Do we continue to generate sourcemaps when compiling? Probably the best answer is "yes" to be compatible with node's built-in --enable-source-maps
    • Maybe we should obey the user's tsconfig? If they have sourcemaps turned on/off in tsconfig, then we do/don't generate sourcemaps?
  • Clearly document default behavior:
    • with --enable-source-maps enabled, default is "off"
    • without --enable-source-maps, default is "on"
    • When set to true or false via config, overrides the default

Activity

  1. pe8ter commented on Oct 28, 2021

    @pe8ter

    Just confirming my understanding: This new option will be configurable within a tsconfig.json as well? I ask because in some scenarios we have no control over how a library invokes ts-node. As an example, Karma automatically invokes ts-node when a Karma config is written in TypeScript. Since I can't control how it invokes ts-node, it would be nice if I could throw this new flag into my tsconfig.json and have Karma pick up the flag automatically.

    It's in the README.

  2. krigga commented on May 1, 2023

    @krigga

    @cspotcode is this #2004 a good entry point for this, disregarding docs and the node's own --enable-source-maps? If so, what would be a good place to document the full behavior?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    you can do thisGood candidate for a pull request.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions