Search code examples
javascriptnode.jsrequirejsamdcommonjs

Wrap CommonJS 3rd party library as AMD module

I am trying to use a Node library with RequireJS, but I cannot make it AMD compatible. I use this library: https://github.com/wdavidw/node-pad

It exports a function. Question is, how to wrap it as an AMD module? I tried to export it with shim options but it didn't work. I don't see an error, but it resolves an undefined instance.

Any suggestion?

What I tried so far:

let config: RequireConfig = {
    paths: {
        "text": "../node_modules/requirejs-text/text",
        "plugins": "../node_modules/durandal/js/plugins",
        "durandal": "../node_modules/durandal/js",
        "transitions": "../node_modules/durandal/js/transitions",
        "knockout": "../node_modules/knockout/build/output/knockout-latest",
        "jquery": "../node_modules/jquery/dist/jquery",
        "bootstrap": "../node_modules/bootstrap/dist/js/bootstrap",
        "pad": "../node_modules/pad/lib/index",
        "i18n-iso-countries": "../node_modules/i18n-iso-countries/index",
        "json": "../node_modules/requirejs-plugins/src/json",
        "alpha2codes": "../node_modules/i18n-iso-countries/alpha2codes",
        "codes": "../node_modules/i18n-iso-countries/codes.json",
        "languages": "../node_modules/i18n-iso-countries/languages",
        "ar": "../node_modules/i18n-iso-countries/langs/ar.json",
        "cs": "../node_modules/i18n-iso-countries/langs/cs.json",
        "de": "../node_modules/i18n-iso-countries/langs/de.json",
        "en": "../node_modules/i18n-iso-countries/langs/en.json",
        "es": "../node_modules/i18n-iso-countries/langs/es.json",
        "et": "../node_modules/i18n-iso-countries/langs/et.json",
        "fi": "../node_modules/i18n-iso-countries/langs/fi.json",
        "fr": "../node_modules/i18n-iso-countries/langs/fr.json",
        "hu": "../node_modules/i18n-iso-countries/langs/hu.json",
        "it": "../node_modules/i18n-iso-countries/langs/it.json",
        "nb": "../node_modules/i18n-iso-countries/langs/nb.json",
        "nl": "../node_modules/i18n-iso-countries/langs/nl.json",
        "nn": "../node_modules/i18n-iso-countries/langs/nn.json",
        "pl": "../node_modules/i18n-iso-countries/langs/pl.json",
        "pt": "../node_modules/i18n-iso-countries/langs/pt.json",
        "ru": "../node_modules/i18n-iso-countries/langs/ru.json",
        "sv": "../node_modules/i18n-iso-countries/langs/sv.json",
        "tr": "../node_modules/i18n-iso-countries/langs/tr.json",
        "zh": "../node_modules/i18n-iso-countries/langs/zh.json"
    },
    shim: {
        "bootstrap": {
            deps: ["jquery"]
        },
        "i18n-iso-countries": {
            deps: ["pad", "alpha2codes", "languages"]
        },
        "pad": {
            exports: "pad"
        }
    },    
    urlArgs: `=${new Date().getTime()}`
};

requirejs.config(config);
require(['jquery', 'bootstrap'], () => {
    require(["./bootstrapper"], (b) => {
        var instance = new b();
        instance.init();
    });
});
Solution

  • The shim option does not wrap non-AMD modules into an AMD define. It is really meant to be used for scripts that don't support any module system whatsoever. To load a CommonJS module with RequireJS the minimal work that needs to be done is to wrap it with a define call of this form:

    define(function (require, exports, module) {
  // script contents here...
});

    There are many ways to do it. You could implement a build step in whatever build too you use to add the wrap. Or you can use a tool that does it already like RequireJS' optimizer (r.js).