[CLI] Update CLI argument descriptions after review

This commit is contained in:
Kirill Rakhman
2023-10-31 13:17:55 +01:00
committed by Space Team
parent bc8841c6fe
commit 4964ee12a9
25 changed files with 825 additions and 823 deletions
+33 -33
View File
@@ -1,44 +1,44 @@
Usage: kotlinc-js <options> <source files>
where possible options include:
-libraries <path> Paths to Kotlin libraries with .meta.js and .kjsm files, separated by system path separator
-main {call|noCall} Define whether the `main` function should be called upon execution
-meta-info Generate .meta.js and .kjsm files with metadata. Use to create a library
-libraries <path> Paths to Kotlin libraries with .meta.js and .kjsm files, separated by the system path separator.
-main {call|noCall} Specify whether the 'main' function should be called upon execution.
-meta-info Generate .meta.js and .kjsm files with metadata. Use this to create a library.
-module-kind {plain|amd|commonjs|umd|es}
Kind of the JS module generated by the compiler
-ir-output-name Base name of generated files
-no-stdlib Don't automatically include the default Kotlin/JS stdlib into compilation dependencies
-ir-output-dir <directory> Destination for generated files
-output <filepath> Destination *.js file for the compilation result
-output-postfix <path> Add the content of the specified file to the end of output file
-output-prefix <path> Add the content of the specified file to the beginning of output file
-source-map Generate source map
-source-map-base-dirs <path> Base directories for calculating relative paths to source files in source map
The kind of JS module generated by the compiler.
-ir-output-name Base name of generated files.
-no-stdlib Don't automatically include the default Kotlin/JS stdlib in compilation dependencies.
-ir-output-dir <directory> Destination for generated files.
-output <filepath> Destination *.js file for the compilation result.
-output-postfix <path> Add the content of the specified file to the end of the output file.
-output-prefix <path> Add the content of the specified file to the beginning of the output file.
-source-map Generate a source map.
-source-map-base-dirs <path> Base directories for calculating relative paths to source files in the source map.
-source-map-embed-sources {always|never|inlining}
Embed source files into source map
Embed source files into the source map.
-source-map-names-policy {no|simple-names|fully-qualified-names}
How to map generated names to original names (IR backend only)
-source-map-prefix Add the specified prefix to paths in the source map
-target { v5 } Generate JS files for specific ECMA version
-Werror Report an error if there are any warnings
-api-version <version> Allow using declarations only from the specified version of bundled libraries
-X Print a synopsis of advanced options
-help (-h) Print a synopsis of standard options
-kotlin-home <path> Path to the home directory of Kotlin compiler used for discovery of runtime libraries
-language-version <version> Provide source compatibility with the specified version of Kotlin
-opt-in <fq.name> Enable usages of API that requires opt-in with an opt-in requirement marker with the given fully qualified name
Mode for mapping generated names to original names (IR backend only).
-source-map-prefix Add the specified prefix to the paths in the source map.
-target { v5 } Generate JS files for the specified ECMA version.
-Werror Report an error if there are any warnings.
-api-version <version> Allow using declarations from only the specified version of bundled libraries.
-X Print a synopsis of advanced options.
-help (-h) Print a synopsis of standard options.
-kotlin-home <path> Path to the Kotlin compiler home directory used for the discovery of runtime libraries.
-language-version <version> Provide source compatibility with the specified version of Kotlin.
-opt-in <fq.name> Enable API usages that require opt-in with an opt-in requirement marker with the given fully qualified name.
-P plugin:<pluginId>:<optionName>=<value>
Pass an option to a plugin
Pass an option to a plugin.
-progressive Enable progressive compiler mode.
In this mode, deprecations and bug fixes for unstable code take effect immediately,
In this mode, deprecations and bug fixes for unstable code take effect immediately
instead of going through a graceful migration cycle.
Code written in the progressive mode is backward compatible; however, code written in
non-progressive mode may cause compilation errors in the progressive mode.
-script Evaluate the given Kotlin script (*.kts) file
-nowarn Generate no warnings
-verbose Enable verbose logging output
-version Display compiler version
-J<option> Pass an option directly to JVM
@<argfile> Read compiler arguments and file paths from the given file
Code written in progressive mode is backward compatible; however, code written without
progressive mode enabled may cause compilation errors in progressive mode.
-script Evaluate the given Kotlin script (*.kts) file.
-nowarn Don't generate any warnings.
-verbose Enable verbose logging output.
-version Display the compiler version.
-J<option> Pass an option directly to JVM.
@<argfile> Read compiler arguments and file paths from the given file.
For details, see https://kotl.in/cli
OK