vite-plugin-solid 2.1.1 → 2.2.0

package/dist/types/index.d.ts

@@ -1,203 +1,214 @@
-import { TransformOptions } from '@babel/core';
-import type { Plugin } from 'vite';
-/** Configuration options for vite-plugin-solid. */
-export interface Options {
-    /**
-     * 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 debugging.
-     *
-     * @default true
-     */
-    dev: boolean;
-    /**
-     * This will force SSR code in the produced files. This is experiemental
-     * and mostly not working yet.
-     *
-     * @default false
-     */
-    ssr: boolean;
-    /**
-     * 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.
-     *
-     * @default true
-     */
-    hot: boolean;
-    /**
-     * Pass any additional babel transform options. They will be merged with
-     * the transformations required by Solid.
-     *
-     * @default {}
-     */
-    babel: TransformOptions | ((source: string, id: string, ssr: boolean) => TransformOptions) | ((source: string, id: string, ssr: boolean) => Promise<TransformOptions>);
-    typescript: {
-        /**
-         * Forcibly enables jsx parsing. Otherwise angle brackets will be treated as
-         * typescript's legacy type assertion var foo = <string>bar;. Also, isTSX:
-         * true requires allExtensions: true.
-         *
-         * @default false
-         */
-        isTSX?: boolean;
-        /**
-         * Replace the function used when compiling JSX expressions. This is so that
-         * we know that the import is not a type import, and should not be removed.
-         *
-         * @default React
-         */
-        jsxPragma?: string;
-        /**
-         * Replace the function used when compiling JSX fragment expressions. This
-         * is so that we know that the import is not a type import, and should not
-         * be removed.
-         *
-         * @default React.Fragment
-         */
-        jsxPragmaFrag?: string;
-        /**
-         * Indicates that every file should be parsed as TS or TSX (depending on the
-         * isTSX option).
-         *
-         * @default false
-         */
-        allExtensions?: boolean;
-        /**
-         * Enables compilation of TypeScript namespaces.
-         *
-         * @default uses the default set by @babel/plugin-transform-typescript.
-         */
-        allowNamespaces?: boolean;
-        /**
-         * When enabled, type-only class fields are only removed if they are
-         * prefixed with the declare modifier:
-         *
-         * > NOTE: This will be enabled by default in Babel 8
-         *
-         * @default false
-         *
-         * @example
-         * ```ts
-         * class A {
-         *   declare foo: string; // Removed
-         *   bar: string; // Initialized to undefined
-         *    prop?: string; // Initialized to undefined
-         *    prop1!: string // Initialized to undefined
-         * }
-         * ```
-         */
-        allowDeclareFields?: boolean;
-        /**
-         * When set to true, the transform will only remove type-only imports
-         * (introduced in TypeScript 3.8). This should only be used if you are using
-         * TypeScript >= 3.8.
-         *
-         * @default false
-         */
-        onlyRemoveTypeImports?: boolean;
-        /**
-         * When set to true, Babel will inline enum values rather than using the
-         * usual enum output:
-         *
-         * This option differs from TypeScript's --isolatedModules behavior, which
-         * ignores the const modifier and compiles them as normal enums, and aligns
-         * Babel's behavior with TypeScript's default behavior.
-         *
-         * ```ts
-         *  // Input
-         *  const enum Animals {
-         *    Fish
-         *  }
-         *  console.log(Animals.Fish);
-         *
-         *  // Default output
-         *  var Animals;
-         *
-         *  (function (Animals) {
-         *    Animals[Animals["Fish"] = 0] = "Fish";
-         *  })(Animals || (Animals = {}));
-         *
-         *  console.log(Animals.Fish);
-         *
-         *  // `optimizeConstEnums` output
-         *  console.log(0);
-         * ```
-         *
-         * However, when exporting a const enum Babel will compile it to a plain
-         * object literal so that it doesn't need to rely on cross-file analysis
-         * when compiling it:
-         *
-         * ```ts
-         * // Input
-         * export const enum Animals {
-         *   Fish,
-         * }
-         *
-         * // `optimizeConstEnums` output
-         * export var Animals = {
-         *     Fish: 0,
-         * };
-         * ```
-         *
-         * @default false
-         */
-        optimizeConstEnums?: boolean;
-    };
-    /**
-     * 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).
-     *
-     * @default {}
-     */
-    solid: {
-        /**
-         * The name of the runtime module to import the methods from.
-         *
-         * @default "solid-js/web"
-         */
-        moduleName?: string;
-        /**
-         * The output mode of the compiler.
-         * Can be:
-         * - "dom" is standard output
-         * - "ssr" is for server side rendering of strings.
-         *
-         * @default "dom"
-         */
-        generate?: 'ssr' | 'dom';
-        /**
-         * Indicate whether the output should contain hydratable markers.
-         *
-         * @default false
-         */
-        hydratable?: boolean;
-        /**
-         * Boolean to indicate whether to enable automatic event delegation on camelCase.
-         *
-         * @default true
-         */
-        delegateEvents?: boolean;
-        /**
-         * Boolean indicates whether smart conditional detection should be used.
-         * This optimizes simple boolean expressions and ternaries in JSX.
-         *
-         * @default true
-         */
-        wrapConditionals?: boolean;
-        /**
-         * Boolean indicates whether to set current render context on Custom Elements and slots.
-         * Useful for seemless Context API with Web Components.
-         *
-         * @default true
-         */
-        contextToCustomElements?: boolean;
-        /**
-         * Array of Component exports from module, that aren't included by default with the library.
-         * This plugin will automatically import them if it comes across them in the JSX.
-         *
-         * @default ["For","Show","Switch","Match","Suspense","SuspenseList","Portal","Index","Dynamic","ErrorBoundary"]
-         */
-        builtIns?: string[];
-    };
-}
-export default function solidPlugin(options?: Partial<Options>): Plugin;
+import { TransformOptions } from '@babel/core';
+import type { Plugin } from 'vite';
+/** Possible options for the extensions property */
+export interface ExtensionOptions {
+    typescript?: boolean;
+}
+/** Configuration options for vite-plugin-solid. */
+export interface Options {
+    /**
+     * 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 debugging.
+     *
+     * @default true
+     */
+    dev: boolean;
+    /**
+     * This will force SSR code in the produced files. This is experiemental
+     * and mostly not working yet.
+     *
+     * @default false
+     */
+    ssr: boolean;
+    /**
+     * 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.
+     *
+     * @default true
+     */
+    hot: boolean;
+    /**
+     * This registers additional extensions that should be processed by
+     * vite-plugin-solid.
+     *
+     * @default undefined
+     */
+    extensions?: (string | [string, ExtensionOptions])[];
+    /**
+     * Pass any additional babel transform options. They will be merged with
+     * the transformations required by Solid.
+     *
+     * @default {}
+     */
+    babel: TransformOptions | ((source: string, id: string, ssr: boolean) => TransformOptions) | ((source: string, id: string, ssr: boolean) => Promise<TransformOptions>);
+    typescript: {
+        /**
+         * Forcibly enables jsx parsing. Otherwise angle brackets will be treated as
+         * typescript's legacy type assertion var foo = <string>bar;. Also, isTSX:
+         * true requires allExtensions: true.
+         *
+         * @default false
+         */
+        isTSX?: boolean;
+        /**
+         * Replace the function used when compiling JSX expressions. This is so that
+         * we know that the import is not a type import, and should not be removed.
+         *
+         * @default React
+         */
+        jsxPragma?: string;
+        /**
+         * Replace the function used when compiling JSX fragment expressions. This
+         * is so that we know that the import is not a type import, and should not
+         * be removed.
+         *
+         * @default React.Fragment
+         */
+        jsxPragmaFrag?: string;
+        /**
+         * Indicates that every file should be parsed as TS or TSX (depending on the
+         * isTSX option).
+         *
+         * @default false
+         */
+        allExtensions?: boolean;
+        /**
+         * Enables compilation of TypeScript namespaces.
+         *
+         * @default uses the default set by @babel/plugin-transform-typescript.
+         */
+        allowNamespaces?: boolean;
+        /**
+         * When enabled, type-only class fields are only removed if they are
+         * prefixed with the declare modifier:
+         *
+         * > NOTE: This will be enabled by default in Babel 8
+         *
+         * @default false
+         *
+         * @example
+         * ```ts
+         * class A {
+         *   declare foo: string; // Removed
+         *   bar: string; // Initialized to undefined
+         *    prop?: string; // Initialized to undefined
+         *    prop1!: string // Initialized to undefined
+         * }
+         * ```
+         */
+        allowDeclareFields?: boolean;
+        /**
+         * When set to true, the transform will only remove type-only imports
+         * (introduced in TypeScript 3.8). This should only be used if you are using
+         * TypeScript >= 3.8.
+         *
+         * @default false
+         */
+        onlyRemoveTypeImports?: boolean;
+        /**
+         * When set to true, Babel will inline enum values rather than using the
+         * usual enum output:
+         *
+         * This option differs from TypeScript's --isolatedModules behavior, which
+         * ignores the const modifier and compiles them as normal enums, and aligns
+         * Babel's behavior with TypeScript's default behavior.
+         *
+         * ```ts
+         *  // Input
+         *  const enum Animals {
+         *    Fish
+         *  }
+         *  console.log(Animals.Fish);
+         *
+         *  // Default output
+         *  var Animals;
+         *
+         *  (function (Animals) {
+         *    Animals[Animals["Fish"] = 0] = "Fish";
+         *  })(Animals || (Animals = {}));
+         *
+         *  console.log(Animals.Fish);
+         *
+         *  // `optimizeConstEnums` output
+         *  console.log(0);
+         * ```
+         *
+         * However, when exporting a const enum Babel will compile it to a plain
+         * object literal so that it doesn't need to rely on cross-file analysis
+         * when compiling it:
+         *
+         * ```ts
+         * // Input
+         * export const enum Animals {
+         *   Fish,
+         * }
+         *
+         * // `optimizeConstEnums` output
+         * export var Animals = {
+         *     Fish: 0,
+         * };
+         * ```
+         *
+         * @default false
+         */
+        optimizeConstEnums?: boolean;
+    };
+    /**
+     * 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).
+     *
+     * @default {}
+     */
+    solid: {
+        /**
+         * The name of the runtime module to import the methods from.
+         *
+         * @default "solid-js/web"
+         */
+        moduleName?: string;
+        /**
+         * The output mode of the compiler.
+         * Can be:
+         * - "dom" is standard output
+         * - "ssr" is for server side rendering of strings.
+         *
+         * @default "dom"
+         */
+        generate?: 'ssr' | 'dom';
+        /**
+         * Indicate whether the output should contain hydratable markers.
+         *
+         * @default false
+         */
+        hydratable?: boolean;
+        /**
+         * Boolean to indicate whether to enable automatic event delegation on camelCase.
+         *
+         * @default true
+         */
+        delegateEvents?: boolean;
+        /**
+         * Boolean indicates whether smart conditional detection should be used.
+         * This optimizes simple boolean expressions and ternaries in JSX.
+         *
+         * @default true
+         */
+        wrapConditionals?: boolean;
+        /**
+         * Boolean indicates whether to set current render context on Custom Elements and slots.
+         * Useful for seemless Context API with Web Components.
+         *
+         * @default true
+         */
+        contextToCustomElements?: boolean;
+        /**
+         * Array of Component exports from module, that aren't included by default with the library.
+         * This plugin will automatically import them if it comes across them in the JSX.
+         *
+         * @default ["For","Show","Switch","Match","Suspense","SuspenseList","Portal","Index","Dynamic","ErrorBoundary"]
+         */
+        builtIns?: string[];
+    };
+}
+export default function solidPlugin(options?: Partial<Options>): Plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-solid",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "solid-js integration plugin for vite 2",
   "type": "module",
   "files": [
@@ -34,31 +34,33 @@
   },
   "homepage": "https://github.com/solidjs/vite-plugin-solid#readme",
   "dependencies": {
-    "@babel/core": "^7.15.8",
-    "@babel/preset-typescript": "^7.15.0",
-    "babel-preset-solid": "^1.1.5",
-    "merge-anything": "^4.0.1",
-    "solid-js": "^1.1.6",
-    "solid-refresh": "^0.2.2",
-    "vite": "^2.6.7"
+    "@babel/core": "^7.16.7",
+    "@babel/preset-typescript": "^7.16.7",
+    "babel-preset-solid": "^1.2.6",
+    "merge-anything": "^4.0.2",
+    "solid-js": "^1.2.6",
+    "solid-refresh": "^0.3.2",
+    "vite": "^2.7.10"
   },
   "devDependencies": {
-    "@babel/plugin-transform-typescript": "^7.15.8",
-    "@babel/preset-env": "^7.15.8",
+    "@babel/plugin-transform-typescript": "^7.16.7",
+    "@babel/preset-env": "^7.16.7",
     "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^21.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.5",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-node-resolve": "^13.1.2",
     "@skypack/package-check": "^0.2.2",
-    "@types/babel__core": "^7.1.16",
-    "@types/node": "^16.11.0",
-    "prettier": "^2.4.1",
-    "rollup": "^2.58.0",
+    "@types/babel__core": "^7.1.18",
+    "@types/node": "^17.0.7",
+    "prettier": "^2.5.1",
+    "rollup": "^2.62.0",
     "rollup-plugin-cleaner": "^1.0.0",
-    "typescript": "^4.4.4"
+    "typescript": "^4.5.4"
   },
+  "packageManager": "pnpm@6.24.4",
   "scripts": {
     "build": "rollup -c && tsc --emitDeclarationOnly",
     "dev": "rollup -c -w",
     "check": "package-check"
-  }
+  },
+  "readme": "<p>\n  <img width=\"100%\" src=\"https://raw.githubusercontent.com/solidjs/vite-plugin-solid/master/banner.png\" alt=\"Solid Vite Plugin\">\n</p>\n\n# ⚡ vite-plugin-solid\n\nA simple integration to run [solid-js](https://github.com/solidjs/solid) with [vite](https://github.com/vitejs/vite)\n\n<img alt=\"HMR gif demonstrationdemodemodemo\" src=\".github/hmr.gif\">\n\n# Got a question? / Need help?\n\nJoin [solid discord](https://discord.com/invite/solidjs) and check the [troubleshooting section](#troubleshooting) to see if your question hasn't been already answered.\n\n## Features\n\n- HMR with no configuration needed\n- Drop-in installation as a vite plugin\n- Minimal bundle size\n- Support typescript (`.tsx`) out of the box\n- Support code splitting out of the box\n\n## Requirements\n\nThis module 100% esm compatible. As per [this document](https://nodejs.org/api/esm.html) it is strongly recommended to have at least the version `14.13.0` of node installed.\n\nYou can check your current version of node 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 node version management tool such as [volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm).\n\n## Quickstart\n\nYou can use the [vite-template-solid](https://github.com/solidjs/templates) starter templates similar to CRA:\n\n```bash\n$ npx degit solidjs/templates/js my-solid-project\n$ cd my-solid-project\n$ npm install # or pnpm install or yarn install\n$ npm run start # starts dev-server with hot-module-reloading\n$ npm run build # builds to /dist\n```\n\n## Installation\n\nInstall `vite`, `vite-plugin-solid` and `babel-preset-solid` as dev dependencies.\n\nInstall `solid-js` as dependency.\n\nYou have to install those so that you are in control to which solid version is used to compile your code.\n\n```bash\n# with npm\n$ npm install -D vite vite-plugin-solid babel-preset-solid\n$ npm install solid-js\n\n# with pnpm\n$ pnpm add -D vite vite-plugin-solid babel-preset-solid\n$ pnpm add solid-js\n\n# with yarn\n$ yarn add -D vite vite-plugin-solid babel-preset-solid\n$ yarn add solid-js\n```\n\nAdd it as plugin to `vite.config.js`\n\n```js\n// vite.config.ts\nimport { defineConfig } from 'vite';\nimport solidPlugin from 'vite-plugin-solid';\n\nexport default defineConfig({\n  plugins: [solidPlugin()],\n});\n```\n\n## Run\n\nJust use regular `vite` or `vite build` commands\n\n```json\n{\n  \"scripts\": {\n    \"dev\": \"vite\",\n    \"build\": \"vite build\"\n  }\n}\n```\n\n## API\n\n### options\n\n- Type: Object\n- Default: {}\n\n#### options.dev\n\n- Type: Boolean\n- Default: true\n\nThis will inject `solid-js/dev` in place of `solid-js` in dev mode. Has no effect in prod.\nIf set to false, it won't inject it in dev.\nThis is useful for extra logs and debug.\n\n#### options.hot\n\n- Type: Boolean\n- Default: true\n\nThis will inject HMR runtime in dev mode. Has no effect in prod.\nIf set to false, it won't inject the runtime in dev.\n\n#### options.ssr\n\n- Type: Boolean\n- Default: false\n\nThis will force SSR code in the produced files. This is experiemental and mostly not working yet.\n\n#### options.babel\n\n- Type: Babel.TransformOptions\n- Default: {}\n\nPass any additional [babel transform options](https://babeljs.io/docs/en/options). Those will be merged with the transformations required by Solid.\n\n#### options.solid\n\n- Type: [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options)\n- Default: {}\n\nPass any additional [babel-plugin-jsx-dom-expressions](https://github.com/ryansolid/dom-expressions/tree/main/packages/babel-plugin-jsx-dom-expressions#plugin-options).\nThey 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).\n\n#### options.typescript\n\n- Type: [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript)\n- Default: {}\n\nPass any additional [@babel/preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript).\n\n## Note on HMR\n\nStarting from version `1.1.0`, this plugin handle automatic HMR via [solid-refresh](https://github.com/solidjs/solid-refresh).\n\nAt 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:\n\n- 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.\n\n- 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.\n\nIf at least one of this point is blocking to you, you can revert to the old behavior but [opting out the automatic HMR](#options) and placing the following snippet in your entry point:\n\n```jsx\nconst dispose = render(() => <App />, document.body);\n\nif (import.meta.hot) {\n  import.meta.hot.accept();\n  import.meta.hot.dispose(dispose);\n}\n```\n\n# Troubleshooting\n\n- 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\"**.\n\n- 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/#optimizedeps-exclude)\n\n- 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`\n\n## Migration from v1\n\nThe master branch now target vite 2.\n\nThe main breaking change from previous version is that the package has been renamed from `@amoutonbrady/vite-plugin-solid` to `vite-plugin-solid`.\n\nFor other breaking changes, check [the migration guide of vite](https://vitejs.dev/guide/migration.html).\n\n# Credits\n\n- [solid-js](https://github.com/solidjs/solid)\n- [vite](https://github.com/vitejs/vite)\n"
 }