mediawiki-extensions-Visual.../.docs/generate.sh

#!/usr/bin/env bash
cd $(cd $(dirname $0); pwd)

(
	while IFS='' read -r l
	do
		if [[ "$l" == "{{VE-LOAD-HEAD}}" ]]
		then
			php ../maintenance/makeStaticLoader.php --section=head --ve-path=../modules/ $*
		elif [[ "$l" == "{{VE-LOAD-BODY}}" ]]
		then
			php ../maintenance/makeStaticLoader.php --section=body --ve-path=../modules/ $*
		else
			echo "$l"
		fi
	done
) < eg-iframe.tpl | php > eg-iframe.html

# Disable parallel processing which seems to be causing
# problems under Ruby 1.8
warnings=`jsduck --config=config.json --processes=0 2>&1`
ec=$?

rm eg-iframe.html
cd - > /dev/null

# Re-colorize
NORMAL=$(tput sgr0); YELLOW=$(tput setaf 3); MEGANTA=$(tput setaf 5)
echo "$warnings" | perl -pe "s|^([^ ]+) ([^ ]+) (.*)$|${YELLOW}\1 ${MEGANTA}\2${NORMAL} \3|"

# JSDuck doesn't exit with an error code if there are warnings
# (only when there are fatal errors). We fixed all warnings
# in master so lets consider all warnings errors to ensure
# we don't introduce any new invalid jsduck syntax.
if [[ "$ec" == "0" && "$warnings" != "" ]]
then
	exit 1
fi

# Exit with exit code of jsduck command
exit $ec
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`#!/usr/bin/env bash`
			`cd $(cd $(dirname $0); pwd)`

			`(`
			`while IFS='' read -r l`
			`do`
docsgen: Fix error on Ubuntu When running this on Mac, it works fine. But when running it on Ubuntu in labs, the condition checking for "VE-LOAD" head and body always evaluate to false. Not sure what's up with that, but since these lines no longer contain whitespace, a straight comparison is all we need. Also removed the duplicate `<head>` tag in the template. Change-Id: Ic7e8351e784be35fd0104269be331cf9bd0c08b4 2010-01-05 22:27:55 +00:00			`if [[ "$l" == "{{VE-LOAD-HEAD}}" ]]`
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`then`
Docgen: Add a way to override parameters to makeStaticLoader. When running from Jenkins, we publish only the docs/ directory. So the live previews are failing as there is no ../modules to be found. This will allow Jenkins to instead pass a different --ve-path. Also, needed to fix the eval in PHP to not use vePath directly. The vePath is the path for the web browser to the module directory not for the server-side. On the server-side we can just use __DIR__ as maintenance/ is always next to /modules and /VisualEditor.i18n.php. Change-Id: I02101454a1977938bf861425db2141bdb446725b 2013-03-28 19:31:28 +00:00			`php ../maintenance/makeStaticLoader.php --section=head --ve-path=../modules/ $*`
docsgen: Fix error on Ubuntu When running this on Mac, it works fine. But when running it on Ubuntu in labs, the condition checking for "VE-LOAD" head and body always evaluate to false. Not sure what's up with that, but since these lines no longer contain whitespace, a straight comparison is all we need. Also removed the duplicate `<head>` tag in the template. Change-Id: Ic7e8351e784be35fd0104269be331cf9bd0c08b4 2010-01-05 22:27:55 +00:00			`elif [[ "$l" == "{{VE-LOAD-BODY}}" ]]`
			`then`
Docgen: Add a way to override parameters to makeStaticLoader. When running from Jenkins, we publish only the docs/ directory. So the live previews are failing as there is no ../modules to be found. This will allow Jenkins to instead pass a different --ve-path. Also, needed to fix the eval in PHP to not use vePath directly. The vePath is the path for the web browser to the module directory not for the server-side. On the server-side we can just use __DIR__ as maintenance/ is always next to /modules and /VisualEditor.i18n.php. Change-Id: I02101454a1977938bf861425db2141bdb446725b 2013-03-28 19:31:28 +00:00			`php ../maintenance/makeStaticLoader.php --section=body --ve-path=../modules/ $*`
Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`else`
			`echo "$l"`
			`fi`
			`done`
			`) < eg-iframe.tpl \| php > eg-iframe.html`

docgen: Disable parallel processing, suspected cause of Ruby segfaults Change-Id: Icdf92b4c0aed27f7bfc5d37c6abeedf60a2b7f27 2013-04-15 22:28:55 +00:00			`# Disable parallel processing which seems to be causing`
			`# problems under Ruby 1.8`
			warnings=`jsduck --config=config.json --processes=0 2>&1`
Docgen: Exit with error status code if there are warnings. This way the Jenkins job will be marked failure if we introduce regressions in the validity of the syntax. Change-Id: I80ea147b96632412913193600960d1cf4127ed25 2013-03-20 16:45:57 +00:00			`ec=$?`

Implement inline documentation examples. Refactored the (previously unused) eg-iframe file to be a template with 2 placeholders for script and styles. The previous version was just the basic version to execute javascript code, but that's not good enough since we need a whole bunch of classes to be loaded. A bash file processes the template into proper html, with the help of the makeStaticLoader maintenance script we already had. Updated demo.css, cleaned up redundant properties restyled slightly to be more like the Vector skin and less "raw". Fixed default $IP path in makeStaticLoader.php to work with simple mediawiki core installs having the extension in the regular extensions directory, and prefixed __DIR__ so it doesn't rely on the directory you call it from. Change-Id: Ic789121dfeca08d9db69564d2ad2e52b3fa45de9 2013-02-09 01:33:48 +00:00			`rm eg-iframe.html`
			`cd - > /dev/null`
Docgen: Exit with error status code if there are warnings. This way the Jenkins job will be marked failure if we introduce regressions in the validity of the syntax. Change-Id: I80ea147b96632412913193600960d1cf4127ed25 2013-03-20 16:45:57 +00:00
Docgen: Re-colourise jsduck warnings. When jsduck is executed in a subshell (as we do, to catch output) it disables the color output. It should have a --color flag, but it doesn't have that, so manually colourise for now. Change-Id: I1f8da523b6b4fc1fc6965f751395f8af497b13b5 2013-03-28 18:55:25 +00:00			`# Re-colorize`
			`NORMAL=$(tput sgr0); YELLOW=$(tput setaf 3); MEGANTA=$(tput setaf 5)`
			`echo "$warnings" \| perl -pe "s\|^([^ ]+) ([^ ]+) (.*)$\|${YELLOW}\1 ${MEGANTA}\2${NORMAL} \3\|"`
Docgen: Exit with error status code if there are warnings. This way the Jenkins job will be marked failure if we introduce regressions in the validity of the syntax. Change-Id: I80ea147b96632412913193600960d1cf4127ed25 2013-03-20 16:45:57 +00:00
			`# JSDuck doesn't exit with an error code if there are warnings`
			`# (only when there are fatal errors). We fixed all warnings`
			`# in master so lets consider all warnings errors to ensure`
			`# we don't introduce any new invalid jsduck syntax.`
			`if [[ "$ec" == "0" && "$warnings" != "" ]]`
			`then`
			`exit 1`
			`fi`

docgen: Exit with exit code of jsduck command Change-Id: Idf896dc6d9dcd11effcc9836b857267570db3e15 2013-03-15 16:25:39 +00:00			`# Exit with exit code of jsduck command`
			`exit $ec`