babel-plugin-name-amd-modules

babel-plugin-name-amd-modules

Give a name to AMD modules based on package name and version and module path.

Example

In

define([], function(){})

Out

define("package@1.0.0/index", [], function () {});

Installation

npm install --save-dev babel-plugin-name-amd-modules

Usage

Add the following to your .babelrc file:

Without options:

{
  "plugins": ["name-amd-modules"]
}

With options:

{
  "plugins": [
    ["name-amd-modules", {
        "packageName": "my-npm-package",
        "srcPrefixes": [
            "packages/my-npm-package",
            "packages/my-other-npm-package"
        ]
    }]
  ]
}

Technical Details and Options

This plugins scans modules for AMD define() calls and rewrites the module name argument with one based on the name of the package that contains the module and the module's relative path inside that package (removing the extension from the file name too).

By default (if no custom value is given for the packageName option) this plugin scans the parent folders of the module file until it finds a package.json file and reads the package name from it. Otherwise, the package name can be forced to any fixed value by providing a value other than <package.json> to the packageName option.

To determine the relative path of the modules the srcPrefixes option is examined and any folder found on it is removed from the path of the modules being processed, giving the relative package name.

For example, given a srcPrefixes of ["src/main/resources/META-INF/resources"] if the module under src/main/resources/META-INF/resources/lib/index.js is processed, its relative path is computed to lib/index.js.

The default value of the srcPrefixes option is ["src/main/resources/META-INF/resources"].