После двух прошлых статей мы имеем git репозиторий расположенный на github.com. Этого почти достаточно, чтобы плагин появился на plugins.jquery.com. Нам не хватает лишь манифест файла.
Манифест jQuery - это json файл с информацией о вашем плагине. По ссылке вы найдете описание всех доступных полей. Однако нам пригодятся не все. Обязательными являются следующие поля
- name - название плагина
- version - версия плагина ( очень важное поле)
- title - короткое название плагина на человеческом языке
- author - имя, mail, ссылка на сайт автора
- licenses - лицензия по которой вы распространяете свой плагин (опять она, говорили ведь - это важно)
- dependencies - какую версию jquery требует для работы ваш плагин
Помимо этих полей, есть еще опциональные. Из низ наиболее важные
- homepage - ссылка на официальную страницу плагина ( то ради чего весь сыр бор)
- download - ссылка на zip архив репозитория
- demo - очень рекомендую сделать демо вашего плагина. Люди с охотой воспользуются им, если сразу увидят каков он в работе
- keywords - теги, по которым плагин будет доступен. Ограничений нет, поэтому вставляйте сюда как можно больше слов, характеризующих ваш плагин.
- description - описание плагина. Тоже важно, ведь никто не будет использовать плагин не зная для чего он нужен
Приведу пример моего datetimepicker'а. Полный листинг можете найти тут
{
"name": "datetimepicker",
"version": "2.3.2",
"title": "jQuery Date and Time picker",
"description": "jQuery plugin for date, time, or datetime manipulation in form",
"keywords": [
"calendar",
"date",
"time",
"form",
"datetime",
"datepicker",
"timepicker",
"datetimepicker",
"validation",
"ui",
"scroller",
"picker",
"i18n",
"input",
"jquery",
"touch"
],
"author": {
"name": "Chupurnov Valeriy",
"email": "chupurnov@gmail.com",
"url": "http://xdsoft.net/contacts.html"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/xdan/datetimepicker/blob/master/MIT-LICENSE.txt"
}
],
"homepage": "http://xdsoft.net/jqplugins/datetimepicker/",
"download": "https://github.com/xdan/datetimepicker/archive/master.zip",
"dependencies": {
"jquery": ">=1.7"
}
}
После того, как вы создадите свой манифест файл проверьте его валидность. На это странице вы можете проверить свой файл. Если хорошо, то вы увидите соответствующее сообщение
Плагин практически готов. Осталось совсем чуть чуть. В следующей статье серии, мы опубликуем наш плагин на plugins.jquery.com
Во многом файл манифест похож на 1с лицензию. Он полностью описывает ваш плагин со всех сторон. Объясняет пользователям, как его использовать и на каких условиях. Также, как это делает лицензия.
