Skip to content

Wrap svelte reactive statements with custom events to allow devtools to detect them

Notifications You must be signed in to change notification settings

unlocomqx/svelte-rxd-preprocessor

Repository files navigation

Svelte Reactive Preprocessor

Wrap svelte reactive statements with custom events to allow devtools to detect them

How to install

Install the package with your preferred package manager Package name

svelte-reactive-preprocessor

Installation example

npm i -D svelte-reactive-preprocessor

How to use

First import the package like this

const { reactivePreprocess } = require("svelte-reactive-preprocessor");

or

import { reactivePreprocess } from "svelte-reactive-preprocessor";

Then in the svelte loader options, add the reactive preprocessor like this

// Import
const { reactivePreprocess } = require("svelte-reactive-preprocessor");

// config
{
  test: /\.svelte$/,
  use: {
    loader: "svelte-loader",
    options: {
      dev: !prod,
      emitCss: true,
      hotReload: true,
      // add this line
      preprocess: reactivePreprocess()
    }
  }
},

If you are already using another preprocessor, add the reactive preprocessor like this

preprocess: [
  sveltePreprocess(),
  reactivePreprocess(),
],

Make sure to add the reactive preprocessor after any script preprocessor as it only supports javascript
The same goes for rollup

plugins: [
  svelte({
    preprocess: reactivePreprocess(),
  }
],

or

plugins: [
  svelte({
    preprocess: [
      sveltePreprocess(),
      reactivePreprocess(),
    ],
  }
],

Options (optional)

The preprocessor options are listed below with their default values

reactivePreprocess({
  enabled: true
})

enabled: boolean

Allows to conditionally enable/disable the preprocessor
Example

{
  enabled: !prod
}

About

Wrap svelte reactive statements with custom events to allow devtools to detect them

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published