From f12157c145f7227f77834419ce4aec2ce16f603c Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Mon, 26 Oct 2020 14:25:12 +0100 Subject: [PATCH] docs: update CLI workspace config documentation (#39427) - Improves JSON formatting - Add reference to font optimization - Removes `="true"` from boolean command line args. These are redundant and it can be confusing to why boolean values need to be provided via a CLI. PR Close #39427 --- aio/content/guide/workspace-config.md | 68 +++++++++++++++++++++------ 1 file changed, 53 insertions(+), 15 deletions(-) diff --git a/aio/content/guide/workspace-config.md b/aio/content/guide/workspace-config.md index 4163994ed9..23519e132e 100644 --- a/aio/content/guide/workspace-config.md +++ b/aio/content/guide/workspace-config.md @@ -241,8 +241,16 @@ For example, the default asset paths can be represented in more detail using the "assets": [ - { "glob": "**/*", "input": "src/assets/", "output": "/assets/" }, - { "glob": "favicon.ico", "input": "src/", "output": "/" } + { + "glob": "**/*", + "input": "src/assets/", + "output": "/assets/" + }, + { + "glob": "favicon.ico", + "input": "src/", + "output": "/" + } ] @@ -253,7 +261,11 @@ For example, the following configuration copies assets from a node package: "assets": [ - { "glob": "**/*", "input": "./node_modules/some-package/images", "output": "/some-package/" }, + { + "glob": "**/*", + "input": "./node_modules/some-package/images", + "output": "/some-package/" + } ] @@ -265,7 +277,12 @@ The following example uses the `ignore` field to exclude certain files in the as "assets": [ - { "glob": "**/*", "input": "src/assets/", "ignore": ["**/*.svg"], "output": "/assets/" }, + { + "glob": "**/*", + "input": "src/assets/", + "ignore": ["**/*.svg"], + "output": "/assets/" + } ] @@ -284,10 +301,18 @@ For example, the following object values create and name a bundle that contains "styles": [ - { "input": "src/external-module/styles.scss", "inject": false, "bundleName": "external-module" } + { + "input": "src/external-module/styles.scss", + "inject": false, + "bundleName": "external-module" + } ], "scripts": [ - { "input": "src/external-module/main.js", "inject": false, "bundleName": "external-module" } + { + "input": "src/external-module/main.js", + "inject": false, + "bundleName": "external-module" + } ] @@ -341,25 +366,38 @@ See also [Using runtime-global libraries inside your app](guide/using-libraries# ### Optimization and source map configuration -The `optimization` and `sourceMap` command options are simple Boolean flags. -You can supply an object as a configuration value for either of these to provide more detailed instruction. +The `optimization` and `sourceMap` browser builder options can be either a Boolean or an Object for more fine-grained configuration. +In this section we will explain how to fine tune these options. -* The flag `--optimization="true"` applies to both scripts and styles. You can supply a value such as the following to apply optimization to one or the other: +* The `optimization` option applies to scripts, styles and fonts. You can supply a value such as the following to apply optimization to one or the other: - "optimization": { "scripts": true, "styles": false } + "optimization": { + "scripts": true, + "styles": false, + "fonts": true + } -* The flag `--sourceMap="true"` outputs source maps for both scripts and styles. -You can configure the option to apply to one or the other. -You can also choose to output hidden source maps, or resolve vendor package source maps. -For example: +
+ + Fonts optimization requires internet access. + When enabled, render blocking requests will be reduced by inlining external Google fonts and icons in the application's HTML index file. + +
+ +* The `sourceMap` option applies for both scripts and styles. You can also choose to output hidden source maps, or resolve vendor package source maps: - "sourceMap": { "scripts": true, "styles": false, "hidden": true, "vendor": true } + "sourceMap": { + "scripts": true, + "styles": false, + "hidden": true, + "vendor": true + }