Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/solidjs/vite-plugin-solid

A simple integration to run solid-js with vite
https://github.com/solidjs/vite-plugin-solid

Last synced: about 1 month ago
JSON representation

A simple integration to run solid-js with vite

Lists

README 

        


  Solid Vite Plugin




# ⚡ vite-plugin-solid



A simple integration to run [solid-js](https://github.com/solidjs/solid) with [vite](https://github.com/vitejs/vite)



HMR gif demonstrationdemodemodemo



# Got a question? / Need help?



Join [solid discord](https://discord.com/invite/solidjs) and check the [troubleshooting section](#troubleshooting) to see if your question hasn't been already answered.



## Features



- HMR with no configuration needed

- Drop-in installation as a vite plugin

- Minimal bundle size

- Support typescript (`.tsx`) out of the box

- Support code splitting out of the box



## Requirements



This module 100% ESM compatible and requires NodeJS `14.18.0` or later.



You can check your current version of NodeJS by typing `node -v` in your terminal. If your version is below that one version I'd encourage you to either do an update globally or use a NodeJS version management tool such as [Volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm).



## Quickstart



You can use the [vite-template-solid](https://github.com/solidjs/templates) starter templates similar to CRA:



```bash

$ npx degit solidjs/templates/js my-solid-project

$ cd my-solid-project

$ npm install # or pnpm install or yarn install

$ npm run start # starts dev-server with hot-module-reloading

$ npm run build # builds to /dist

```



## Installation



Install `vite`, `vite-plugin-solid` as dev dependencies.



Install `solid-js` as dependency.



You have to install those so that you are in control to which solid version is used to compile your code.



```bash

# with npm

$ npm install -D vite vite-plugin-solid

$ npm install solid-js



# with pnpm

$ pnpm add -D vite vite-plugin-solid

$ pnpm add solid-js



# with yarn

$ yarn add -D vite vite-plugin-solid

$ yarn add solid-js

```



Add it as plugin to `vite.config.js`



```js

// vite.config.ts

import { defineConfig } from 'vite';

import solidPlugin from 'vite-plugin-solid';



export default defineConfig({

  plugins: [solidPlugin()],

});

```



## Run



Just use regular `vite` or `vite build` commands



```json

{

  "scripts": {

    "dev": "vite",

    "build": "vite build"

  }

}

```



## API



### options



- Type: Object

- Default: {}



#### options.include



- Type: (string | RegExp)[] | string | RegExp | null

- Default: undefined



A [picomatch](https://github.com/micromatch/picomatch) pattern, or array of patterns, which specifies the files the plugin should operate on.



#### options.exclude



- Type: (string | RegExp)[] | string | RegExp | null

- Default: undefined



A [picomatch](https://github.com/micromatch/picomatch) pattern, or array of patterns, which specifies the files to be ignored by the plugin.



#### options.dev



- Type: Boolean

- Default: true



This will inject `solid-js/dev` in place of `solid-js` in dev mode. Has no effect in prod.

If set to false, it won't inject it in dev.

This is useful for extra logs and debug.



#### options.hot



- Type: Boolean

- Default: true



This will inject HMR runtime in dev mode. Has no effect in prod.

If set to false, it won't inject the runtime in dev.



#### options.ssr



- Type: Boolean

- Default: false



This will force SSR code in the produced files.



#### options.babel



- Type: Babel.TransformOptions

- Default: {}



Pass any additional [babel transform options](https://babeljs.io/docs/en/options). Those will be merged with the transformations required by Solid.



#### options.solid



- Type: [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options)

- Default: {}



Pass any additional [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options).

They will be merged with the defaults sets by [babel-preset-solid](https://github.com/solidjs/solid/blob/main/packages/babel-preset-solid/index.js#L8-L25).



#### options.typescript



- Type: [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript)

- Default: {}



Pass any additional [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript).



#### options.extensions



- Type: (string, [string, { typescript: boolean }])[]

- Default: []



An array of custom extension that will be passed through the solid compiler.

By default, the plugin only transform `jsx` and `tsx` files.

This is useful if you want to transform `mdx` files for example.



## Note on HMR



Starting from version `1.1.0`, this plugin handle automatic HMR via [solid-refresh](https://github.com/solidjs/solid-refresh).



At this stage it's still early work but provide basic HMR. In order to get the best out of it there are couple of things to keep in mind:



- When you modify a file every state below this component will be reset to default state (including the current file). The state in parent component is preserved.



- The entrypoint can't benefit from HMR yet and will force a hard reload of the entire app. This is still really fast thanks to browser caching.



If at least one of this point is blocking to you, you can revert to the old behavior by [opting out the automatic HMR](#options) and placing the following snippet in your entry point:



```jsx

const dispose = render(() => , document.body);



if (import.meta.hot) {

  import.meta.hot.accept();

  import.meta.hot.dispose(dispose);

}

```



# Troubleshooting



- It appears that Webstorm generate some weird triggers when saving a file. In order to prevent that you can follow [this thread](https://intellij-support.jetbrains.com/hc/en-us/community/posts/360000154544-I-m-having-a-huge-problem-with-Webstorm-and-react-hot-loader-) and disable the **"Safe Write"** option in **"Settings | Appearance & Behavior | System Settings"**.



- If one of your dependency spit out React code instead of Solid that means that they don't expose JSX properly. To get around it, you might want to manually exclude it from the [dependencies optimization](https://vitejs.dev/config/dep-optimization-options.html#optimizedeps-exclude)



- If you are trying to make [directives](https://www.solidjs.com/docs/latest/api#use%3A___) work, and they somehow don't try setting the `options.typescript.onlyRemoveTypeImports` option to `true`



## Migration from v1



The master branch now target vite 2.



The main breaking change from previous version is that the package has been renamed from `@amoutonbrady/vite-plugin-solid` to `vite-plugin-solid`.



For other breaking changes, check [the migration guide of vite](https://vitejs.dev/guide/migration.html).



# Testing



If you are using [vitest](https://vitest.dev/), this plugin already injects the necessary configuration for you. It even automatically detects if you have `@testing-library/jest-dom` installed in your project and automatically adds it to the `setupFiles`. All you need to add (if you want) is `globals`, `coverage`, and other testing configuration of your choice. If you can live without those, enjoy using vitest without the need to configure it yourself.



# Credits



- [solid-js](https://github.com/solidjs/solid)

- [vite](https://github.com/vitejs/vite)