1.0.0 • Published 1 year ago

@brefer/vite-plugin-svelte v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Brefer Vite plugin for preprocessing Svelte 5

Installation

npm install -D @brefer/vite-plugin-svelte@next

For PNPM and YARN, just replace npm install with pnpm add or yarn add in the command above.

Warning! Brefer is not yet ready for production (well, Svelte 5 neither). Expect bugs and breaking changes, as the syntax is not yet entirely decided.

Usage

Basic usage

// vite.config.js
import { defineConfig } from "vite";
import { brefer } from "@brefer/vite-plugin-svelte";

export default defineConfig({
	plugins: [brefer()],
});

Options

You can pass options to the plugin. Those options contain 2 properties: include and exclude. You might already be familiar with them as a lot of other frameworks also use it.

You can check the documentation on Rollup's website.

// vite.config.js
import { defineConfig } from "vite";
import { brefer } from "@brefer/vite-plugin-svelte";

export default defineConfig({
	plugins: [
		brefer({
			include: [
				// Files to preprocess
				"src/**/*.svelte",
				"src/**/*.svelte.js",
			],
			exclude: [
				// Files you don't want preprocessed
				"tests/**/*.svelte",
			],
		}),
	],
});

Why use the Vite plugin?

If you plan to use Svelte modules (.svlete.[js|ts] files), using the Vite plugin is the way to go as @brefer/preprocessor can't preprocess them.

If you don't plan to use them, you might want to use the more basic Svelte preprocessor, which is shipped with the same functionalities but works for .svelte files only.

Want to use the preprocessor? See the documentation.

1.0.0

1 year ago