@catherineorg/kwc-rollup-plugin

Rollup plugin to compile KWC

Installation

yarn add --dev @catherineorg/kwc-rollup-plugin

Usage

// rollup.config.js
import kwc from '@catherineorg/kwc-rollup-plugin';

export default {
    input: './src/main.js',
    plugins: [kwc()],
};

Options

• include (type: string | string[], default: null) - A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should transform on. By default all files are targeted.
• exclude (type: string | string[], default: null) - A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should not transform. By default no files are ignored.
• rootDir (type: string, default: rollup input directory) - The KWC root module directory.
• sourcemap (type: boolean, default: false) - If true the plugin will produce source maps.
• modules (type: ModuleRecord[], default: []) - The module resolution overrides passed to the @catherineorg/kwc-module-resolver.
• stylesheetConfig (type: object, default: {}) - Deprecated. Ignored by compiler.
• preserveHtmlComments (type: boolean, default: false) - The configuration to pass to the @catherineorg/kwc-template-compiler.
• experimentalDynamicComponent (type: DynamicImportConfig, default: null) - The configuration to pass to @catherineorg/kwc-compiler.
• experimentalDynamicDirective (type: boolean, default: false) - The configuration to pass to @catherineorg/kwc-template-compiler to enable deprecated dynamic components.
• enableDynamicComponents (type: boolean, default: false) - The configuration to pass to @catherineorg/kwc-template-compiler to enable dynamic components.
• enableLightningWebSecurityTransforms (type: boolean, default: false) - The configuration to pass to @catherineorg/kwc-compiler.
• enableKwcSpread (type: boolean, default: false) - The configuration to pass to the @catherineorg/kwc-template-compiler.
• enableKwcOn (type: boolean, default: false) - The configuration to pass to the @catherineorg/kwc-template-compiler.
• disableSyntheticShadowSupport (type: boolean, default: false) - Set to true if synthetic shadow DOM support is not needed, which can result in smaller output.
• apiVersion (type: number, default: undefined) - Set to a valid API version such as 58, 59, etc. This will be overriden if the component itself overrides the version with a *.js-meta.xml file.
• enableStaticContentOptimization (type: boolean, optional) - True if the static content optimization should be enabled. Passed to @catherineorg/kwc-template-compiler. True by default.
• targetSSR (type: boolean) - Utilize the experimental SSR compilation mode. False by default. Do not use unless you know what you're doing.
• ssrMode (type: string): The variety of SSR code that should be generated when using experimental SSR compilation mode. Should be one of sync, async or asyncYield.