A jQuery plugin boilerplate

jquery.plugin.js

const NAME = 'pluginName';


const methods = {

  method1: function () {

    const conf = this.data(`${NAME}-config`);
    if (!conf) return this;

    //
    
    return this;
  }
};


jQuery[NAME] = {
  
  CONSTANT1: '...',
  
  globalMethod1: () => {
    //
  }
};


jQuery.fn[NAME] = function (settings) {

  if (!this.length) return this;
  
  if (typeof settings === 'string') {
    if (methods[settings]) {
      const args = Array.prototype.slice.call(arguments, 1);
      return methods[settings].apply(this, args);
    } else {
      throw new Error(`${NAME} method unrecognized "${settings}".`);
    }
  }

  if (this.data(`${NAME}-config`)) return;

  const conf = $.extend(true, {
    //
  }, settings);

  this.data(`${NAME}-config`, conf);

  this.each(function () {
    
    // HTML
    //
    
    // EVENTS
    //
    
    // INIT
    //
  });

  return this;
};