This is an automated email from the ASF dual-hosted git repository.
joshtynjala pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 6aa1579 compiler-options: a couple more, plus some alphabetical
sorting
6aa1579 is described below
commit 6aa15794b2f40d8b1ec011b44473189e132010c7
Author: Josh Tynjala <[email protected]>
AuthorDate: Mon Nov 23 14:30:31 2020 -0800
compiler-options: a couple more, plus some alphabetical sorting
---
compiler/compiler-options.md | 97 ++++++++++++++++++++++++++++++++++----------
1 file changed, 75 insertions(+), 22 deletions(-)
diff --git a/compiler/compiler-options.md b/compiler/compiler-options.md
index 3631872..be7191e 100644
--- a/compiler/compiler-options.md
+++ b/compiler/compiler-options.md
@@ -28,13 +28,14 @@ List of available compiler options
**General compiler options**
*
[allow-abstract-classes](compiler/compiler-options.html#allow-abstract-classes)
-*
[allow-private-constructors](compiler/compiler-options.html#allow-abstract-constructors)
* [allow-import-aliases](compiler/compiler-options.html#allow-import-aliases)
+*
[allow-private-constructors](compiler/compiler-options.html#allow-abstract-constructors)
*
[strict-identifier-names](compiler/compiler-options.html#strict-identifier-names)
**JavaScript compiler options**
* [html-output-filename](compiler/compiler-options.html#html-output-filename)
* [html-template](compiler/compiler-options.html#html-template)
+* [inline-constants](compiler/compiler-options.html#inline-constants)
* [js-compiler-option](compiler/compiler-options.html#js-compiler-option)
*
[js-default-initializers](compiler/compiler-options.html#js-default-initializers)
*
[js-dynamic-access-unknown-members](compiler/compiler-options.html#js-dynamic-access-unknown-members)
@@ -43,12 +44,14 @@ List of available compiler options
* [js-output](compiler/compiler-options.html#js-output)
*
[js-vector-emulation-class](compiler/compiler-options.html#js-vector-emulation-class)
* [jsx-factory](compiler/compiler-options.html#jsx-factory)
+* [keep-asdoc](compiler/compiler-options.html#keep-asdoc)
* [remove-circulars](compiler/compiler-options.html#remove-circulars)
+* [show-binding-warnings](compiler/compiler-options.html#show-binding-warnings)
+* [skip-transpile](compiler/compiler-options.html#skip-transpile)
* [source-map](compiler/compiler-options.html#source-map)
*
[source-map-source-root](compiler/compiler-options.html#source-map-source-root)
* [targets](compiler/compiler-options.html#targets)
* [warn-public-vars](compiler/compiler-options.html#warn-public-vars)
-* [show-binding-warnings](compiler/compiler-options.html#show-binding-warnings)
**Reduce output size**
You can use these options to reduce the size of your compiled application:
@@ -88,20 +91,20 @@ Determines if the `abstract` modifier may be used with
classes. For more details
-allow-abstract-classes
```
-### allow-private-constructors {#allow-private-constructors}
+### allow-import-aliases {#allow-import-aliases}
-Determines if the `private` namespace may be used with class constructors. For
more details, see [Private Constructors in
ActionScript](features/actionscript/private-constructors.html).
+Determines if alias syntax for for imported symbols is allowed or not.
```sh
--allow-private-constructors
+-allow-import-aliases
```
-### allow-import-aliases {#allow-import-aliases}
+### allow-private-constructors {#allow-private-constructors}
-Determines if alias syntax for for imported symbols is allowed or not.
+Determines if the `private` namespace may be used with class constructors. For
more details, see [Private Constructors in
ActionScript](features/actionscript/private-constructors.html).
```sh
--allow-import-aliases
+-allow-private-constructors
```
### strict-identifier-names {#strict-identifier-names}
@@ -114,6 +117,14 @@ Determines if names of identifiers must follow the strict
rules of ActionScript
## JavaScript compiler options
+### closure-lib {#closure-lib}
+
+Sets the path to a custom distribution of Google's Closure library, instead of
the default version used by the compiler.
+
+```sh
+-closure-lib path/to/closure
+```
+
### html-output-filename {#html-output-filename}
Specifies the file name of the HTML file generated by the compiler to load the
Apache Royale application in the browser.
@@ -136,6 +147,20 @@ Specifies the path to an optional template for the HTML
file generated by the co
<htmlTemplate>${basedir}/target/javascript/bin/js-debug/jewel-example-index-template.html</htmlTemplate>
```
+## inline-constants {#inline-constants}
+
+Determines if primitive constant values (such as numbers, booleans, and
strings) will be inlined.
+
+```sh
+-inline-constants
+```
+
+#### Maven configuration:
+
+```xml
+<additionalCompilerOptions>-inline-constants=true;</additionalCompilerOptions>
+```
+
### js-compiler-option {#js-compiler-option}
Specifies one or more custom compiler options to pass to the Google Closure
Compiler, which is used to create the release build of an Apache Royale
application.
@@ -265,6 +290,20 @@ Customize the factory to use for JSX syntax. Defaults to
`React.createElement`.
<additionalCompilerOptions>-jsx-factory=_jsx;</additionalCompilerOptions>
```
+### keep-asdoc {#keep-asdoc}
+
+Determines if asdoc comment annotations are kept in the generated JavaScript.
+
+```sh
+-keep-asdoc=false
+```
+
+#### Maven configuration:
+
+```xml
+<additionalCompilerOptions>-keep-asdoc=false;</additionalCompilerOptions>
+```
+
### remove-circulars {#remove-circulars}
Tells the Apache Royale compiler to remove circular dependencies in the
generated JavaScript, where possible.
@@ -279,6 +318,34 @@ Tells the Apache Royale compiler to remove circular
dependencies in the generate
<removeCirculars>true</removeCirculars>
```
+### show-binding-warnings {#show-binding-warnings}
+
+Set to false to remove all binding warnings.
+
+```sh
+-show-binding-warnings=false
+```
+
+#### Maven configuration:
+
+```xml
+<additionalCompilerOptions>-show-binding-warnings=false;</additionalCompilerOptions>
+```
+
+### skip-transpile {#skip-transpile}
+
+**(Advanced)** Set to false to skip transpiling ActionScript and MXML to
JavaScript, and only run the release build. Generally used by contributors to
the compiler only. Default s to `false`.
+
+```sh
+-skip-transpile=true
+```
+
+#### Maven configuration:
+
+```xml
+<additionalCompilerOptions>-skip-transpile=true;</additionalCompilerOptions>
+```
+
### source-map {#source-map}
Emits a source map in the debug build for each ActionScript file. The default
value is false.
@@ -343,20 +410,6 @@ Enables or disables warnings about using public variables
when it may be conside
<additionalCompilerOptions>-warn-public-vars=true;</additionalCompilerOptions>
```
-### show-binding-warnings {#show-binding-warnings}
-
-Set to false to remove all binding warnings.
-
-```sh
--show-binding-warnings=false
-```
-
-#### Maven configuration:
-
-```xml
-<additionalCompilerOptions>-show-binding-warnings=false;</additionalCompilerOptions>
-```
-
## Reduce size of release builds
