ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

UMD snippets

by garrettn ST2/ST3

JavaScript Universal Module Definition snippets for Sublime Text

Details

Installs

  • Total 264
  • Win 96
  • OS X 123
  • Linux 45
Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9
Windows 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime UMD Snippets

JavaScript snippets for the Universal Module Definition.

Installation

Use Package Control. Search for “UMD Snippets.”

Alternatively, clone this repository into your Packages folder.

Usage

Each snippet is described below, with a title that you can search for in the Command Palette (prefixed by “UMD—”) and with a tab trigger.

The snippets mirror (with a couple tiny differences) the templates provided in the UMD repo, with fields for making it easier to configure module names and dependencies. For detailed explanations of each UMD variant, see the corresponding template in the UMD repo.

AMD or browser global

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['b'], factory);
    } else {
        // Browser globals
        root.amdWeb = factory(root.b);
    }
}(this, function (b) {

    function amdWeb () {

    }

    return amdWeb;
}));

Tab trigger: umda

Fields:

  1. module name
  2. factory dependencies
  3. module parameters
  4. module code

Reference: amdWeb

AMD with global export

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['b'], function (b) {
            // Also create a global in case some scripts
            // that are loaded still are looking for
            // a global even when an AMD loader is in use.
            return (root.amdWebGlobal = factory(b));
        });
    } else {
        // Browser globals
        root.amdWebGlobal = factory(root.b);
    }
}(this, function (b) {

    function amdWebGlobal () {

    }

    return amdWebGlobal;
}));

Tab trigger: umdag

Fields:

  1. module name
  2. factory dependencies
  3. module parameters
  4. module code

Reference: amdWebGlobal

CommonJS adapter

// Help Node out by setting up define.
if (typeof exports === 'object' && typeof define !== 'function') {
    define = function (factory) {
        factory(require, exports, module);
    };
}

define(function (require, exports, module) {
    var b = require('b');

    // Only attach properties to the exports object to define
    // the module's properties.
    exports.action = function () {

    };
});

Tab trigger: umdca

Fields:

  1. name of property on the exports object
  2. optional dependency
  3. module parameters
  4. module code

Reference: commonjsAdapter

CommonJS strict

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['exports', 'b'], factory);
    } else if (typeof exports === 'object') {
        // CommonJS
        factory(exports, require('b'));
    } else {
        // Browser globals
        factory((root.commonJsStrict = {}), root.b);
    }
}(this, function (exports, b) {

    // attach properties to the exports object to define
    // the exported module properties.
    exports.action = function () {

    };
}));

Tab trigger: umdcs

Fields:

  1. global module name
  2. name of property on exports object
  3. factory dependencies
  4. module parameters
  5. module code

Reference: commonjsStrict

CommonJS strict with global

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['exports', 'b'], function (exports, b) {
            factory((root.commonJsStrictGlobal = exports), b);
        });
    } else if (typeof exports === 'object') {
        // CommonJS
        factory(exports, require('b'));
    } else {
        // Browser globals
        factory((root.commonJsStrictGlobal = {}), root.b);
    }
}(this, function (exports, b) {

    // attach properties to the exports object to define
    // the exported module properties.
    exports.action = function () {

    };
}));

Tab trigger: umdcg

Fields:

  1. global module name
  2. name of property on exports object
  3. factory dependencies
  4. module parameters
  5. module code

Reference: commonjsStrictGlobal

jQuery plugin

(function (factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['jquery'], factory);
    } else {
        // Browser globals
        factory(jQuery);
    }
}(function ($) {
    $.fn.jqueryPlugin = function () {

    };
}));

Tab trigger: umdj

Fields:

  1. plugin name
  2. factory dependencies
  3. plugin parameters
  4. plugin code

Reference: jqueryPlugin

jQuery plugin with CommonJS

(function (factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['jquery'], factory);
    } else {
        // Browser globals
        factory(jQuery);
    }
}(function ($) {
    $.fn.jqueryPlugin = function () {

    };
}));

Tab trigger: umdjc

Fields:

  1. plugin name
  2. factory dependencies
  3. plugin parameters
  4. plugin code

Reference: jqueryPluginCommonjs

Node adapter

// Help Node out by setting up define.
if (typeof module === 'object' && typeof define !== 'function') {
    var define = function (factory) {
        module.exports = factory(require, exports, module);
    };
}

define(function (require, exports, module) {
    var b = require('b');

    return function () {

    };
});

Tab trigger: umdn

Fields:

  1. optional dependency
  2. module parameters
  3. module code

Reference: nodeAdapter

AMD, Node, or browser global

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['b'], factory);
    } else if (typeof exports === 'object') {
        // Node. Does not work with strict CommonJS, but
        // only CommonJS-like enviroments that support module.exports,
        // like Node.
        module.exports = factory(require('b'));
    } else {
        // Browser globals (root is window)
        root.returnExports = factory(root.b);
    }
}(this, function (b) {

    function returnExports () {

    }

    return returnExports;
}));

Tab trigger: umdr

Fields:

  1. module name
  2. factory dependencies
  3. module parameters
  4. module code

Reference: returnExports

AMD with global, Node, or global

(function (root, factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD. Register as an anonymous module.
        define(['b'], function (b) {
            // Also create a global in case some scripts
            // that are loaded still are looking for
            // a global even when an AMD loader is in use.
            return (root.returnExportsGlobal = factory(b));
        });
    } else if (typeof exports === 'object') {
        // Node. Does not work with strict CommonJS, but
        // only CommonJS-like enviroments that support module.exports,
        // like Node.
        module.exports = factory(require('b'));
    } else {
        // Browser globals (root is window)
        root.returnExportsGlobal = factory(root.b);
    }
}(this, function (b) {

    function returnExportsGlobal () {

    }

    return returnExportsGlobal;
}));

Tab trigger: umdrg

Fields:

  1. module name
  2. factory dependencies
  3. module parameters
  4. module code

Reference: returnExports

Contributing

Pull requests for improving the snippets are welcome. If you want to make changes to the module definitions themselves, please send those requests to the UMD repo.

License

The Sublime UMD Snippets package is released under the MIT License. See LICENSE.txt for details.