@lwc/rollup-plugin
TypeScript icon, indicating that this package has built-in type declarations

6.4.0 • Public • Published

@lwc/rollup-plugin

Rollup plugin to compile LWC

Installation

yarn add --dev @lwc/rollup-plugin

Usage

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

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

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 LWC 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 @lwc/module-resolver.
  • stylesheetConfig (type: object, default: {}) - Deprecated. Ignored by compiler.
  • preserveHtmlComments (type: boolean, default: false) - The configuration to pass to the @lwc/template-compiler.
  • experimentalDynamicComponent (type: DynamicImportConfig, default: null) - The configuration to pass to @lwc/compiler.
  • experimentalDynamicDirective (type: boolean, default: false) - The configuration to pass to @lwc/template-compiler to enable deprecated dynamic components.
  • enableDynamicComponents (type: boolean, default: false) - The configuration to pass to @lwc/template-compiler to enable dynamic components.
  • enableLightningWebSecurityTransforms (type: boolean, default: false) - The configuration to pass to @lwc/compiler.
  • enableLwcSpread (type: boolean, default: false) - The configuration to pass to the @lwc/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 @lwc/template-compiler. True by default.

Dependents (8)

Package Sidebar

Install

npm i @lwc/rollup-plugin

Homepage

lwc.dev

Weekly Downloads

5,411

Version

6.4.0

License

MIT

Unpacked Size

108 kB

Total Files

7

Last publish

Collaborators

  • divmain
  • lwc-admin
  • caridy
  • tbliss
  • pmdartus
  • ekashida
  • kevinv11n
  • jye-sf
  • rui.qiu
  • ravi.jayaramappa
  • jodarove
  • abdulsattar
  • nolanlawson
  • jmsjtu