Schlagwort-Archive: Sublime Text

Grunt – Projektorganisation mit JavaScript

Mein Script für die Skillmatrix hat inzwischen schon über 40 Zeilen Code und eine Abhängigkeit zu jQuery. Es kommt wahrscheinlich aus meiner Vergangenheit als Java-Entwickler aber ich werde den Drang nicht los, die beiden Dateien in eine sinnvolle Projektstruktur betten zu wollen. Dazu gehört die Organisation des Quellcodes ein Build-Prozess, Stylechecks mit JSHint und am liebsten auch ein Bisschen Testing.

Bei der Suche nach der Befriedigung dieser Bedürfnisse bin ich recht schnell bei Grunt gelandet. Bei dem Vortrag „Let Grunt do the work, focus on the fun!, von Dirk Ginader auf Slideshare stieß ich dann auf folgende Folie die mich vollends überzeugte:

slide-infrastructure

Grunt ist ein TaskRunner für JavaScript und erinnert im ersten Augenblick an Ant, dann an Maven und schließlich an Gradle. Es vereint also die Möglichkeit seinen Buildvorgang in Tasks abzubilden, die benötigten Resourcen und Tools automatisch zusammenzustellen und die Buildumgebung per Scripting einfach auf die gewünschte Projektstruktur abzubilden. Scriptsprache ist hier selbstverständlich JavaScript.

grunt-logo

Die Installation erfolgt über den PackageManager von NodeJs mit Hilfe einer einzigen Zeile:

npm install -g grunt-cli

Hiermit steht eine Art Laufzeitumgebung zur Verfügung. Der eigentliche TaskRunner wird dann pro Projekt aufgesetzt. Somit werden mehrere Projekte mit unterschiedlichen Grunt-Versionen ermöglicht. Die Definition oder Konfiguration des Projekts erfolgt in zwei Dateien, die im Quellverzeichnis liegen:

  1. package.json Die Datei,beschreibt das Projekt und dessen Abhängigkeiten . Hier stehen beispielsweise Name, Versionsnummer, die verwendete Grunt-Version oder Autor und Lizenz. Die Dateien können per grunt-init bzw. npm-init automatisch erzeugt werden.
  2. Gruntfile.js Ein JavaScript, das die Tasks definiert und konfiguriert. Hier wird beschrieben welche Tasks für den Buildprozess überhaupt zur Verfügung gestellt werden und wo die Tasks, (z.B. JSHint) die benötigten Quelldateien finden. Innerhalb der Gruntfile.js kann man auf Attribute der package.json zugreifen um beispielsweise Verzeichnis- oder Dateinamen aus dem Projektnamen oder der Versionsnummer abzuleiten.

Anleitungen zur Konfiguration der Dateien findet man im Getting Started Guide von Grunt. Am Beispiel der Skillmatrix wird der Aufbau der package.json deutlich:

{
  "name": "skillmatrix",
  "version": "0.0.1",
  "devDependencies": {
    "grunt": "~0.4.4",
    "grunt-contrib-jshint": "~0.6.3",
    "grunt-contrib-nodeunit": "~0.2.0",
    "grunt-contrib-uglify": "~0.2.2"
  },
  "description": "A webclient for the skillmatrix.",
  "main": "Gruntfile.js",
  "dependencies": {
    "grunt": "~0.4.4"
   },
  "author": "Matthias Strolz"
}

Nachdem Projekt und Abhängigkeiten in der package.json definiert wurden, kann man die benötigten Plugins über den NodeJS Packagemanager in sein Projekt importieren:

npm install

Die Dateien werden dann im Verzeichnis node_modules innerhalb des Projekts abgelegt.

In einem meiner letzten Posts habe ich die Funktionsweise des Stylecheckers JSHint beschrieben. Die Konfiguration, die ich dort für mein Projekt in Sublime angelegt habe, möchte ich gerne auch beim bauen mit Grunt verwenden. Dazu setze ich die option jshint: true in der Konfiguration des Tasks jshint. Die Tasks uglify, oder concat zum Zusammenführen und Minimieren der einzelnen Quelldateien, habe ich aus folgendem Beispiel entfernt.

module.exports = function (grunt) {
  "use strict";
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),
...
    jshint: {
    // define the files to lint
    files: ['Gruntfile.js', 'src/<%= pkg.name %>/*.js'],
    options: {
      jshintrc : true
    }
  },
...
  grunt.loadNpmTasks('grunt-contrib-jshint');
...
  grunt.registerTask('test', ['jshint']);
};

Inzwischen habe ich eine projektartige Struktur. Mein Quellcode liegt im Verzeichnis src/skillmatrix. Es gibt einen Build Prozess, der automatische Stylechecks durchführt, meine Dateien zusammenführt und minimiert. Fehlen eigentlich nur noch automatisierte Tests. Selbstverständlich gibt es auch hierfür Grunt-Tasks.

Der Preis für diese Struktur sind die Konfigurationsdateien package.json, Gruntfile.js und .jshintrc sowie die Grunt-Module die ebenfalls innerhalb des Projektverzeichnisses abgelegt werden.

JSHint und JSLint – JavaScript Codequality

Bei meinen ersten eigenen JavaScript Gehversuchen mit der Skillmatrix muss ich feststellen wie sehr sich das Entwickeln von JavaScript und Java unterscheidet. Die starre Typisierung und Java ermöglicht ein recht komfortables Refactoring, das somit toolgetützter Teil des Entwicklungsprozesses werden kann. Bei JavaScript scheint mir das schon ein wenig schwerer. In Eclipse kann das Ausmaß dieser Schwierigkeiten an dem Unterschied der Einträge im Refactoring-Contextmenü des JavaScript Editors gemessen werden.

jslint

Bei der Suche nach der Lösung dieses Problems stößt man innerhalb kürzester Zeit auf JSLint oder, wenn es etwas stylisher aussehen darf, auf den Doppelgänger JSHint. Hierbei handelt es sich weniger um eine IDE oder ein Refactoring-Tool, sondern um eine Art Stylecheck für JavaScript-Quellcode. JSLint testet die etablierten Codeconventions. Im einfachsten Fall kann man sein Skript einfach via Copy und Paste in das Online-Formular kopieren und auf unterschiedlichste Fehler prüfen lassen. Die Spannbreite reicht von vergessenen Leerzeichen und Kommas über Variablen, die nicht verwendet werden oder sich im Falschen Scope befinden bis hin zu missverständlichen Verzweigungen oder unerwünschten Notationen.

jshint

Somit hilft JSLint nicht direkt beim Entwickeln des Codes, meckert aber wenn das Ergebnis nicht ganz optimal ist. Schön wäre es, wenn diese Prüfung regelmäßig schon während der Entwicklung gemacht wird. Geht das? Klar geht das. Bei der Suche nach dem passenden Eclipse-Plugin wird man bei jshint-eclipse fündig. Wie erwartet wird man sofort nach der Installation in der gewohnten Strenge auf mögliche Probleme in seinem Script hingewiesen. Die Art der Prüfungen kann man über das Menü (Windows > Preferences > JSHint > Configuration) entsprechend er JSHint Options leicht anpassen.

An dieser Stelle möchte ich gestehen, dass die Codebeispiele aus der Skillmatrix bereits mehrere JSLint-Durchläufe hinter sich haben. Wie viele Punkte JSLint gefunden hat, bleibt aber mein Geheimnis.

Ich bin mir trotzdem noch nicht ganz sicher ob ich bei der Entwicklung von JavaScript bei Eclipse bleibe oder auf einen Texteditor umsteige. Deshalb probiere ich von Anfang an auch leichtgewichtigere Alternativen wie Sublime aus. Eine Anleitung zur Integration von JSHint in Sublime findet man im Blog von Exratione.

Die Refactoring Tools von Eclipse aus der Java-Welt vermisse ich immer noch. Ich kann mir vorstellen, dass diese Sehnsucht verstärkt wird, wenn sich die Skripte über mehrer Dateien und Verzeichnisse erstrecken. Trotzdem beruhigt JSLint bzw. JSHint, da so Codequalitäts-Standards gesichert werden können, die über einfache Syntaxchecks hinausgehen. Hier hilft wahrscheinlich eine Art Continious Integration Produkt auf JavaScript-Ebene. Aber das ist ein Thema für einen anderen Post.