CLI for creating ready-to-start modern jQuery Plugins
The command will walk you through a few simple prompts and creates a ready-to-start local development setup for your new jQuery plugin.
Or, fast track with default settings, just pass your plugin name.
npx create-jquery-plugin jquery-my-plugin
This will create a directory with the your plugin name and with all the tools installed.
How to start the development
To start the development process,
cd to your new plugin directory and run
npm start or
For example, if your new plugin is "jquery-my-plugin", just run
cd jquery-my-pluginnpm start
It will open the
example/index.html file with Browserify sync. You can start coding on the directory
src, the example page will hot load as you make changes.
- Easy-to-use CLI.
- CSS and SCSS templates.
- Creates ready-to-start local development environment.
- Unit testing with Jasmine and Karma.
The project boilerplate is from https://github.com/techlab/jquery-plugin-boilerplate
jquery-my-plugin ├── examples │ └── index.html ├── node_modules ├── src │ ├── js │ │ └── jquery-plugin-boilerplate.js │ └── scss │ └── jquery-plugin-boilerplate.scss ├── test │ ├── test-template.html │ └── test.js ├── .gitignore ├── .npmignore ├── CONTRIBUTING.md ├── gulpfile.js ├── karma.conf.js ├── LICENSE ├── package.json └── README.md
Please find more detailed instructions and documentation here.
Grateful to the authors and contributers of create-react-library and create-react-app from which this project is inspired. Thankful to the jquery-plugin-boilerplate for providing the project templates. Also, thanks to the authors and contributors of the amazing Node.js tools used in this project.
Open source software licensed as MIT
If you like the project please support with your contribution.
Thank you and Happy Coding :)