Cleaned up, fixes, documenation

Author: techlab

.gitignore

@@ -1,9 +1,7 @@
-/mpp-sw.txt
-/examples/smartwizard-bs.html
-/examples/Wizard Button.html
 /node_modules/
 /bower_components/
 /vendor/
+/public/
 
 # IDE Files
 #-------------------------
@@ -18,4 +16,3 @@
 *.sublime-workspace
 *.sublime-project
 /nbproject/private/
-/refer.txt

CONTRIBUTING.md

@@ -1,38 +1,41 @@
 # Contributing
 
-## What can I contribute?
-- Fix a bug you found or already reported on the GitHub Issues Tracker. 
+## How can I contribute?
+- Fix a bug you found or already reported.
 - Add new features to the project.
+- Create new themes  
 - Add new test cases.
 - Add documentation.
 - Add a demo page.
-- [Donate](https://www.paypal.me/dipuraj) money for the project on [![Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj).
 
 ## How to contribute code?
 Here are the basic steps to get started contributing code:
 
-1. Fork the repository and get development running on your computer.
-2. Install the npm development dependencies by the command `npm install` on the project folder (Assumes you already have NodeJS installed). 
-3. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
-4. Change the code to fix the bug or add the feature. All changes should happen in the relevant `src/js/*.js` and `src/css/*.css` files.
-5. Build the code by running `npm run build` or `gulp`.
-6. Run the test cases by running `npm test` or `gulp test`, you can also add more test cases based on your new change.
-7. Verify that your fix or feature works. 
-8. Commit your changes with an informative description.
-9. Open a pull request to the repository with your new commit and a descriptive message about what the PR does.
+1. Fork the repository.
+2. Install the dependencies, run `npm install`.
+3. Start the project, run `npm start`.
+4. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
+5. Modify the code to fix the bug or to add the feature. All changes should happen in the relevant `src/` files.
+6. Verify that your fix or feature works.
+7. Run the test cases by running `npm test`, you can also add more test cases based on your new change.
+8. Build the code by running `npm run build`.
+9. Commit your changes with an informative description.
+10. Open a pull request with a descriptive message about what the PR does.
+
+Thank you for your contribution!
+
+##### Notes for pull request
+- Follow the same code style as the library.
+- Run the test suites in the `test` directory first by running `npm test`.
+- Don't modify any files in the `dist` directory.
+- Don't alter the licence headers.  
 
 ## Reporting bugs
-### Make sure it is a bug related to this project
+#### Make sure it is a bug related to this project
 Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.
 
-### Try the latest version
-Bugs in the older versions of the project may have already been fixed. 
-In order to avoid reporting known issues, make sure you are always testing against the latest release. 
-Also make sure the problem hasn't already been reported on the GitHub Issues Tracker. 
+#### Try the latest version
+Bugs in the older versions of the project may have already been fixed.
+In order to avoid reporting known issues, make sure you are always testing against the latest release.
+Also make sure the problem hasn't already been reported on the GitHub Issues Tracker.
 If not, create a new issue there and include your test case.
-
-### Notes for pull request
-- Follow the same code style as the library.
-- Run the test suites in the `test` directory first by running `npm test` or `gulp test`.
-- Don't modify any files in the `dist` directory.
-- Don't alter the licence headers.

LICENSE

@@ -1,22 +1 @@
-MIT License
-
-Copyright (c) 2017 Dipu Raj
-http://dipuraj.me
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+LICENSE

README.md

@@ -1,10 +1,10 @@
-# jQuery Gulp Plugin Example
-#### The example repository for the article [jQuery plugin development with Gulp automation](https://medium.com/@dipuraj/jquery-plugin-development-with-gulp-automation-ae5d2c180f85)
+# jQuery Plugin Boilerplate
+#### jQuery plugin development boilerplate with gulp automation
 
-[![Build Status](https://travis-ci.org/techlab/jquery-gulp-example.svg?branch=master)](https://travis-ci.org/techlab/jquery-gulp-example)
-[![npm version](https://badge.fury.io/js/jquery-gulp-example.svg)](https://badge.fury.io/js/jquery-gulp-example)
-[![Bower version](https://badge.fury.io/bo/jquery-gulp-example.svg)](https://badge.fury.io/bo/jquery-gulp-example)
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/techlab/jquery-gulp-example/master/LICENSE)
+[![Build Status](https://travis-ci.org/techlab/jquery-plugin-boilerplate.svg?branch=master)](https://travis-ci.org/techlab/jquery-plugin-boilerplate)
+[![npm version](https://badge.fury.io/js/jquery-plugin-boilerplate.svg)](https://badge.fury.io/js/jquery-plugin-boilerplate)
+[![Bower version](https://badge.fury.io/bo/jquery-plugin-boilerplate.svg)](https://badge.fury.io/bo/jquery-plugin-boilerplate)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/techlab/jquery-plugin-boilerplate/master/LICENSE)
 [![Donate on Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj)
 
 Articles
@@ -15,27 +15,39 @@ Requirements
 -----
   + [jQuery](http://jquery.com/) (supports jQuery 1.9+, jQuery 2+ and jQuery 3+)
 
-Installation and usage 
+Installation and usage
 -----
 
-### [NPM](https://www.npmjs.com/package/jquery-gulp-example)
-    npm install jquery-gulp-example
-    
-### Bower
-    bower install jquery-gulp-example
-    
+### NPM
+    npm install jquery-plugin-boilerplate
+
+### Yarn
+    yarn add jquery-plugin-boilerplate
+
 ### Download
-#### [Download from GitHub](https://github.com/techlab/jquery-gulp-example/archive/master.zip)    
+#### [Download from GitHub](https://github.com/techlab/jquery-plugin-boilerplate/archive/master.zip)    
 
+How to use
+----
+- Clone or download this repository.
+- Run `npm start` on the directory.
+- It will open the project on browser with hot loading enbaled with [Browserify](http://browserify.org/).
+- Start wrting your code on `src` directory.
+
+More details
+----
+- Build files will be generated on `dist` directory automatically.
+- You can change `example` directory for examples of your plugin.
+- `test` directory contains test scripts. It uses [Jasmine](https://jasmine.github.io/) and [Karma](https://karma-runner.github.io/).
 
 License
 ----
-[MIT License](https://github.com/techlab/jquery-gulp-example/blob/master/LICENSE)
+[MIT License](https://github.com/techlab/jquery-plugin-boilerplate/blob/master/LICENSE)
 
 Contribute
 ----
 If you like the project please support with your contribution.
 
 [Donate on Paypal](https://www.paypal.me/dipuraj)
 
-Thank you :)
+Thank you and Happy Coding :)

bower.json

@@ -0,0 +1,18 @@
+/*!
+  * jQuery Plugin Boilerplate v1.0,0
+  *
+  * Created by <Author>
+  *
+  * @license
+  */
+.my-style1 {
+    background-color: green;
+    color: #fff;
+    padding: 10px;
+}
+
+.my-style2 {
+    background-color: red;
+    color: #000;
+    padding: 10px;
+}

dist/css/alter_me.css

@@ -0,0 +1,7 @@
+/*!
+  * jQuery Plugin Boilerplate v1.0,0
+  *
+  * Created by <Author>
+  *
+  * @license
+  */.my-style1{background-color:green;color:#fff;padding:10px}.my-style2{background-color:red;color:#000;padding:10px}

dist/css/alter_me.min.css

@@ -0,0 +1,107 @@
+"use strict";
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+/*!
+ * TODO: PLUGIN DETAILS - CHANGE TO YOUR OWN
+ * jQuery Plugin Boilerplate v1.0,0
+ *
+ * Created by <Author>
+ *
+ * @license
+ */
+// SEARCH FOR "TODO:" TO MAKE THE CHANGES
+(function (factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['jquery'], factory);
+  } else if ((typeof module === "undefined" ? "undefined" : _typeof(module)) === 'object' && module.exports) {
+    // Node/CommonJS
+    module.exports = function (root, jQuery) {
+      if (jQuery === undefined) {
+        // require('jQuery') returns a factory that requires window to
+        // build a jQuery instance, we normalize how we use modules
+        // that require this pattern but the window provided is a noop
+        // if it's defined (how jquery works)
+        if (typeof window !== 'undefined') {
+          jQuery = require('jquery');
+        } else {
+          jQuery = require('jquery')(root);
+        }
+      }
+
+      factory(jQuery);
+      return jQuery;
+    };
+  } else {
+    // Browser globals
+    factory(jQuery);
+  }
+})(function ($) {
+  "use strict"; // Default Options
+
+  var defaults = {
+    // TODO: ADD YOUR DEFAULT OPTIONS HERE
+    myStyle: 'my-style1'
+  }; // TODO: PLUGIN CLASS NAME - CHANGE TO YOUR OWN. Use CapitolCase
+
+  var PluginBoilerplate = /*#__PURE__*/function () {
+    function PluginBoilerplate(element, options) {
+      _classCallCheck(this, PluginBoilerplate);
+
+      // Merge user settings with default
+      this.options = $.extend(true, {}, defaults, options); // Main container element
+
+      this.main = $(element); // Initial load
+
+      this._init();
+    } // Initial Method
+
+
+    _createClass(PluginBoilerplate, [{
+      key: "_init",
+      value: function _init() {
+        // Plugin init and logic
+        this.main.addClass(this.options.myStyle);
+      } // TODO: YOU CAN ADD MORE FUNCTIONS FOR YOUR PLUGIN HERE
+
+    }]);
+
+    return PluginBoilerplate;
+  }(); // Wrapper for the plugin
+  // TODO: PLUGIN NAME - CHANGE TO YOUR OWN. Use camelCase
+
+
+  $.fn.pluginBoilerplate = function (options) {
+    // TODO: PLUGIN NAME - CHANGE TO YOUR OWN
+    var pluginName = "pluginBoilerplate";
+
+    if (options === undefined || _typeof(options) === 'object') {
+      return this.each(function () {
+        if (!$.data(this, pluginName)) {
+          // TODO: PLUGIN CLASS NAME - CHANGE TO YOUR OWN. Use CapitolCase
+          $.data(this, pluginName, new PluginBoilerplate(this, options));
+        }
+      });
+    } else if (typeof options === 'string' && options[0] !== '_' && options !== 'init') {
+      var instance = $.data(this[0], pluginName);
+
+      if (options === 'destroy') {
+        $.data(this, pluginName, null);
+      } // TODO: PLUGIN CLASS NAME - CHANGE TO YOUR OWN. Use CapitolCase
+
+
+      if (instance instanceof PluginBoilerplate && typeof instance[options] === 'function') {
+        return instance[options].apply(instance, Array.prototype.slice.call(arguments, 1));
+      } else {
+        return this;
+      }
+    }
+  };
+});