babel-plugin-source-map-support

• NAME
• INSTALL
• SYNOPSIS
• DESCRIPTION
• DEVELOPMENT
  • NPM Scripts
• COMPATIBILITY
• SEE ALSO
• VERSION
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

babel-plugin-source-map-support - a Babel plugin which automatically makes stack traces source-map aware

INSTALL

$ npm install source-map-support --save
$ npm install babel-plugin-source-map-support --save-dev

SYNOPSIS

$ cat test.js

import foo from 'foo';
import bar from 'bar';

foo(bar);

$ babel --plugins source-map-support test.js

import 'source-map-support/register';
import foo from 'foo';
import bar from 'bar';

foo(bar);

DESCRIPTION

This is a Babel plugin which prepends the following statement to source files:

import 'source-map-support/register';

In conjunction with the source-map-support module, which must be installed separately, this statement hooks into the v8 stack-trace API to translate call sites in the transpiled code back to their corresponding locations in the original code.

Note: this only works in environments which support the v8 stack-trace API (e.g. Node.js and Chrome), though it's harmless in other environments.

The source-map-support module only needs to be registered in the top-level file(s) of an application, but it no-ops if it has already been loaded, so there is no harm in registering it in every file.

You probably don't want to use this plugin when compiling code for the web because you probably don't want to bundle source-maps and the source-map module in minified code. An easy way to limit the plugin's scope to development/test builds is to use Babel's env option e.g.:

{
    env: {
        development: {
            sourceMaps: 'inline',
            plugins: ['source-map-support', ...]
        }
    },

    presets: [ ... ]
}

Note that source-maps don't need to be inlined in each file. They can be externalised by using the { sourceMaps: true } option, which adds a link to the bottom of each file which points to its external source-map e.g.:

{
    env: {
        development: {
            sourceMaps: true,
            plugins: ['source-map-support', ...]
        }
    },
}

// index.js footer:
//# sourceMappingURL=index.js.map

DEVELOPMENT

NPM Scripts

The following NPM scripts are available:

• build - compile the plugin and save it to the dist directory
• build:cjs: build the CommonJS target
• build:esm: build the ESM target
• clean - remove the dist directory and other build artifacts
• rebuild - clean the build artifacts and recompile the code
• test - rebuild the plugin and run the test suite
• test:debug - run the test script in debug mode, which dumps each transformed test case
• test:prod - run the test suite in production mode
• test:run - run the test suite

COMPATIBILITY

• Babel >= 7
• Maintained Node.js versions

SEE ALSO

• babel
• source-map-support

VERSION

2.1.1

AUTHOR

chocolateboy

COPYRIGHT AND LICENSE

Copyright © 2015-2019 by chocolateboy.

This module is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.