Added script to build the JS documentation

This commit is contained in:
Vincent Petry 2014-06-23 23:57:44 +02:00
parent e0528c7598
commit c7dc656b2b
2 changed files with 43 additions and 0 deletions

1
.gitignore vendored
View File

@ -89,6 +89,7 @@ nbproject
# nodejs
/build/lib/
/build/jsdocs/
/npm-debug.log

42
buildjsdocs.sh Executable file
View File

@ -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