com.caoccao.javet.swc4j.options.Swc4jTranspileOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swc4j-android Show documentation
swc4j (SWC for Java) is an ultra-fast JavaScript and TypeScript compilation and bundling tool on JVM.
The newest version!
/*
 * Copyright (c) 2024. caoccao.com Sam Cao
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.caoccao.javet.swc4j.options;

import com.caoccao.javet.swc4j.enums.*;
import com.caoccao.javet.swc4j.jni2rust.Jni2RustClass;
import com.caoccao.javet.swc4j.jni2rust.Jni2RustFilePath;
import com.caoccao.javet.swc4j.jni2rust.Jni2RustMethod;
import com.caoccao.javet.swc4j.plugins.ISwc4jPluginHost;
import com.caoccao.javet.swc4j.utils.AssertionUtils;

import java.net.URL;
import java.util.List;

/**
 * The type Swc4j transpile options.
 *
 * @since 0.1.0
 */
@Jni2RustClass(filePath = Jni2RustFilePath.Options)
public class Swc4jTranspileOptions extends Swc4jParseOptions {
    /**
     * The constant DEFAULT_JSX_FACTORY.
     *
     * @since 0.1.0
     */
    public static final String DEFAULT_JSX_FACTORY = "React.createElement";
    /**
     * The constant DEFAULT_JSX_FRAGMENT_FACTORY.
     *
     * @since 0.1.0
     */
    public static final String DEFAULT_JSX_FRAGMENT_FACTORY = "React.Fragment";
    /**
     * When emitting a legacy decorator, whether also emit experimental decorator meta data.
     * Defaults to `false`.
     *
     * @since 0.1.0
     */
    protected boolean emitMetadata;
    /**
     * What to do with import statements that only import types i.e. whether to
     * remove them (`Remove`), keep them as side-effect imports (`Preserve`)
     * or error (`Error`). Defaults to `Remove`.
     *
     * @since 0.1.0
     */
    protected Swc4jImportsNotUsedAsValues importsNotUsedAsValues;
    /**
     * Should the sources be inlined in the source map.
     * Defaults to `true`.
     *
     * @since 0.1.0
     */
    protected boolean inlineSources;
    /**
     * `true` if the program should use an implicit JSX import source/the `new` JSX transforms.
     * Defaults to `false`.
     *
     * @since 0.1.0
     */
    protected boolean jsxAutomatic;
    /**
     * If JSX is automatic, if it is in development mode, meaning that it should
     * import `jsx-dev-runtime` and transform JSX using `jsxDEV` import from the
     * JSX import source as well as provide additional debug information to the
     * JSX factory.
     *
     * @since 0.1.0
     */
    protected boolean jsxDevelopment;
    /**
     * When transforming JSX, what value should be used for the JSX factory.
     * Defaults to `React.createElement`.
     *
     * @since 0.1.0
     */
    protected String jsxFactory;
    /**
     * When transforming JSX, what value should be used for the JSX fragment factory.
     * Defaults to `React.Fragment`.
     *
     * @since 0.1.0
     */
    protected String jsxFragmentFactory;
    /**
     * The string module specifier to implicitly import JSX factories from when transpiling JSX.
     *
     * @since 0.1.0
     */
    protected String jsxImportSource;
    /**
     * Whether to keep comments in the output. Defaults to `false`.
     *
     * @since 0.3.0
     */
    protected boolean keepComments;
    /**
     * The kind of module being transpiled.
     * Defaults to being derived from the media type of the parsed source.
     *
     * @since 1.2.0
     */
    protected Swc4jModuleKind moduleKind;
    /**
     * Should JSX be precompiled into static strings that need to be concatenated
     * with dynamic content. Defaults to `false`, mutually exclusive with
     * `transform_jsx`.
     *
     * @since 0.1.0
     */
    protected boolean precompileJsx;
    /**
     * List of properties/attributes that should always be treated as dynamic.
     *
     * @since 0.10.0
     */
    protected List precompileJsxDynamicProps;
    /**
     * List of elements that should not be precompiled when the JSX precompile transform is used.
     *
     * @since 0.7.0
     */
    protected List precompileJsxSkipElements;
    /**
     * How and if source maps should be generated.
     *
     * @since 0.1.0
     */
    protected Swc4jSourceMapOption sourceMap;
    /**
     * Should JSX be transformed. Defaults to `true`.
     *
     * @since 0.1.0
     */
    protected boolean transformJsx;
    /**
     * TC39 Decorators Proposal - https://github.com/tc39/proposal-decorators
     *
     * @since 0.3.0
     */
    protected boolean useDecoratorsProposal;
    /**
     * TypeScript experimental decorators.
     *
     * @since 0.3.0
     */
    protected boolean useTsDecorators;
    /**
     * Should import declarations be transformed to variable declarations using
     * a dynamic import. This is useful for import and export declaration support
     * in script contexts such as the Deno REPL.  Defaults to `false`.
     *
     * @since 0.1.0
     */
    protected boolean varDeclImports;
    /**
     * `true` changes type stripping behaviour so that _only_ `type` imports are stripped.
     *
     * @since 1.2.0
     */
    protected boolean verbatimModuleSyntax;

    /**
     * Instantiates a new Swc4j transpile options.
     *
     * @since 0.1.0
     */
    public Swc4jTranspileOptions() {
        super();
        setEmitMetadata(false);
        setImportsNotUsedAsValues(Swc4jImportsNotUsedAsValues.Remove);
        setJsxAutomatic(false);
        setJsxDevelopment(false);
        setJsxFactory(DEFAULT_JSX_FACTORY);
        setJsxFragmentFactory(DEFAULT_JSX_FRAGMENT_FACTORY);
        setJsxImportSource(null);
        setInlineSources(true);
        setKeepComments(false);
        setModuleKind(Swc4jModuleKind.Auto);
        setPrecompileJsx(false);
        setPrecompileJsxDynamicProps(null);
        setPrecompileJsxSkipElements(null);
        setSourceMap(Swc4jSourceMapOption.Inline);
        setTransformJsx(true);
        setVarDeclImports(false);
        setVerbatimModuleSyntax(false);
        setUseTsDecorators(false);
    }

    /**
     * Gets imports not used as values.
     *
     * @return the imports not used as values
     * @since 0.1.0
     */
    @Jni2RustMethod
    public Swc4jImportsNotUsedAsValues getImportsNotUsedAsValues() {
        return importsNotUsedAsValues;
    }

    /**
     * Gets jsx factory.
     *
     * @return the jsx factory
     * @since 0.1.0
     */
    @Jni2RustMethod
    public String getJsxFactory() {
        return jsxFactory;
    }

    /**
     * Gets jsx fragment factory.
     *
     * @return the jsx fragment factory
     * @since 0.1.0
     */
    @Jni2RustMethod
    public String getJsxFragmentFactory() {
        return jsxFragmentFactory;
    }

    /**
     * Gets jsx import source.
     *
     * @return the jsx import source
     * @since 0.1.0
     */
    @Jni2RustMethod(optional = true)
    public String getJsxImportSource() {
        return jsxImportSource;
    }

    /**
     * Gets module kind.
     *
     * @return the module kind
     * @since 1.2.0
     */
    @Jni2RustMethod
    public Swc4jModuleKind getModuleKind() {
        return moduleKind;
    }

    /**
     * Gets precompile jsx dynamic props.
     *
     * @return the precompile jsx dynamic props
     * @since 0.10.0
     */
    @Jni2RustMethod(optional = true)
    public List getPrecompileJsxDynamicProps() {
        return precompileJsxDynamicProps;
    }

    /**
     * Gets precompile jsx skip elements.
     *
     * @return the precompile jsx skip elements
     * @since 0.7.0
     */
    @Jni2RustMethod(optional = true)
    public List getPrecompileJsxSkipElements() {
        return precompileJsxSkipElements;
    }

    /**
     * Gets source map.
     *
     * @return the source map
     * @since 0.3.0
     */
    @Jni2RustMethod
    public Swc4jSourceMapOption getSourceMap() {
        return sourceMap;
    }

    /**
     * Is emit metadata.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isEmitMetadata() {
        return emitMetadata;
    }

    /**
     * Is inline sources.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isInlineSources() {
        return inlineSources;
    }

    /**
     * Is jsx automatic.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isJsxAutomatic() {
        return jsxAutomatic;
    }

    /**
     * Is jsx development.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isJsxDevelopment() {
        return jsxDevelopment;
    }

    /**
     * Is keep comments.
     *
     * @return true : yes, false : no
     * @since 0.3.0
     */
    @Jni2RustMethod
    public boolean isKeepComments() {
        return keepComments;
    }

    /**
     * Is precompile jsx.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isPrecompileJsx() {
        return precompileJsx;
    }

    /**
     * Is transform jsx.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isTransformJsx() {
        return transformJsx;
    }

    /**
     * Is use decorators proposal.
     *
     * @return true : yes, false : no
     * @since 0.3.0
     */
    @Jni2RustMethod
    public boolean isUseDecoratorsProposal() {
        return useDecoratorsProposal;
    }

    /**
     * Is use ts decorators.
     *
     * @return true : yes, false : no
     * @since 0.3.0
     */
    @Jni2RustMethod
    public boolean isUseTsDecorators() {
        return useTsDecorators;
    }

    /**
     * Is var decl imports.
     *
     * @return true : yes, false : no
     * @since 0.1.0
     */
    @Jni2RustMethod
    public boolean isVarDeclImports() {
        return varDeclImports;
    }

    /**
     * Is verbatim module syntax.
     *
     * @return true : yes, false : no
     * @since 1.2.0
     */
    @Jni2RustMethod
    public boolean isVerbatimModuleSyntax() {
        return verbatimModuleSyntax;
    }

    @Override
    public Swc4jTranspileOptions setCaptureAst(boolean captureAst) {
        super.setCaptureAst(captureAst);
        return this;
    }

    @Override
    public Swc4jTranspileOptions setCaptureComments(boolean captureComments) {
        super.setCaptureComments(captureComments);
        return this;
    }

    @Override
    public Swc4jTranspileOptions setCaptureTokens(boolean captureTokens) {
        super.setCaptureTokens(captureTokens);
        return this;
    }

    /**
     * Sets emit metadata.
     *
     * @param emitMetadata the emit metadata
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setEmitMetadata(boolean emitMetadata) {
        this.emitMetadata = emitMetadata;
        return this;
    }

    /**
     * Sets imports not used as values.
     *
     * @param importsNotUsedAsValues the imports not used as values
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setImportsNotUsedAsValues(Swc4jImportsNotUsedAsValues importsNotUsedAsValues) {
        this.importsNotUsedAsValues = AssertionUtils.notNull(importsNotUsedAsValues, "Imports not used as values");
        return this;
    }

    /**
     * Sets inline sources.
     *
     * @param inlineSources the inline sources
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setInlineSources(boolean inlineSources) {
        this.inlineSources = inlineSources;
        return this;
    }

    /**
     * Sets jsx automatic.
     *
     * @param jsxAutomatic the jsx automatic
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setJsxAutomatic(boolean jsxAutomatic) {
        this.jsxAutomatic = jsxAutomatic;
        return this;
    }

    /**
     * Sets jsx development.
     *
     * @param jsxDevelopment the jsx development
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setJsxDevelopment(boolean jsxDevelopment) {
        this.jsxDevelopment = jsxDevelopment;
        return this;
    }

    /**
     * Sets jsx factory.
     *
     * @param jsxFactory the jsx factory
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setJsxFactory(String jsxFactory) {
        this.jsxFactory = AssertionUtils.notNull(jsxFactory, "Jsx factory");
        return this;
    }

    /**
     * Sets jsx fragment factory.
     *
     * @param jsxFragmentFactory the jsx fragment factory
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setJsxFragmentFactory(String jsxFragmentFactory) {
        this.jsxFragmentFactory = AssertionUtils.notNull(jsxFragmentFactory, "Jsx fragment factory");
        return this;
    }

    /**
     * Sets jsx import source.
     *
     * @param jsxImportSource the jsx import source
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setJsxImportSource(String jsxImportSource) {
        this.jsxImportSource = jsxImportSource;
        return this;
    }

    /**
     * Sets keep comments.
     *
     * @param keepComments the keep comments
     * @return the self
     * @since 0.3.0
     */
    public Swc4jTranspileOptions setKeepComments(boolean keepComments) {
        this.keepComments = keepComments;
        return this;
    }

    /**
     * Sets Media type of the source text.
     *
     * @param mediaType the Media type of the source text
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setMediaType(Swc4jMediaType mediaType) {
        super.setMediaType(mediaType);
        return this;
    }

    /**
     * Sets module kind.
     *
     * @param moduleKind the module kind
     * @return the self
     * @since 1.2.0
     */
    public Swc4jTranspileOptions setModuleKind(Swc4jModuleKind moduleKind) {
        this.moduleKind = AssertionUtils.notNull(moduleKind, "Module kind");
        return this;
    }

    /**
     * Sets parse mode.
     *
     * @param parseMode the parse mode
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setParseMode(Swc4jParseMode parseMode) {
        super.setParseMode(parseMode);
        return this;
    }

    @Override
    public Swc4jTranspileOptions setPluginHost(ISwc4jPluginHost pluginHost) {
        super.setPluginHost(pluginHost);
        return this;
    }

    /**
     * Sets precompile jsx.
     *
     * @param precompileJsx the precompile jsx
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setPrecompileJsx(boolean precompileJsx) {
        this.precompileJsx = precompileJsx;
        return this;
    }

    /**
     * Sets precompile jsx dynamic props.
     *
     * @param precompileJsxDynamicProps the precompile jsx dynamic props
     * @since 0.10.0
     */
    public void setPrecompileJsxDynamicProps(List precompileJsxDynamicProps) {
        this.precompileJsxDynamicProps = precompileJsxDynamicProps;
    }

    /**
     * Sets precompile jsx skip elements.
     *
     * @param precompileJsxSkipElements the precompile jsx skip elements
     * @return the self
     * @since 0.7.0
     */
    public Swc4jTranspileOptions setPrecompileJsxSkipElements(List precompileJsxSkipElements) {
        this.precompileJsxSkipElements = precompileJsxSkipElements;
        return this;
    }

    /**
     * Sets scope analysis.
     *
     * @param scopeAnalysis the scope analysis
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setScopeAnalysis(boolean scopeAnalysis) {
        super.setScopeAnalysis(scopeAnalysis);
        return this;
    }

    /**
     * Sets source map.
     *
     * @param sourceMap the source map
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setSourceMap(Swc4jSourceMapOption sourceMap) {
        this.sourceMap = AssertionUtils.notNull(sourceMap, "Source map");
        return this;
    }

    /**
     * Sets Specifier of the source text.
     *
     * @param specifier the Specifier of the source text
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setSpecifier(URL specifier) {
        super.setSpecifier(specifier);
        return this;
    }

    /**
     * Sets transform jsx.
     *
     * @param transformJsx the transform jsx
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setTransformJsx(boolean transformJsx) {
        this.transformJsx = transformJsx;
        return this;
    }

    /**
     * Sets use decorator proposal.
     *
     * @param useDecoratorsProposal the use decorator proposal
     * @return the self
     * @since 0.3.0
     */
    public Swc4jTranspileOptions setUseDecoratorsProposal(boolean useDecoratorsProposal) {
        this.useDecoratorsProposal = useDecoratorsProposal;
        return this;
    }

    /**
     * Sets use ts decorators.
     *
     * @param useTsDecorators the use ts decorators
     * @return the self
     * @since 0.3.0
     */
    public Swc4jTranspileOptions setUseTsDecorators(boolean useTsDecorators) {
        this.useTsDecorators = useTsDecorators;
        return this;
    }

    /**
     * Sets var decl imports.
     *
     * @param varDeclImports the var decl imports
     * @return the self
     * @since 0.1.0
     */
    public Swc4jTranspileOptions setVarDeclImports(boolean varDeclImports) {
        this.varDeclImports = varDeclImports;
        return this;
    }

    /**
     * Sets verbatim module syntax.
     *
     * @param verbatimModuleSyntax the verbatim module syntax
     * @return the self
     * @since 1.2.0
     */
    public Swc4jTranspileOptions setVerbatimModuleSyntax(boolean verbatimModuleSyntax) {
        this.verbatimModuleSyntax = verbatimModuleSyntax;
        return this;
    }
}