Quellcode durchsuchen

Added script to build the JS documentation

tags/v8.0.0alpha1
Vincent Petry vor 10 Jahren
Ursprung
Commit
c7dc656b2b
2 geänderte Dateien mit 43 neuen und 0 gelöschten Zeilen
  1. 1
    0
      .gitignore
  2. 42
    0
      buildjsdocs.sh

+ 1
- 0
.gitignore Datei anzeigen

@@ -89,6 +89,7 @@ nbproject

# nodejs
/build/lib/
/build/jsdocs/
/npm-debug.log



+ 42
- 0
buildjsdocs.sh Datei anzeigen

@@ -0,0 +1,42 @@
#!/bin/bash
#
# ownCloud
#
# Run JS tests
#
# @author Vincent Petry
# @copyright 2014 Vincent Petry <pvince81@owncloud.com>
#
NPM="$(which npm 2>/dev/null)"
PREFIX="build"
OUTPUT_DIR="build/jsdocs"

JS_FILES="core/js/*.js apps/*/js/*.js"

if test -z "$NPM"
then
echo 'Node JS >= 0.8 is required to build the documentation' >&2
exit 1
fi

# update/install test packages
mkdir -p "$PREFIX" && $NPM install --link --prefix "$PREFIX" jsdoc || exit 3

JSDOC_BIN="$(which jsdoc 2>/dev/null)"

# If not installed globally, try local version
if test -z "$JSDOC_BIN"
then
JSDOC_BIN="$PREFIX/node_modules/jsdoc/jsdoc.js"
fi

if test -z "$JSDOC_BIN"
then
echo 'jsdoc executable not found' >&2
exit 2
fi

mkdir -p "$OUTPUT_DIR"

NODE_PATH="$PREFIX/node_modules" $JSDOC_BIN -d "$OUTPUT_DIR" $JS_FILES


Laden…
Abbrechen
Speichern