jQuery Plugin Registry

written by devangelist on Januar 17, 2013 in API and Git and Javascript and jQuery with 7 comments

Ein repository für jQuery gab es bereits vor einiger Zeit. Jetzt wurde das neue jQuery Plugin Registry vorgestellt – eine definitiv einfache und übersichtliche Variante, die bei der mittlerweile riesigen Menge an Plugins sehr willkommen ist.

Auch das Veröffentlichen der Plugins wurde um einiges verbessert, denn dies funktioniert nun mit direkter Git Integration, was heißen soll, dass ein öffentliches Repository auf Github für das Plugin verwendet werden kann.

Um ein Plugin zu Veröffentlichen sind folgende drei Schritte notwendig:

1) Ein Post-Receive Hook bei Github einrichten

Dafür einfach im Github-Projekt unter Settings den Reiter Service Hooks wählen und unter Webhook URLs folgende Adresse hinzufügen:

http://plugins.jquery.com/postreceive-hook

Dieser Hook ist dafür zuständig, bei einem Push eines neuen Tags die Anwendung an der eingetragenen URL zu benachrichtigen. Der Tag muss der semver-Spezifikation entsprechen.

2) Eine Manifest-Datei zum Projekt hinzufügen

Das jQuery Plugin Registry wird im Root Verzeichnis nach einer <PluginName>.jquery.json Datei suchen und falls vorhanden wichtige Informationen für das Plugin übernehmen. In der Dokumentation kann nachgelesen werden, welche Informationen in der Manifest-Datei angegeben werden können. Ein Beispiel für das Twitterwall-Plugin sieht wie folgt aus:

{
  "name": "twitterwall",
  "title": "jQuery Twitterwall",
  "description": "A twitterwall for jQuery.",
  "keywords": [
    "jquery",
    "ui",
    "twitter",
    "twitterwall",
    "api",
    "plugins"
  ],
  "version": "1.0.4",
  "author": {
    "name": "Roberto Bez",
    "url": "http://devangelist.de"
  },
  "maintainers": [
    {
      "name": "Roberto Bez",
      "email": "<email>",
      "url": "http://devangelist.de"
    }
  ],
  "licenses": [
    {
      "type": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    }
  ],
  "bugs": "https://github.com/robbz/twitterwalljs/issues",
  "homepage": "https://github.com/robbz/twitterwalljs",
  "docs": "https://github.com/robbz/twitterwalljs#readme",
  "download": "https://github.com/robbz/twitterwalljs/archive/master.zip",
  "dependencies": {
    "jquery": ">=1.4"
  }
}

3) Eine Version veröffentlichen

Wenn das post-Hook erfolgreich eingerichtet und die Manifest-Datei dem Projekt hinzugefügt wurde, wird die jQuery-Plugin-Seite bei Push eines neuen Tags benachrichtigt.

$ git tag 1.0.0
$ git push origin --tags

That’s it!

Hinweis: Es kann ein paar Minuten dauern bis das Plugin auf der Seite angezeigt wird.

jQuery Plugin Registry: 1 Stern2 Sterne3 Sterne4 Sterne5 Sterne 4,67 von 5 Punkte, 3 abgegebene Stimmen.
Loading ... Loading ...

About the Author

Roberto Bez ist passionierter Webentwickler und TechLead bei der HolidayCheck AG. Für Roberto bedeutet das Entwickeln nicht nur Arbeit, sondern auch Freude, Motivation und täglich neue, aufregende Herausforderungen. Besonders gerne setzt er sich mit neuen Webtechnologien sowie Datenbanken aller Art auseinander und versucht diese in die tägliche Anwendungsentwicklung miteinzubringen. Neben dem Entwickeln trifft man ihn gerne Abends beim Laufen oder im Sommer bei Mountainbike-Touren durch die schönen Berge Südtirols.