AppSuite:GruntFAQ - Revision history

Khgras at 08:57, 15 May 2019

2019-05-15T08:57:53Z

← Older revision		Revision as of 08:57, 15 May 2019
Line 1:		Line 1:
	The content on this page has moved to https://documentation.open-xchange.com/~~latest/ui/00-getting-started/04-build-process.html~~		The content on this page has moved to https://documentation.open-xchange.com/

	Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

Khgras at 09:10, 22 May 2017

2017-05-22T09:10:17Z

← Older revision		Revision as of 09:10, 22 May 2017
Line 1:		Line 1:
	~~<div class="title">FAQ regarding Grunt configuration for App Suite UI plugins<~~/~~div>~~		The content on this page has moved to https://documentation.open-xchange.com/latest/ui/00-getting-started/04-build-process.html

	~~= Building UI plugins =~~		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

	~~== I get a 'local grunt not found' error message when running grunt ==~~

	~~The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone.~~ Note: ~~<tt>npm install -g grunt</tt> is not enough.~~

	~~== Some of my files aren't copied. How can I extend a copy sub-task? ==~~

	~~Especially when using external libraries managed with Bower or npm, sometimes the [https://github.com/~~Open-Xchange~~-Frontend/shared-grunt-config shared grunt configuration] doesn't contain all cases for files to be copied during~~ the ~~build or dist tasks. Due to the [https://johnyb.github.io/2014/05/10/extending_shared_grunt_configuration.html extensibility]~~ of ~~our shared grunt configuration, it's quite easy~~ to ~~add those missing files. You can hook up into the <tt>build_</tt> or the <tt>dist_</tt> copy task~~ and ~~add your custom configuration like this:~~

	~~<syntaxhighlight lang="JavaScript">~~
	~~'use strict';~~

	~~module.exports = function~~ (~~grunt) {~~
	~~grunt~~.~~config~~.~~extend('copy', {~~
	~~build_custom: {~~
	~~files: [{~~
	~~expand: true,~~
	~~src: ['apps/*/.in', 'apps/**/manifest.json'],~~
	~~dest: 'build/'~~
	}]
	}
	});
	};
	~~</syntaxhighlight>~~

	~~Put this in a file inside the <tt>grunt/tasks</tt> directory and you are done. From now on, all files ending with .in and all manifest~~.~~json files are put into the <tt>build/</tt> directory using the same structure~~ as in the ~~<tt>apps/</tt> directory. For~~ more ~~detailed~~ information ~~see [http://gruntjs.com/configuring-tasks#files the grunt documentation on files].~~

	~~= Using development proxy server =~~

	~~== Which version of appserver am I using? ==~~

	~~npm can be used to find out about the versions. <tt>npm ls appserver</tt>~~ will ~~list the version of appserver that is used.~~

	~~== I get an error message 'Port 8337 already in use by another process', what can I do? ==~~

	~~Only one instance of appserver is allowed at a time (this might~~ be ~~subject to change, though). You have multiple options to start developing~~ on ~~that plugin. Number one:~~

	~~# Close all other running instances of appserver~~ and ~~run it exclusively in one project~~

	~~Yes, that was the easy one~~. ~~However,~~ you ~~might want to serve multiple projects at once. This case would need a little more configuration:~~

	~~# Choose one base UI project~~
	~~# Edit <tt>grunt/local.conf.json</tt>~~
	~~# add all build/ directories you want to serve to "prefixes" array~~
	~~# Run <tt>grunt connect watch</tt> in the base directory~~
	~~# In all other UI projects you want to develop, only run <tt>grunt watch</tt> without the connect task~~

	~~Appserver will in~~ this ~~case do all the cache busting for you (it uses the timestamp~~ of the "newest" directory in the prefix list) and if you didn't de-activate live-reload, it will work for all projects (the watch task sends livereload events to appserver, which will trigger the reload in the browser).

Tierlieb: /* I get a 'local grunt not found' error message when running grunt */

2014-08-25T10:10:06Z

I get a 'local grunt not found' error message when running grunt

← Older revision		Revision as of 10:10, 25 August 2014
Line 5:		Line 5:
	== I get a 'local grunt not found' error message when running grunt ==		== I get a 'local grunt not found' error message when running grunt ==

	The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone.		The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone. Note: <tt>npm install -g grunt</tt> is not enough.

	== Some of my files aren't copied. How can I extend a copy sub-task? ==		== Some of my files aren't copied. How can I extend a copy sub-task? ==

J.ohny.b: /* I get an 'local grunt not found' error message when running grunt */

2014-08-25T10:02:46Z

I get an 'local grunt not found' error message when running grunt

← Older revision		Revision as of 10:02, 25 August 2014
Line 3:		Line 3:
	= Building UI plugins =		= Building UI plugins =

	== I get an 'local grunt not found' error message when running grunt ==		== I get a 'local grunt not found' error message when running grunt ==

	The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone.		The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone.

J.ohny.b: /* Building UI plugins */

2014-08-25T10:02:09Z

Building UI plugins

← Older revision		Revision as of 10:02, 25 August 2014
Line 2:		Line 2:

	= Building UI plugins =		= Building UI plugins =

			== I get an 'local grunt not found' error message when running grunt ==

			The local dependencies are not installed, run <tt>npm install</tt> to install them. After that, the error message should be gone.

	== Some of my files aren't copied. How can I extend a copy sub-task? ==		== Some of my files aren't copied. How can I extend a copy sub-task? ==

J.ohny.b: /* Using development proxy server */

2014-07-24T09:33:33Z

Using development proxy server

← Older revision		Revision as of 09:33, 24 July 2014
Line 26:		Line 26:

	= Using development proxy server =		= Using development proxy server =

			== Which version of appserver am I using? ==

			npm can be used to find out about the versions. <tt>npm ls appserver</tt> will list the version of appserver that is used.

	== I get an error message 'Port 8337 already in use by another process', what can I do? ==		== I get an error message 'Port 8337 already in use by another process', what can I do? ==

J.ohny.b: /* Using development proxy server */

2014-07-01T09:07:25Z

Using development proxy server

← Older revision		Revision as of 09:07, 1 July 2014
Line 27:		Line 27:
	= Using development proxy server =		= Using development proxy server =

	== I get an error message 'Port 8337 already in use by another process' ==		== I get an error message 'Port 8337 already in use by another process', what can I do? ==

	Only one instance of appserver is allowed at a time (this might be subject to change, though). You have multiple options to start developing on that plugin. Number one:		Only one instance of appserver is allowed at a time (this might be subject to change, though). You have multiple options to start developing on that plugin. Number one:

J.ohny.b: /* I get an error message 'Port 8337 already in use by another process' */

2014-07-01T08:59:59Z

I get an error message 'Port 8337 already in use by another process'

← Older revision		Revision as of 08:59, 1 July 2014
Line 31:		Line 31:
	Only one instance of appserver is allowed at a time (this might be subject to change, though). You have multiple options to start developing on that plugin. Number one:		Only one instance of appserver is allowed at a time (this might be subject to change, though). You have multiple options to start developing on that plugin. Number one:

	1. Close all other running instances of appserver and run it exclusively in one project		# Close all other running instances of appserver and run it exclusively in one project

	Yes, that was the easy one. However, you might want to serve multiple projects at once. This case would need a little more configuration:		Yes, that was the easy one. However, you might want to serve multiple projects at once. This case would need a little more configuration:

	1. Choose one base UI project		# Choose one base UI project
	2. Edit <tt>grunt/local.conf.json</tt>		# Edit <tt>grunt/local.conf.json</tt>
	3. add all build/ directories you want to serve to "prefixes" array		# add all build/ directories you want to serve to "prefixes" array
	4. Run <tt>grunt connect watch</tt> in the base directory		# Run <tt>grunt connect watch</tt> in the base directory
	5. In all other UI projects you want to develop, only run <tt>grunt watch</tt> without the connect task		# In all other UI projects you want to develop, only run <tt>grunt watch</tt> without the connect task

	Appserver will in this case do all the cache busting for you (it uses the timestamp of the "newest" directory in the prefix list) and if you didn't de-activate live-reload, it will work for all projects (the watch task sends livereload events to appserver, which will trigger the reload in the browser).		Appserver will in this case do all the cache busting for you (it uses the timestamp of the "newest" directory in the prefix list) and if you didn't de-activate live-reload, it will work for all projects (the watch task sends livereload events to appserver, which will trigger the reload in the browser).

J.ohny.b at 08:58, 1 July 2014

2014-07-01T08:58:09Z

@@ Line 1: / Line 1: @@
 <div class="title">FAQ regarding Grunt configuration for App Suite UI plugins</div>
 == Some of my files aren't copied. How can I extend a copy sub-task? ==
@@ Line 22: / Line 24: @@
 Put this in a file inside the <tt>grunt/tasks</tt> directory and you are done. From now on, all files ending with .in and all manifest.json files are put into the <tt>build/</tt> directory using the same structure as in the <tt>apps/</tt> directory. For more detailed information see [http://gruntjs.com/configuring-tasks#files the grunt documentation on files].

J.ohny.b at 12:56, 16 June 2014

2014-06-16T12:56:39Z

← Older revision		Revision as of 12:56, 16 June 2014
Line 1:		Line 1:
	<div class="title">FAQ regarding Grunt</div>		<div class="title">FAQ regarding Grunt configuration for App Suite UI plugins</div>

	== Some of my files aren't copied. How can I extend a copy sub-task? ==		== Some of my files aren't copied. How can I extend a copy sub-task? ==