HTML5-Tutorium: JavaScript: Hello World 04

2016-10-14T11:34:28Z

Rosaresa: /* Node.js */

{{HTML5-Tutorium:JavaScript:HelloWorld:Menü}}
'''Musterlösung''': [https://glossar.hs-augsburg.de/beispiel/tutorium/es5/hello_world/WK_HelloWorld04/index.html <code>index.html</code>]
([https://glossar.hs-augsburg.de/beispiel/tutorium/es5/hello_world/WK_HelloWorld04/ SVN-Repository])
==Anwendungsfälle (Use Cases)==
Gegenüber dem [[HTML5-Tutorium:_JavaScript:_Hello_World_03|dritten Teil des Tutoriums]]
ändern sich die die Anwendungsfälle nicht. Die Anwendung leistet also genau dasselbe wie zuvor.

In diesem Teil des Tutoriums geht es darum, die Anwendung zu verbessern, so dass sie schneller ausgeliefert werden kann.
Außerdem wird die Entwicklungsarbeit mit Hilfe von Automatisierungstools erleichtert.

==Erstellen eines neuen Projektes==

Erstellen Sie ein neues Projekt „<code>HelloWorld04</code>“ und legen Sie dieses in Ihrem Repository ab.
Kopieren Sie anschließend alle Dateien aus dem dritten Teil des Tutoriums, passen Sie den Titel in der HTML-Datei an und committen Sie abermals.

==Erstellen einer Ordnerstruktur==

Grundsätzlich gilt auch bei der Programmierung: Ordnung ist das halbe Leben.

Web-Anwendungen werden sehr schnell sehr groß. Also sollte man sich eine geeignete Ordnerstruktur überlegen.
Üblicherweise legt man CSS-Dateien in einen Ordner namens „<code>css</code>“ und JavaScript-Dateien in einen Ordner namens
„<code>js</code>“ oder „<code>lib</code>“. Sollten es viele CSS- und/oder JavaScript-Dateien werden,
legt man im entsprechenden Ordner geeignete Unterordner an.

Legen Sie im Root-Verzeichnis Ihres Projektes folgende Ordner an:
* <code>web</code>: Der Inhalt dieses Ordners kommt später auf einen echten Web-Server.
* <code>src</code>: Dieser Ordner enthält die unkomprimierten CSS- und JavaScript-Dateien.
* <code>doc</code>: Dieser Ordner enthält die Projektdokumentation.
* <code>conf</code>: Dieser Ordner enthält Projektkonfigurationsdateien mit Ausnahme zweier zentraler Node.js-Dateien.
Legen Sie innerhalb der Ordner „<code>web</code>“ und „<code>src</code>“ jeweils zwei weitere Ordner an: „<code>css</code>“ sowie „<code>js</code>“ .

Öffnen Sie im Editorbereich die Datei „<code>index.html</code>“ und verschieben sie in den Ordner „<code>src</code>“.
Verschieben sie anschließend die Dateien „<code>main.css</code>“ und „<code>main.js</code>“
in die passenden Ordner „<code>src/css</code>“ bzw. „<code>src/js</code>“. Sie werden feststellen, dass die Verweise in den Link- und Script-Elementen der
Datei „<code>index.html</code>“ automatisch angepasst werden. Verschieben Sie nun die Datei „<code>index.html</code>“ in den Ordner „<code>web</code>“.

Das Ergebnis dieser Aktion ist, dass Ihre Web-Anwendung nicht mehr im Root-Verzeichnis des Projektes liegt, sondern (sauber strukturiert) in zwei Unterordnern.
Daher ist es möglich, im Root-Verzeichnis des Projektes weitere projektspezifische Ordner und Dateien anzulegen wie „<code>conf</code>“ und „<code>doc</code>“,
die später nicht auf den Web-Server, auf dem die Anwendung schließlich laufen soll, kopiert werden. Auch der Ordner „<code>src</code>“ existiert nur
in der Entwicklungsumgebung, lediglich der Inhalt des Web-Ordners ist für den Liveserver bestimmt.

==Laden der CSS- und der JavaScript-Dateien==

Eine Web-Anwendung funktioniert nur – wie Sie bereits erfahren haben –, wenn nicht nur die HTML-Datei, sondern auch die zugehörigen
CSS- und JavaScript-Dateien geladen werden. Allerdings gibt es dabei ein Problem: Die CSS- und JavaScript-Dateien werden im Laufe der
Zeit immer zahlreicher und/oder größer. Diese Dateien zu laden, dauert seine Zeit.

In der aktuellen Version der Web-Anwendung stehen diese Verweise auf diese Dateien im <code>head</code>-Bereich des Dokuments.
Dieser wird vollständig geladen, bevor der <code>body</code>-Bereich eingelesen wird. Das heißt aber, dass der Browser keine Inhalte des HTML-Dokuments
darstellen kann, solange er die JavaScript- und CSS-Dateien lädt. Wenn dies zu lange dauert, verliert der Besucher die Geduld und verlässt die Seite
vorzeitig.

Besser wäre es daher andersherum vorzugehen: Es wird zuerst der <code>body</code>-Bereich geladen und dann die JavaScript- und die CSS-Dateien.
Im Falle von JavaScript ist das durchaus sinnvoll, aber im Falle von CSS hat das den Effekt, dass der Browser keine Layout-Vorgaben erhalten hat,
wenn er mit dem [[Rendern]] der Seite beginnt. Also verwendet er die browserspezifischen Defaultwerte. Das heißt, die Seite sieht zunächst
ganz anders aus, als vom Designer geplant. Wenn dann die CSS-Dateien geladen wurden, wird die Seite erneut gerendert und verändert ihr Aussehen.
Auch das ist verwirrend und wirkt unprofessionell.

Was also machen?

===CSS-Dateien===
Für CSS-Dateien empfiehlt Google ernsthaft, die Link-Element ganz ans Ende der HTML-Datei zu stellen, also '''nach''' dem
schließenden <code>html</code>-Tag.
Damit das Problem mit dem falschen Layout nicht auftritt, sollen wichtige CSS-Befehle direkt – {{dh}} als CSS-Befehle innerhalb eines
<code>style</code>-Elements – in die HTML-Datei eingefügt
werden.<ref>{{Quelle|Google (Web)}}, Kapitel „CSS-Bereitstellung optimieren“, https://developers.google.com/speed/docs/insights/OptimizeCSSDelivery</ref>

Von beiden Vorschlägen rate ich dringend ab. Der erste Vorschlag ist nicht [[HTML]]-konform, ja noch nicht einmal [[SGML]]-konform. Es mag sein,
dass diverse Browser diese Syntax verstehen, korrekt ist sie trotzdem nicht. Der zweite Vorschlag hat zur Folge, dass Struktur (HTML) und Layout (CSS)
vermischt werden. Dies war einer der Kardinalfehler von frühen HTML-Versionen aus der Zeit, bevor es das CSS-Format gab. '''Tun Sie das nicht.'''

Gehen Sie so vor, wie es unter [[Multimedia-Programmierung: Best Practices#CSS|Multimedia-Programmierung: Best Practices]] beschrieben ist.

In unserer Anwendung haben wir bislang alles richtig gemacht, bis auf die fehlende automatische Komprimierung.
Diese wird weiter unten beschrieben.

===JavaScript-Dateien===

Für JavaScript-Dateien empfiehlt Google ebenfalls, diese nicht schon zu Beginn zu laden.<ref>{{Quelle|Google (Web)}}, Kapitel „CSS-Bereitstellung optimieren“, https://developers.google.com/speed/docs/insights/BlockingJS</ref> Dieser Vorschlag ist sehr sinnvoll.

Entfernen Sie das <code>script</code>-Element aus dem HTML-Header-Bereich und fügen Sie es vor dem schließenden <code>body</code>-Tag ein:

<source lang="html5">
...
<script type="text/javascript" src="../src/js/main.js"></script>
</body>
</source>

===Node.js===

Dieses Tutorium befasst sich zwar nicht mit der Erstellung von Node.js-Anwendungen, aber trotzdem benötigen wir
Node, da für die Komprimierung von Dateien und das automatische Erstellen von JavaScript-Dokumentationen
derartige Anwendungen zum Einsatz kommen.

Installieren Sie zunächst Node.js: <code>https://nodejs.org/en/</code>, Version 6.x. Diverse Versionen finden Sie unter https://nodejs.org/en/download/.
Achten Sie darauf, dass die Option „<code>Add to PATH</code>“ ausgewählt wurde.

Starten Sie WebStorm neu und öffnen Sie das Terminal, um zu testen, ob <code>node</code> funktioniert:

* Klick auf Icon in der linken unteren Ecke → <code>Terminal</code>
* Geben Sie Folgendes ins Terminal ein: <code>node --version</code>

Wenn Node.js korrekt installiert und der Pfad mit den <code>node</code>-Binaries in die Systemvariable <code>PATH</code> eingetragen wurde,
sollte die Versionsnummer von <code>node</code> ausgegeben werden.

Sie werden feststellen, das Node.js zum Großteil über Konsolbefehle gesteuert wird.
Zu Beginn mag das für eingefleischte [[Klickibunti]]-Fans ungewohnt sein, aber Sie werden sich schnell daran gewöhnen.

'''Tipp'''<br/>
Profis verwenden unter Windows lieber ein Terminal, dass eine [[Unix]]-[[Shell]] simuliert.
(Unter Linux und Mac OS X ist das nicht notwendig. Dort läuft sowieso schon eine UNIX-Shell.)

Installieren Sie „Git for Windows“ (https://git-for-windows.github.io/). In diesem Paket ist die „Git BASH“ enthalten.
Das ist eine Terminal-Anwendung, die eine Linux-Bash emuliert und zahlreiche nützliche Befehle wie „<code>which</code>“, „<code>[[vi]]</code>“ ( :-) ) etc. zur
Verfügung stellt.

Erstellen Sie im Wurzel-Verzeichnis Ihres Projektes einen Ordner namens „<code>node-modules</code>“.
Wenn die Frage „''Do you want to schedule the following directory for addition tu Subversion?''“
aufpoppt, antworten Sie unbedingt mit '''„<code>No</code>“''', anderenfalls werden Hunderte von Node.js-Dateien ins Repository geschrieben,
obwohl das überflüssig ist und '''sehr viel''' Zeit in Anspruch nimmt.
Anschließend führen Sie folgende Befehle aus:

* Rechtsklick auf den neu erstellten Ordner → <code>Subversion</code> → <code>Ignore</code> → <code>node-modules</code>

Öffnen Sie nun ein beliebiges Terminal (WebStorm-Terminal, Git Bash, Mac-OS-X-Terminal ...)
und geben Sie folgenden Befehl ein (npm = node package manager, https://www.npmjs.com/)

<source lang="bash">
npm install -g bower grunt-cli jsdoc ink-docstrap yuglify mincss coffee-script jshint
</source>

Damit werden die wichtigsten Node.js-Pakete ''global'' (Option „<code>-g</code>“) installiert, die wir im Folgenden noch benötigen, evtl. implizit.
Die globale Installation hat zur Folge, dass jedes Projekt auf diese Pakete zugreifen kann, Pakete also nicht mehrfach installiert werden.

* Rechtsklick im Dateibaum auf „<code>node-modules</code>“ → <code>Mark Directory as</code> → <code>excluded</code>
* Rechtsklick im Dateibaum auf „<code>doc</code>“ → <code>Mark Directory as</code> → <code>excluded</code>

Beide Ordner enthalten Dateien, die nicht von Ihnen stammen. Diese Dateien können Fehler und Hinweise enthalten,
veraltete (“deprecated”) Schnittstellen verwenden etc. (Oh ja, auch andere Programmierer machen Fehler. :-) )
Und wenn Sie diese beiden Ordner nicht als „<code>excluded markieren</code>“, prüft WebStorm bei jedem Commit die
darin enthaltenen Dateien und weist Sie auf jedes Problem hin. Das können so viele Probleme sein, dass Sie die
Probleme in Ihren eigenen Dateien vollkommen übersehen.

Nun müssen wir den Node-Paket-Manager „<code>npm</code>“ (https://docs.npmjs.com/) sowie Grunt (http://gruntjs.com/) initialisieren.
Grunt ist '''der''' “JavaScript Task Runner”, also ein Programm, das Aufgaben (''tasks'') wie {{zB}} das Komprimieren von Programmdateien
durchführt.

Die Initialisierung erfolgt durch die Bereitstellung von zwei Dateien „<code>package.json</code>“
und „<code>gruntfile.json</code>“ im Root-Verzeichnis der Web-Anwendung. Eine initiale Version der <code>package.json</code> könnten Sie theoretisch mit
<code>npm init</code> erstellen. Einfacher ist es jedoch, wenn Sie die beiden Dateien von Hand erstellen und folgenden Code einfügen:

'''<code>package.json</code>''' (https://docs.npmjs.com/files/package.json)
<source lang="bash">
{
"name": "hello_world_04",
"version": "1.0.0",
"description": "Hello World Tutorium",
"main": "gruntfile.js",
"directories": {
"doc": "./doc"
},
"dependencies": {},
"devDependencies": {
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "svn",
"url": "https://glossar.hs-augsburg.de/kowa/tutorium/es5/hello_world/WK_HelloWorld04"
},
"author": "Wolfgang Kowarschick",
"license": "CC-BY-NC-SA-4.0"
}
</source>

Anmerkung: Diese Datei wird durch <code>npm</code> automatisch erstellt und geändert. Daher ist das Layout (welches mir nicht gefällt) vorgegeben.

Hier sollten Sie natürlich nicht meinen Repositorypfad und meinen Namen einfügen, sondern jeweils Ihren. Sie können außerdem die
Lizenz anpassen (https://spdx.org/licenses/), unter die Sie Ihre Software stellen, wenn Sie das möchten.

Die meisten Attribute sind selbsterklärend. Wichtig sind für uns vor allem zwei Attribute: „<code>main</code>“ und
„<code>devDependencies</code>“. Das erste enthält den Namen der Konfigurationsdatei von Grunt. Diese fehlt noch. Also: Legen Sie sie an
(und vergessen Sie nicht, Ihren Namen anstelle meines Namens einzufügen):

'''<code>gruntfile.js</code>'''
<source lang="javascript">
/**
* @author Wolfgang Kowarschick <kowa@hs-augsburg.de>
* @see http://gruntjs.com/getting-started
*
* Created on 2016/09/28.
*/

module.exports = function(grunt)
{
// Project configuration.
grunt.initConfig
({
pkg: grunt.file.readJSON('package.json'),
});

// Load the plugin that provides the "uglify" task.

// Default task(s).
};
</source>

Diese Datei ist noch ziemlich leer, aber das wird sich ändern.

Vorausschauend sollten Sie eine überflüssige WebStorm-Fehlerprüfung deaktivieren, da anderenfalls künftige Versionen
Versionen der Datei „<code>gruntfile.js</code>“ jedes Mal eine Fehlermeldung zur Folge haben, wenn die
Datei ins SVN-Repository geschrieben werden soll:

* <code>File</code> bzw. <code>WebStorm</code> → <code>Settings</code> bzw. <code>Preferences</code> → <code>Editor</code> → <code>Inspections</code>
* <code>JavaScript</code> aufklappen → <code>General</code> aufklappen → <code>Unsued JavaScript / ActionScript global symbol</code> deselektieren
* <code>OK</code>

Spannender ist in der Datei „<code>package.json</code>“ das Attribut „<code>devDependencies</code>“ (dev = developer).
Diese enthält eine Liste von von NodeJS-Paketen, die für die Entwicklung der Web-Anwendung benötigt werden.
Fügen wir einmal das Paket „<code>ink-docstrap</code>“ in diese Liste ein.
(Diese Pakte wird nachfolgend für die Erstellung der JavaScript-Dokumentation mittels JSDoc verwendet. Es enthält ein Theme, welches deutlich schöner ist als das Standard-JSDoc-Theme.)

Führen Sie folgenden Befehl im WebStorm-Terminal (oder mittels eine beliebigen anderen Shell im Wurzelverzeichnis Ihrer Web-Anwendung) aus:

<source lang="bash">
npm install ink-docstrap --save-dev
</source>

Dies bewirkt zweierlei:

# Das Node.js-Paket „<code> ink-docstrap</code>“ sowie diverse weitere Node.js-Pakete, die diese Paket benötigt, werden einem Projektordner namens „<code>node_modules</code>“ abgelegt.
# Das Name und die Versionsnummer des Paketes werden in das Attribut „<code>devDependencies</code>“ in der Datei „<code>package.json</code>“ eingefügt (wegen der Option „<code>--save-dev</code>“).

Nun steht Ihnen der Befehl
<source lang="bash">
npm update
</source>
zur Verfügung. Mit diesem können Sie die lokal gespeicherte Versionen der im Attribut „<code>devDependencies</code>“ aufgeführte Node.js-Pakete
jederzeit auf die neueste Version aktualisieren. Sie können ein Paket auch löschen und dann mittels <code>npm update</code> (https://docs.npmjs.com/cli/update) wieder herstellen.
Versuchen Sie es:

<source lang="bash">
npm remove ink-docstrap
npm list
</source>

Jetzt ist der Ordner „<code>node_modules</code>“ wieder leer.

<source lang="bash">
npm update
npm list
</source>

Und jetzt enthält der wieder „<code>ink-docstrap</code>“ sowie andere dafür notwendige Pakete.

Sie können auch überprüfen, ob Sie in Ihrem Projekt irgendwelche veralteten Pakete benutzen (https://docs.npmjs.com/cli/outdated):
<source lang="bash">
npm outdated
</source>

Kein Ergebnis ist hier ein gutes Ergebnis!

Und natürlich funktioniert das Ganze auch für global gespeicherte Pakete:

<source lang="bash">
npm -g outdated
npm -g list
</source>

Allerdings muss man veraltete globale Pakete erneut installieren. Zum Beispiel muss <code>npm</code>
relativ häufig aktualisiert werden (sobald „<code>npm -g outdated</code>“ das Paket als veraltet meldet):

<source lang="bash">
npm install -g npm
</source>

==Automatische Generierung der Schnittstellenbeschreibung==

Installieren Sie zunächst JSDoc:

* Öffnen Sie das WebStorm-Terminal.
* <code>npm install -g jsdoc</code> (installiert JSDoc als Node.js-Anwendung; das haben Sie eigentlich schon gemacht, aber das macht nix :-) )
* <code>npm install ink-docstrap</code> (installiert ein JSDoc-Theme namens „<code>docstrap</code>“ ([https://docstrap.github.io/docstrap/]); das haben Sie auch schon gemacht, aber das macht auch nix.)

Übrigens: Es gibt auch noch andere Themes für JSDoc.

Erstellen Sie im Projektordner „<code>conf</code>“ eine JSON-Datei namens „<code>jsdoc.json</code>“.
Fügen Sie in diese Datei folgenden Code ein:

<source lang="javascript">
{
"tags":
{
"allowUnknownTags": true
},
"source":
{
"include": ["./src/js"],
"includePattern": ".+\\.js$",
"excludePattern": "doc"
},
"plugins":
[],
"templates":
{
"systemName": "WK_HelloWorld04",
"footer": "",
"copyright": "Copyright © 2016 by Wolfgang Kowarschick, License <a href=\"https://creativecommons.org/licenses/by-nc-sa/4.0/\">CC-BY-NC-SA-4.0</a>",",
"navType": "vertical",
"theme": "cerulean",
"linenums": true,
"cleverLinks": false,
"monospaceLinks": true,
"collapseSymbols": true,
"inverseNav": false
},
"opts":
{
"template": "node_modules/ink-docstrap/template",
"encoding": "utf8",
"destination": "doc/jsdoc",
"recurse": true,
"private": true
}
}
</source>

Ersetzen Sie im Attribut „<code>footer</code>“ meinen Namen durch Ihren, denn es ist Ihr Projekt, nicht meines. :-)

In dieser Datei wird festgelegt, wie die HTML-Dokumentation des Codes, die JSDoc erstellt, aussehen soll.
Insbesondere ist das Template angegeben, das zur Erstellung dieser HTML-Dokumente verwendet werden soll.
Es handelt sich um „<code>docstrap</code>“, welches wir zuvor heruntergeladen haben. Von der
Projektroot aus gesehen, befinden sich die Template-Dateien im Ordner
„<code>node_modules/ink-docstrap/template</code>“.

Weitere Konfigurationsparameter werden unter http://usejsdoc.org/about-configuring-jsdoc.html beschrieben.

Sie können nun eine Dokumentation für Ihr Projekt erstellen:

* Öffnen Sie das WebStorm-Terminal.
* <code>jsdoc -c conf/jsdoc.json</code>

Nach kurzer Zeit sollte der Ordner „<code>doc/jsdoc</code>“ erstellt und mit Inhalten gefüllt worden sein.
Sehen Sie sich die Datei „<code>doc/jsdoc/index.html</code>“ im Browser an. Diese enthält nicht viel,
außer einem Drop-Down-Menü „<code>global</code>“, in dem die drei von Ihnen erstellen globalen Funktionen
„<code>greet</code>“, „<code>greet_on_enter</code>“ und „<code>init</code>“ enthalten sind.
Klicken Sie auf eine dieser Funktionen.

===Globale Speicherung der JSDoc-Templates===

Wenn Sie „<code>ink-docstrap</code>“ nicht mittels
<source lang="bash">npm install ink-docstrap</source>
sondern global mittels
<source lang="bash">npm install -g ink-docstrap</source>
installieren (so wie Sie das auch schon bereits getan haben), werden die Template-Dateien nicht im Projektordner, sondern im globalen <code>npm</code>-Ordner abgelegt.
Das hat den Vorteil, dass Sie dieses Template für viele Projekte einsetzen können und es nicht bei jedem Projekt separat speichern müssen.
Der Nachteil ist, dass in der Datei „<code>conf/jsdoc.json</code>“ den absoluten Pfad des globalen Ordners angeben müssen.
Dieser Pfad sieht auf jedem Rechner anders aus. Bei mir lautet er beispielsweise:
<source lang="bash">c:/Users/kowa/AppData/Roaming/npm/node_modules/ink-docstrap/template</source>

Das heißt, wenn man im Team an einem Projekt arbeitet, müsste man für jedes Teammitglied eine eigene
JSDoc-Konfigurationsdatei anlegen, was nicht wirklich schön, aber doch machbar ist.

In der [https://glossar.hs-augsburg.de/beispiel/tutorium/es5/hello_world/WK_HelloWorld04/ Musterlösung] verwende ich die lokale Version „<code>docstrap</code>“
(es gibt allerdings auch eine Datei namens „<code>conf/jsdoc_wk.json</code>“, die speziell für meinen Rechner erstellt wurde).
Die lokale Version von „<code>docstrap</code>“ ist allerdings nicht im Repository enthalten. Nachdem Sie die Musterlösung auf Ihren Rechner kopiert haben
(vergessen, wie's geht? → [[HTML5-Tutorium:_JavaScript:_Hello_World_01#Projekte_aus_einem_Subversion-Repository_laden|HTML5-Tutorium: JavaScript: Hello World 04]]),
müssen Sie im WebStorm-Terminal der Musterlösung noch folgenden Befehl ausführe:

<source lang="bash">
npm update
</source>

Und schon sollten Sie die Dokumentation wie gewohnt erstellen können.

Sobald Sie „<code>grunt</code>“ konfiguriert haben, sollte „<code>conf/jsdoc.json</code>“ auch in Ihrem Projekt fehlende Node.js-PAkete nachinstallieren.

===Erstellung der JSDoc-Dokumentation mittels Klickibunti===

Falls Sie die Dokumentation nicht immer über das Terminal erstellen möchten, können Sie
in WebStorm einen neuen Menüeintrag erstellen, über den Sie die Erzeugung der HTML-Dokumentation starten können.

Sie müssen dazu den Pfad ermitteln, unter dem Ihre <code>jsdoc</code>-Datei zu finden ist.
Unter Unix (Mac OS X, Linux, FreeBSD ...) lautet der Befehl, den Sie in ein Terminal eingeben müssen:
<source lang="bash">
which jsdoc
</source>
Unter '''Windows''' funktioniert dieser Befehl nur in der '''Git BASH'''.
Außerdem müssen Sie unter Windows den Bash-Pfad modifizieren, damit auch Windows etwas damit anfangen kann.
Bei mir gibt dieser Befehl Folgendes aus:
<source lang="bash">
/c/Users/kowa/AppData/Roaming/npm/jsdoc
</source>
Um <code>jsdoc</code> in WebStorm aufrufen zu können, müssen Sie in diesem Pfad „<code>/c</code>“ durch
„<code>c:</code>“ und „<code>jsdoc</code>“ durch „<code>jsdoc.cmd</code>“ ersetzen.
(Mac-User brauchen nichts zu ändern. :-) )

Erstellen Sie nun den neuen WebStorm-Menü-Eintrag:

* <code>File</code> → <code>Settings</code> → <code>Tools</code> → <code>External Tools</code>
* Klick auf das Plus-Icon
** <code>Name</code>: <code>JSDoc</code>
** <code>Group</code>: <code>Documentation</code>
** <code>Description</code>: <code>Generates JavaScript documentation</code>
** Hacken bei allen Optionen (<code>Options</code>)
** Hacken bei allen Show-in-Optionen (<code>Show i</code>) mit Ausnahme von „<code>Search results</code>“
* <code>Name</code>: <code>c:/Users/kowa/AppData/Roaming/npm/jsdoc.cmd</code> (hier kommt Ihr zuvor ermittelter Pfad hinein)
* <code>Name</code>: <code>-c $ProjectFileDir$/conf/jsdoc.json</code>
* <code>Name</code>: <code>$ProjectFileDir$</code>
* <code>OK</code>
* <code>OK</code>

Nun finden Sie an mehreren Stellen in WebStorm einen neuens Menüpunkt <code>Documentation</code> mit einem Unterpunkt <code>JSDoc</code>:

* Hauptmenü : <code>Tools</code> → <code>Documentation</code> → <code>JSDoc</code>
* Rechtsklick auf Datei im Projekt-Dateibaum → <code>Documentation</code> → <code>JSDoc</code>
* Rechtsklick auf Datei im Editor-Tab-Menü → <code>Documentation</code> → <code>JSDoc</code>

Wenn Sie auf einen dieser Unterpunkte „<code>JSDoc</code>“ klicken, erhalten Sie entweder eine Fehlermeldung ( :-( ) oder es wird eine neue Dokumentation erstellt
({{dh}}, Sie haben alles richtig gemacht :-) ).

Um sicher zu gehen, können Sie versuchsweise den Ordner „<code>doc</code>“ gemeinsam mit seinem gesamten Inhalt löschen und
<code>JSDoc</code> nochmals aufrufen.

===Sicherung im Repository===

Bevor Sie weitermachen: Haben Sie Ihre aktuelle Version von <code>Hello World 04</code> schon im Repository gesichert?

Bevor Sie die Projekt-Dateien per ''Commit'' ins Repository übertragen, sollten Sie überprüfen,
dass der Ordner „<code>node_modules</code>“ auf der sogenannten „Ignore List“ steht (und damit nicht
ins Repository eingespielt wird):

* <code>Files</code> bzw. <code>WebStorm</code> → <code>Settings</code> bzw. <code>Preferences</code> → <code>Ignored Files</code>
* Wenn in dieser Liste der Ordner „<code>node_modules</code>“ nicht aufgeführt wird, fügen Sie ihn mittels des Plus-Icons ein.

Sie sollten allerdings den Ordner „<code>doc</code>“ zu Ihrem
Repository hinzufügen:

* Klick auf „<code>doc</code>“ im Dateibaum → <code>Subversion</code> → <code>Add to VCS</code>

Nun können Sie Ihr Projekt committen.

==Automatische Komprimierung von CSS- und Javascript-Dateien==

Nun folgt die letzte Optimierung der Anwendung. Die von Ihnen erstellten CSS- und Javascript-Dateien
enthalten viele Leerzeichen, Kommentare, „sprechende“ anstelle von kurzen Variablenbezeichnern etc.
Das ist für Sie und alle anderen Entwickler von Vorteil. Für die Übertragung der Daten zu einem
Client (Browser) bedeutet das nur unnötiges Datenvolumen. Gerade für mobile Tarife mit Volumenbegrenzung
sollten so wenig Daten wie möglich übertragen werden.

Glücklicherweise gibt es Tools, die bestehende CSS- oder Javascript-Dateien komprimieren (meist sogar so, dass
sich die [[Semantik]] der Dateien nicht ändert; aber wie gesagt: Auch andere Programmierer machen hin und wieder Fehler).

Wir verwenden die Node.js-Tools „<code>cssmin</code>“ für CSS-Dateien (https://www.npmjs.com/package/cssmin) und
„<code>UglifyJS2</code>“ für JavaScript-Dateien (https://github.com/mishoo/UglifyJS2). Gesteuert werden diese “minimizer”
oder “minifier” mittels dem bereits installierten ''JavaScript Task Runner'' <code>grunt</code>“.

Die für das Minimieren mittels Grunt notwendige Pakete wurden ebenfalls bereits installiert:

<source lang="bash">
npm install grunt grunt-contrib-watch grunt-contrib-cssmin grunt-contrib-uglify --save-dev
</source>

Nun müssen die Aufgaben zu Komprimieren der JavaScript- und CSS-Dateien in die Konfigurationsdatei
eingefügt werden:

'''<code>gruntfile.js</code>'''
<source lang="javascript">
/**
* @author Wolfgang Kowarschick <kowa@hs-augsburg.de>
* @see http://gruntjs.com/getting-started
*
* Created on 2016/09/28.
*/

module.exports = function(grunt)
{
// Project configuration.
grunt.initConfig
({
pkg: grunt.file.readJSON('package.json'),

cssmin:
{ options: /* https://github.com/jakubpawlowicz/clean-css */
{ roundingPrecision: -1
},
minimize:
{ files:
{ 'web/css/main.css': ['src/css/main.css'],
}
}
},

uglify:
{ options:
{ mangle: true
},
minimize:
{ files:
{ 'web/js/main.js': ['src/js/main.js']
}
}
}

});

// Load the plugin that provides the "uglify" task.
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-cssmin');

// Default task(s).
grunt.registerTask('default', ['uglify', 'cssmin']);
};
</source>

Die Funktion „<code>grunt.initConfig</code>“ aufgerufen und es wird ihr ein [[JavaScript-Objekt]] übergeben.
Im Attribut „<code>pkg</code>“ wird grund der Inhalt der Datei „<code>package.json</code>“ übergeben, damit Grunt ermitteln kann, welche Pakete verfügbar sind.
Die beiden anderen Attribute „<code>cssmin</code>“ und „<code>uglify</code>“ (deren Namen frei wählbar sind), werden die beiden Minifier konfiguriert.

In beiden Fällen können Optionen angegeben werden, wie {{zB}}, dass CSS-Maß-Angaben nicht gerundet werden sollen (es gibt Designer, die bestehen
beim Pixelmaß auf vier Nachkommastellen) oder dass geeignete JavaScript-Variablen-Namen „durch die Mangel gedreht“ (''mangle''), also durch kürze Namen ersetzt werden sollen.
Wichtiger ist jedoch die Angabe, welche Dateien überhaupt erstellt werden und was für Sourcedaten dafür verwendet werden solle.

Zu jeder Datei, die erstellt wird, kann man eine ganze Liste von Sourcedateien angeben. Das hat zur Folge, dass alle diese Sourcedateien nacheinander
komprimiert und dann in die Zieldatei eingefügt werden. Auch das ist eine Optimierung, um das Laden einer Web-Anwendung zu beschleunigen.
Eine große Datei wird per HTTP schneller übertragen als viele kleine. Künftig werden wir daher möglichst wenige komprimierte Dateien verwenden
und möglichst viele nicht-komprimierte JavaScript-Dateien in komprimierter Form nacheinander in nur eine einzige JavaScript-Datei einfügen.

Nach der Initialisierungsfunktion werden noch zwei weitere Funktionen aufgerufen. Mit <code>grunt.loadNpmTasks</code>
werden die Grunt-Plugins geladen, die die eigentliche Komprimierung vornehmen. Und mittels <code>grunt.loadNpmTasks</code>
wird festgelegt, welche Aufgaben standardmäßig ausgeführt werden, sobald der Befehl „<code>grunt</code>“ ausgeführt wird.

So, nun sollte alles funktionieren. Öffnen Sie das Web-Storm-Terminal und tippen Sie nacheinander folgende Befehle ein:

<source lang="bash">
grunt cssmin
grunt uglify
grunt
<source>

Sie werden feststellen, das jedes mal bestimmte Dateien in den Ordnern „<code>web/css</code>“ oder/und „<code>web/js</code>“
erstellt werden, die mit dem Namensbestandteil „<code>min</code>“ beginnen. Sehen Sie sich die erzeugten Dateien an.
Sie enthalten denselben Code wie die Original-Dateien, nur in komprimierter (und daher für den Menschen schwer lesbarer) Form.

Als nächstes muss die Datei „<code>index.html</code>“ angepasst werden. Diese lädt noch die unkomprimierten Dateien aus dem
Sourceverzeichnis. Künftig soll sie die komprimierten Dateien aus dem eigentlichen Web-Ordner laden:

<source lang="html5">
...
<link rel="stylesheet" type="text/css" href="css/main.css"/>
...
<script type="text/javascript" src="js/main.js"></script>
</source>

Ab sofort werden nicht mehr die Sourcedateien geladen, sondern die komprimierten, durch die Minifier erstellten Dateien.
Das heißt aber für uns, dass wir bei jeder Änderung an den Sourcedateien den Befehl „<code>grunt</code>“
ausführen müssen, um die Aktualisierungen in die komprimierten Versionen der JavaScript bzw. CSS-Dateien zu übertragen.

Das ist lästig und geht besser.

==Automatische Aktualisierung der komprimierten Dateien==

Mit Hilfe des Node.js-Paketes „<code>grunt-contrib-watch</code>“ kann man beliebige Dateibäume überwachen,
ob sich darin bestimmte Dateien ändern. In einem derartigen Fall kann man automatisch andere Grunt Tasks ausführen lassen.
Das lässt sich ausnutzen, um nach Änderungen einer CSS-Datei oder einer JavaScript-Datei die zugehörige komprimierte
Datei automatisch neu zu erstellen.

Öffnen Sie das WebStorm-Terminal und laden Sie das besagte Paket:

<source lang="bash">
npm install grunt-contrib-watch --save-dev
</source>

Erweitern Sie nun die Datei „<code>gruntfile.js</code>“ um einen Watch-Task:

<source lang="javascript">
watch:
{ css:
{ files: ['src/css/**/*.css'],
tasks: ['cssmin']
},
js:
{ files: ['src/js/**/*.js'],
tasks: ['uglify']
},
web:
{ files: ['web/**/*'],
options: { livereload: true,
spawn: false
}
}
}
</source>

Vergessen Sie nicht, das Plugin zu laden:
<source lang="javascript">
grunt.loadNpmTasks('grunt-contrib-watch');
</source>

Der Watch-Task überwacht drei verschiedene Ordner:

* Wann immer sich eine CSS-Datei im Ordner „<code>src/css</code>“ oder einem darin enthaltenen Unterordner ändert, wird der Task „<code>cssmin</code>“ ausgeführt.
* Wann immer sich eine JavaScript-Datei im Ordner „<code>src/js</code>“ oder einem darin enthaltenen Unterordner ändert, wird der Task „<code>uglify</code>“ ausgeführt.
* Wann immer sich irgendeine Datei im Web-Ordner ändert, wird eine <code>livereload</code>-Nachricht (http://livereload.com/) an einen lokalen Node-Server mit der Portnummer 35729 geschickt. (Keine Angst: Sie brauchen diesen Server nicht zu starten oder zu stoppen.)

Damit kann man Browser anweisen, die HTML-Dateien neu zu laden, wann immer sich etwas ändert.
Dies erfolgt entweder mit speziellen Browser-Plugins (http://livereload.com/extensions/) oder mit einem kleinen JavaScript-Hack:
Fügen Sie ans Ende der Datei „<code>main.js</code>“ folgenden Code ein:

<source lang="javascript">
// Enable live reloading for the WebStorm web server.
if (location.port === '63342') // WebStorm server port
{
var l_script = document.createElement('script');
l_script.src = 'http://'+(location.host||'localhost').split(':')[0]+':35729/livereload.js';
document.body.appendChild(l_script);
}
</source>

Dieser Code sorgt dafür, dass in eine HTML-Datei, die die Datei „<code>main.js</code>“ einbindet,
ein zusätzliches <code>script</code>-Element
<source lang="html5">
<script src="http://localhost:35729/livereload.js></script>
</source>
erstellt und in jede HTML-Datei eingefügt wird, die von einem WebStorm-Test-Server ausgeliefert wird.
(Der URI kann anstelle des Servernamens „<code>localhost</code>“ auf den echten Namen des Entwicklungsrechners enthalten, sofern
der Entwicklungsrechner einen derartigen Namen hat.)

Unter Port 35729 wird auf dem Entwicklungsrechner von <code>grunt-contrib-watch</code> der bereits erwähnte Livereload-Server gestartet und
die JavaScript-Datei „<code>livereload.js</code>“ zur Verfügung gestellt. Wenn man diese Datei in seine HTML-Datei einbindet,
aktualisiert sich die HTML-Datei fortan automatisch, sobald <code>grunt-contrib-watch</code> eine Änderung, wie {{zB}}
die Aktualisierung einer CSS-Datei, einer JavaScript-Datei, der HTML-Datei selbst oder einer anderen Datei, die von der HTML-Datei eingebunden wird,
meldet.

Allerdings wäre es falsch, <code>livereload.js</code> auf einem Live-Server ohne Testumgebung einzubinden. Dort läuft der Livereload-Server überhaupt nicht.
Daher wird zunächst ermittelt, über welchen Port die aktuelle HTML-Datei von Server ausgeliefert wurde.
Üblicherweise ist dies 80, 443, 8080, 8888 oder 8443. Andere Ports werden selten verwendet.
Der Port 63342 wird mit fast absoluter Sicherheit nicht von irgendeinem realen Server verwendet. Daher verwendet ihn WebStorm.
Und daher kann mit dem Test <code>if (location.port == 63342)</code> ermittelt werden, ob die aktuelle HTML-Datei von einem WebStorm-Server
ausgeliefert wurde oder von einem anderen Server. (Die globale JavaScript-Variable „<code>location</code>“ enthält den URI, über den die HTML-Datei
vom Browser geladen wurde.)

Nun ist es an der Zeit, den <code>grunt-contrib-watch</code> zu testen. Öffnen Sie „<code>index.html</code>“ im Browser
(Rechtsklick auf <code>index.html</code> → <code>Run 'index.html'</code>) und tippen Sie dann
<source lang="bash">
grunt watch
</source>
ins WebStorm-Terminal.
Ändern Sie nun einen Eintrag in der Datei „<code>main.css</code>“ ({{zB}} <code>font-family: "Comic Sans MS";</code> :-) ).
Wenn Sie diese Änderungen speichern (Strg-S, Apfel-S), sollten Sie zweierlei Reaktionen bemerken.
Zum einem wird ins Terminal die Meldung
<source lang="bash">
>> File "web/css/main.css" changed.
</source>
geschrieben und zum anderen ändert sich das Layout der HTML-Datei im Browser, da die aktualisierte CSS-Datei
automatisch vom Browser nachgeladen wurde.

Wenn Sie die Designsünde „Comic Sans MS“ rückgängig machen, ändert sich die Datei kurz darauf auch im Browser wieder.

Das ist schon ziemlich „cool“, hat aber noch einen Schönheitsfehler: Das WebStorm-Terminal kann nicht anderweitig genutzt werden, solange
der Grunt-Watcher läuft. Um dieses Problem zu beheben, wird ein WebStorm-Startup-Task definiert, der den Watcher bei jedem
Programmstart von WebStorm automatisch in einem eigenständigen [[Task]] startet. Der Watcher läuft dann, solange WebStorm geöffnet ist.
Für seine Ausgaben steht im ein eigenes Ausgabefenster zur Verfügung. Was will man mehr?

* <code>File</code> → <code>Settings</code> → <code>Tools</code> → <code>Startup Tasks</code> → <code></code>
* Klick auf grünes Plus-Icon → <code>Add New Configuration</code> → <code>Grunt.js</code>
** Name: <code>Watch</code>
** Gruntfile: <code>.../HelloWorld04/gruntfile.js</code> (sollte bereits korrekt eingetragen sein)
** Tasks: <code>watch</code>
** Der Node-Interpreter und das Node.js-Paket <code>grunt-cli</code> sollten ebenfalls bereits korrekt eingetragen sein.
* <code>OK</code> (Unter „<code>Run configuration</code>“ sollte jetzt „<code>Watch</code>“ stehen.)
* <code>OK</code>

Wenn Sie nun WebStorm neu starten, sollte und der Menüzeile am unteren Fensterrand ein Tabulator mit dem Namen „<code>Run</code>“ vorhanden sein.
Wenn Sie das zugehörige Fenster öffnen sollte dort Folgendes stehen:

<source lang="bash">
grunt watch
Running "watch" task
Waiting...
</source>

Sobald Sie irgendeine Änderung an eine <code>web</code>- oder <code>src</code>-Datei der Web-App vornehmen, werden alle im Watcher definierten Aktionen
(automatische Komprimierung bzw. Neuladen des HTML-Datei im Browser) automatisch ausgeführt. Der Watcher läuft solange, bis Sie WebStorm beenden.
Es erfolgt dabei sogar noch eine Sicherheitsabfrage, on Sie den Prozess „<code>Watch</code>“ beenden wollen.


==JSHint==

Ein weiteres sehr interessantes Tool, das den JavaScript-Entwickler unterstützt, ist JSHint (http://jshint.com/).
JSHint analysiert vorhandenen JavaScript-Code und weist auf Fehler und Strukturprobleme hin.

Installieren Sie zunächst die zugehörigen Node.js-Pakete:

<source lang="bash">
npm install grunt-contrib-jshint jshint-stylish --save-dev
</source>

Anschließend fügen Sie einen JSHit-Task in die Datei „<code>gruntfile.js</code>“ ein.

<source lang="javascript">
jshint:
{
all: ['gruntfile.js', 'src/**/*.js'],

options:
{
esversion: 5,
eqeqeq: true,
eqnull: true,
browser: true,
reporter: require('jshint-stylish')
}
}
</source>

Nun können alle vom Entwickler erstellten JavaScript-Dateien analysiert werden. Geben Sie dazu im
WebStorm-Terminal einfach folgenden Befehl ein:

<source lang="bash">
grunt jshint
</source>

Gut ist es, wenn JSHint mit der Meldung <code>v No problems</code> antwortet.
Ansonsten sollten Sie in Ihrem Code die von JSHint gemeldeten Probleme beheben.

Machen Sie ruhig mal die Probe auf's Exempel: Ersetzen Sie „<code>===</code>“
in der Datei „<code>main.js</code>“ durch „<code>==</code>“ und lassen Sie
danach JSHint laufen. Dann sollte JSHint Folgendes melden:

<source lang="bash">
Expected '===' and instead saw '=='.
</source>

Damit wird ausgedrückt, dass ein nicht-strikter Gleichheitstest verwendet wurde,
aber ein strikter Gleichheitstest verwendet werden sollte. Der Grund ist, dass
nicht-strikte Fehlertests manchmal subtile Fehler zur Folge haben, die
nur sehr schwer zu entdecken sind.

JSHint kennt zahlreiche Optionen, die festlegen, welche Fehler und Probleme gemeldet
werden sollen und welche nicht: http://jshint.com/docs/options/.
Hier muss jeder Programmierer seinen eigenen Stil finden.

Folgende Optionen wurden im obigen Beispiel verwendet:

<dl>
</dt><code>esversion: 5</code></dt>
<dd>Des sollen die Regeln von [[EcmaScript 5]] beachtet werden.</dd>
</dt><code>eqeqeq: true</code></dt>
<dd>Es sollt stets ein strikter Gleichheitstest verwendet werden.</dd>
</dt><code>eqnull</code></dt>
<dd>Der nicht-strikte Gleichheitstest <code>... == null</code> ist allerdings erlaubt.
</dd>
</dt><code>browser: true</code></dt>
<dd>Globale Variable sollte man eigentlich grundsätzlich nicht verwenden.
Mit dieser Option werden für die globalen Variablen, die die Browser bereitgestellt werden
(<code>document</code>, <code>window</code>, <code>console</code> etc) Ausnahmen definiert.</dd>
</dl>

'''Anmerkung''': Wäre der nicht-strikte Gleichheitstest auf „<code>null</code>“ nicht erlaubt, müsste man in viele Fällen
„<code>... === null || ...=== undefined</code>“ schreiben. Geben Sie folgende Befehle einfach mal
in die Konsole Ihres Web-Browsers ein (Firefox: Strg-Shift-K, Opera und Chrome: Strg-Shift-I -> <code>Console</code>):

<source lang="javascript">
var a;
var b = null;

// Strikte Gleichheitstests
console.log(a === null); /* -> false */
console.log(a === undefined); /* -> true */
console.log(b === null); /* -> true */
console.log(b === undefined); /* -> false */
console.log(a === null || a === undefined); /* -> true */
console.log(b === null || b === undefined); /* -> true */

// Nicht-strikte Gleichheitstests
console.log(a == null); /* -> true */
console.log(a == undefined); /* -> true */
console.log(b == null); /* -> true */
console.log(b == undefined); /* -> true */
</source>

Zum Abschluss können Sie entweder einen WebStorm-Menü-Eintrag hinzufügen, um den JSHint jederzeit per Klickibunti starten zu können.
Oder Sie fügen gleich „<code>jslint</code>“ in die Watch-Liste ein, damit jede Änderung sofort analysiert und Fehler sofort angezeigt werden:

'''<code>gruntfile.js</code>'''
<source lang="javascript">
watch:
{ ...
js:
{ files: ['src/js/**/*.js'],
tasks: ['uglify', 'jshint']
},
...
}
</source>

Allerdings kann JSHint manchmal nerven. :-) Dagegen helfen dann spezielle Kommentare im JavaScript-Code, die
JSHint anweisen für die Prüfung des nachfolgenden Codes spezielle Optionen zu benutzen, die dann {{iAllg}}
eine etwas weniger strenge Überprüfung des Codes zur Folge haben (http://jshint.com/docs/).

==Quellen==
<references/>
<ol>
<li value="3"> {{Quelle|Kowarschick, W.: Multimedia-Programmierung}}</li>
</ol>
<noinclude>[[Kategorie: HTML5-Tutorium: JavaScript: Hello World]][[Kategorie: HTML5-Beispiel]][[Kategorie:Kapitel:Multimedia-Programmierung:Beispiele]]</noinclude>

GlossarWiki - Benutzerbeiträge [de-formal]

HTML5-Tutorium: JavaScript: Hello World 04