org.jetbrains.kotlin.cli.common.arguments.K2JSCompilerArguments.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-client-embeddable Show documentation
Show all versions of kotlin-compiler-client-embeddable Show documentation
Kotlin compiler client embeddable
/*
* Copyright 2010-2024 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.cli.common.arguments
import org.jetbrains.kotlin.cli.common.arguments.K2JsArgumentConstants.*
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
import org.jetbrains.kotlin.cli.common.messages.MessageCollector
import org.jetbrains.kotlin.config.*
import org.jetbrains.kotlin.config.AnalysisFlags.allowFullyQualifiedNameInKClass
class K2JSCompilerArguments : CommonKlibBasedCompilerArguments() {
companion object {
@JvmStatic private val serialVersionUID = 0L
}
// TODO: KT-70222 Remove this option in 2.2
@Deprecated("It is senseless to use with IR compiler. Only for compatibility.")
@Argument(
value = "-output",
valueDescription = "",
description = """This option does nothing and is left for compatibility with the legacy backend.
It is deprecated and will be removed in Kotlin 2.2."""
)
var outputFile: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(value = "-ir-output-dir", valueDescription = "", description = "Destination for generated files.")
var outputDir: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.STRING_NULL_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(value = "-ir-output-name", description = "Base name of generated files.")
var moduleName: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.BOOLEAN_FALSE_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@GradleDeprecatedOption(
message = "Only for legacy backend.",
level = DeprecationLevel.ERROR, // TODO: KT-70222 Remove completely in 2.2
removeAfter = LanguageVersion.KOTLIN_2_2,
)
@Deprecated("It is senseless to use with IR compiler. Only for compatibility.")
@Argument(
value = "-no-stdlib",
description = """This option does nothing and is left for compatibility with the legacy backend.
It is deprecated and will be removed in Kotlin 2.2."""
)
var noStdlib = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-libraries",
valueDescription = "",
description = "Paths to Kotlin libraries with .meta.js and .kjsm files, separated by the system path separator."
)
var libraries: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.BOOLEAN_FALSE_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(value = "-source-map", description = "Generate a source map.")
var sourceMap = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xwasm-debugger-custom-formatters",
description = "Generates devtools custom formatters (https://firefox-source-docs.mozilla.org/devtools-user/custom_formatters) for Kotlin/Wasm values"
)
var debuggerCustomFormatters = false
set(value) {
checkFrozen()
field = value
}
@GradleOption(
value = DefaultValue.STRING_NULL_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(value = "-source-map-prefix", description = "Add the specified prefix to the paths in the source map.")
var sourceMapPrefix: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-source-map-base-dirs",
deprecatedName = "-source-map-source-roots",
valueDescription = "",
description = "Base directories for calculating relative paths to source files in the source map."
)
var sourceMapBaseDirs: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
/**
* SourceMapEmbedSources should be null by default, since it has effect only when source maps are enabled.
* When sourceMapEmbedSources are not null and source maps is disabled warning is reported.
*/
@GradleOption(
value = DefaultValue.JS_SOURCE_MAP_CONTENT_MODES,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(
value = "-source-map-embed-sources",
valueDescription = "{always|never|inlining}",
description = "Embed source files into the source map."
)
var sourceMapEmbedSources: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.JS_SOURCE_MAP_NAMES_POLICY,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(
value = "-source-map-names-policy",
valueDescription = "{no|simple-names|fully-qualified-names}",
description = "Mode for mapping generated names to original names."
)
var sourceMapNamesPolicy: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.BOOLEAN_FALSE_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@GradleDeprecatedOption(
message = "Only for legacy backend.",
level = DeprecationLevel.ERROR, // TODO: KT-70222 Remove completely in 2.2
removeAfter = LanguageVersion.KOTLIN_2_2,
)
@Deprecated("It is senseless to use with IR compiler. Only for compatibility.")
@Argument(
value = "-meta-info",
description = """This option does nothing and is left for compatibility with the legacy backend.
It is deprecated and will be removed in Kotlin 2.2."""
)
var metaInfo = false
set(value) {
checkFrozen()
field = value
}
@GradleOption(
value = DefaultValue.JS_ECMA_VERSIONS,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(value = "-target", valueDescription = "{ es5, es2015 }", description = "Generate JS files for the specified ECMA version.")
var target: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xir-keep",
description = "Comma-separated list of fully qualified names not to be eliminated by DCE (if it can be reached), " +
"and for which to keep non-minified names."
)
var irKeep: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@GradleOption(
value = DefaultValue.JS_MODULE_KINDS,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(
value = "-module-kind",
valueDescription = "{plain|amd|commonjs|umd|es}",
description = "The kind of JS module generated by the compiler. ES modules are enabled by default in case of ES2015 target usage"
)
var moduleKind: String? = null
set(value) {
checkFrozen()
field = value
}
@GradleOption(
value = DefaultValue.JS_MAIN,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(
value = "-main",
valueDescription = "{$CALL|$NO_CALL}",
description = "Specify whether the 'main' function should be called upon execution."
)
var main: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
// Advanced options
@Argument(
value = "-Xir-produce-klib-dir",
description = "Generate an unpacked klib into the parent directory of the output JS file."
)
var irProduceKlibDir = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-produce-klib-file",
description = "Generate a packed klib into the directory specified by '-ir-output-dir'."
)
var irProduceKlibFile = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xir-produce-js", description = "Generate a JS file using the IR backend.")
var irProduceJs = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xir-dce", description = "Perform experimental dead code elimination.")
var irDce = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-dce-runtime-diagnostic",
valueDescription = "{$RUNTIME_DIAGNOSTIC_LOG|$RUNTIME_DIAGNOSTIC_EXCEPTION}",
description = "Enable runtime diagnostics instead of removing declarations when performing DCE."
)
var irDceRuntimeDiagnostic: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xir-dce-print-reachability-info",
description = "Print reachability information about declarations to 'stdout' while performing DCE."
)
var irDcePrintReachabilityInfo = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xwasm-source-map-include-mappings-from-unavailable-sources",
description = "Insert source mappings from libraries even if their sources are unavailable on the end-user machine."
)
var includeUnavailableSourcesIntoSourceMap = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-dce-dump-reachability-info-to-file",
valueDescription = "",
description = "Dump reachability information collected about declarations while performing DCE to a file. " +
"The format will be chosen automatically based on the file extension. " +
"Supported output formats include JSON for .json, a JS const initialized with a plain object containing information for .js, " +
"and plain text for all other file types."
)
var irDceDumpReachabilityInfoToFile: String? = null
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-dump-declaration-ir-sizes-to-file",
valueDescription = "",
description = "Dump the IR size of each declaration into a file. " +
"The format will be chosen automatically depending on the file extension. " +
"Supported output formats include JSON for .json, a JS const initialized with a plain object containing information for .js, " +
"and plain text for all other file types."
)
var irDceDumpDeclarationIrSizesToFile: String? = null
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xir-property-lazy-initialization", description = "Perform lazy initialization for properties.")
var irPropertyLazyInitialization = true
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xir-minimized-member-names", description = "Minimize the names of members.")
var irMinimizedMemberNames = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-module-name",
valueDescription = "",
description = "Specify the name of the compilation module for the IR backend."
)
var irModuleName: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xir-safe-external-boolean",
description = "Wrap access to external 'Boolean' properties with an explicit conversion to 'Boolean'."
)
var irSafeExternalBoolean = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-safe-external-boolean-diagnostic",
valueDescription = "{$RUNTIME_DIAGNOSTIC_LOG|$RUNTIME_DIAGNOSTIC_EXCEPTION}",
description = "Enable runtime diagnostics when accessing external 'Boolean' properties."
)
var irSafeExternalBooleanDiagnostic: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(value = "-Xir-per-module", description = "Generate one .js file per module.")
var irPerModule = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xir-per-module-output-name", description = "Add a custom output name to the split .js files.")
var irPerModuleOutputName: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(value = "-Xir-per-file", description = "Generate one .js file per source file.")
var irPerFile = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xir-generate-inline-anonymous-functions",
description = "Lambda expressions that capture values are translated into in-line anonymous JavaScript functions."
)
var irGenerateInlineAnonymousFunctions = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xinclude",
valueDescription = "",
description = "Path to an intermediate library that should be processed in the same manner as source files."
)
var includes: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xcache-directory",
valueDescription = "",
description = "Path to the cache directory."
)
var cacheDirectory: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(value = "-Xir-build-cache", description = "Use the compiler to build the cache.")
var irBuildCache = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xgenerate-dts",
description = "Generate a TypeScript declaration .d.ts file alongside the JS file."
)
var generateDts = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xgenerate-polyfills",
description = "Generate polyfills for features from the ES6+ standards."
)
var generatePolyfills = true
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xstrict-implicit-export-types",
description = "Generate strict types for implicitly exported entities inside d.ts files."
)
var strictImplicitExportType = false
set(value) {
checkFrozen()
field = value
}
@GradleOption(
value = DefaultValue.BOOLEAN_NULL_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(
value = "-Xes-classes",
description = "Let generated JavaScript code use ES2015 classes. Enabled by default in case of ES2015 target usage"
)
var useEsClasses: Boolean? = null
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xplatform-arguments-in-main-function",
description = "JS expression that will be executed in runtime and be put as an Array parameter of the main function"
)
var platformArgumentsProviderJsExpression: String? = null
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xes-generators",
description = "Enable ES2015 generator functions usage inside the compiled code. Enabled by default in case of ES2015 target usage"
)
var useEsGenerators: Boolean? = null
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xes-arrow-functions",
description = "Use ES2015 arrow functions in the JavaScript code generated for Kotlin lambdas. " +
"Enabled by default in case of ES2015 target usage"
)
var useEsArrowFunctions: Boolean? = null
set(value) {
checkFrozen()
field = value
}
@Deprecated("It is senseless to use with IR compiler. Only for compatibility.")
@GradleOption(
value = DefaultValue.BOOLEAN_FALSE_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@GradleDeprecatedOption(
message = "Only for legacy backend.",
level = DeprecationLevel.WARNING, // TODO: KT-70222 Replace with ERROR in 2.2, remove completely in 2.3
removeAfter = LanguageVersion.KOTLIN_2_2,
)
@Argument(
value = "-Xtyped-arrays",
description = """This option does nothing and is left for compatibility with the legacy backend.
It is deprecated and will be removed in a future release."""
)
var typedArrays = false
set(value) {
checkFrozen()
field = value
}
@GradleOption(
value = DefaultValue.BOOLEAN_FALSE_DEFAULT,
gradleInputType = GradleInputTypes.INPUT,
shouldGenerateDeprecatedKotlinOptions = true,
)
@Argument(value = "-Xfriend-modules-disabled", description = "Disable internal declaration export.")
var friendModulesDisabled = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xfriend-modules",
valueDescription = "",
description = "Paths to friend modules."
)
var friendModules: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xenable-extension-functions-in-externals",
description = "Enable extension function members in external interfaces."
)
var extensionFunctionsInExternals = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xfake-override-validator", description = "Enable the IR fake override validator.")
var fakeOverrideValidator = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm", description = "Use the experimental WebAssembly compiler backend.")
var wasm = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-preserve-ic-order", description = "Preserve wasm file structure between IC runs.")
var preserveIcOrder = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-debug-info", description = "Add debug info to the compiled WebAssembly module.")
var wasmDebug = true
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-kclass-fqn", description = "Enable support for 'KClass.qualifiedName'.")
var wasmKClassFqn = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-enable-array-range-checks", description = "Turn on range checks for array access functions.")
var wasmEnableArrayRangeChecks = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-enable-asserts", description = "Turn on asserts.")
var wasmEnableAsserts = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-generate-wat", description = "Generate a .wat file.")
var wasmGenerateWat = false
set(value) {
checkFrozen()
field = value
}
@Argument(value = "-Xwasm-target", description = "Set up the Wasm target (wasm-js or wasm-wasi).")
var wasmTarget: String? = null
set(value) {
checkFrozen()
field = if (value.isNullOrEmpty()) null else value
}
@Argument(
value = "-Xwasm-use-traps-instead-of-exceptions",
description = "Use traps instead of throwing exceptions."
)
var wasmUseTrapsInsteadOfExceptions = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xwasm-use-new-exception-proposal",
description = "Use an updated version of the exception proposal with try_table."
)
var wasmUseNewExceptionProposal = false
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xwasm-attach-js-exception",
description = "Attach a thrown by JS-value to the JsException class"
)
var wasmUseJsTag: Boolean? = null
set(value) {
checkFrozen()
field = value
}
@Argument(
value = "-Xoptimize-generated-js",
description = "Perform additional optimizations on the generated JS code."
)
var optimizeGeneratedJs = true
set(value) {
checkFrozen()
field = value
}
private fun MessageCollector.deprecationWarn(value: Boolean, defaultValue: Boolean, name: String) {
if (value != defaultValue) {
report(CompilerMessageSeverity.WARNING, "'$name' is deprecated and ignored, it will be removed in a future release")
}
}
override fun configureAnalysisFlags(collector: MessageCollector, languageVersion: LanguageVersion): MutableMap, Any> {
if (irPerFile && (moduleKind != MODULE_ES && target != ES_2015)) {
collector.report(
CompilerMessageSeverity.ERROR,
"Per-file compilation can't be used with any `moduleKind` except `es` (ECMAScript Modules)"
)
}
return super.configureAnalysisFlags(collector, languageVersion).also {
it[allowFullyQualifiedNameInKClass] = wasm && wasmKClassFqn //Only enabled WASM BE supports this flag
}
}
override fun checkIrSupport(languageVersionSettings: LanguageVersionSettings, collector: MessageCollector) {
if (languageVersionSettings.languageVersion < LanguageVersion.KOTLIN_1_4
|| languageVersionSettings.apiVersion < ApiVersion.KOTLIN_1_4
) {
collector.report(
CompilerMessageSeverity.ERROR,
"JS backend cannot be used with language or API version below 1.4"
)
}
}
override fun configureLanguageFeatures(collector: MessageCollector): MutableMap {
return super.configureLanguageFeatures(collector).apply {
if (extensionFunctionsInExternals) {
this[LanguageFeature.JsEnableExtensionFunctionInExternals] = LanguageFeature.State.ENABLED
}
this[LanguageFeature.JsAllowValueClassesInExternals] = LanguageFeature.State.ENABLED
if (wasm) {
this[LanguageFeature.JsAllowImplementingFunctionInterface] = LanguageFeature.State.ENABLED
}
}
}
override fun copyOf(): Freezable = copyK2JSCompilerArguments(this, K2JSCompilerArguments())
}