From 647d771af3dad262b391c1ded4ea8b49e159a9f7 Mon Sep 17 00:00:00 2001 From: blackbaud-johnly Date: Mon, 12 Jun 2017 14:52:37 -0400 Subject: [PATCH 01/10] AppSettings and config files docs. --- .../additional-config-files/index.html | 36 +++++++++++++++++++ .../learn/reference/configuration/index.html | 1 + 2 files changed, 37 insertions(+) create mode 100644 src/app/learn/reference/configuration/additional-config-files/index.html diff --git a/src/app/learn/reference/configuration/additional-config-files/index.html b/src/app/learn/reference/configuration/additional-config-files/index.html new file mode 100644 index 000000000..730d40aea --- /dev/null +++ b/src/app/learn/reference/configuration/additional-config-files/index.html @@ -0,0 +1,36 @@ + + + +

While the SKY UX template provides the skyuxconfig.json file to specify configuration settings, SKY UX also enables you to create additional config files as necessary to apply configuration settings to specific SKY UX CLI commands. You can create a file that follows the skyuxconfig.[COMMAND].json naming convention for the config file. For example, to apply configuration settings specifically when skyux serve runs, create a skyuxconfig.serve.jsonautomatically include and merge in skyuxconfig.serve.json if it exists.

+ + + In addition to the normal skyuxconfig.json, we also support automatically reading a matching skyuxconfig.[COMMAND].json, so when running skyux serve, for example, we’ll automatically include and merge in skyuxconfig.serve.json if it exists. + + +
    +

    2. +

    3. +

    4. +
+ + diff --git a/src/app/learn/reference/configuration/index.html b/src/app/learn/reference/configuration/index.html index ccda967d2..167b6ed59 100644 --- a/src/app/learn/reference/configuration/index.html +++ b/src/app/learn/reference/configuration/index.html @@ -10,6 +10,7 @@

  • name — Specifies the name of the project when running in SKY UX Host. For example, if you specify "demo" as the name, then your SPA is accessible from https://host.nxt.blackbaud.com/demo. By default, SKY UX Builder uses the name property in the package.json file, minus the "blackbaud-skyux-spa-" prefix. That value is based on the root directory name that you specify when you create a SKY UX project. You can use the name property in skyuxconfig.json to overwrite the default name if you do not want the root directory name in your public-facing URL. For example, if you publish the SPA to NPM, you use the name property in package.json, so you may want to use a different name for the project in SKY UX Host.

  • mode — Controls how much boilerplate code to generate automatically. By default, the skyuxconfig.json file sets this property to easy. In easy mode, SKY UX automatically generates routes based the project's folder structure, provides bootstrapping to initialize the application, and supplies SKY UX components to the application. To override these options, change the mode property to advanced. Since advanced mode does not provide automatic route configuration, you can adjust URLs and point to specific components in your SPA. This property will eventually become obsolete as the SKY UX team builds out the CLI to allow users to override individual steps without switching to advanced mode.

  • compileMode — Specifies how to compile the project's code. By default, the skyuxconfig.json file sets this property to aot to specify ahead-of-time compilation, which runs the compiler once at build time using one set of libraries. You can change this setting to jit to specify just-in-time compilation, which runs the compiler at run time for every user using a different set of libraries. SKY UX uses ahead-of-time compilation by default because it is typically more performant and has less to handle at run-time. For more information about the difference, see the Angular documentation

    • +

  • appSettings — Specifies data that is available for reuse throughout the application. The property's data type is any, so it accepts strings, arrays, config setting, and any other type of data that is necessary.

  • host — Specifies configuration options for communication with SKY UX Host.