Merge pull request #136 from atk/inline-solid-for-testing

inline solid-js for testing, fix jest-dom detect

Author: ryansolid

README.md

@@ -188,7 +188,7 @@ if (import.meta.hot) {
 
 - 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`
+- 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
 
@@ -198,6 +198,10 @@ The main breaking change from previous version is that the package has been rena
 
 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)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-solid",
-  "version": "2.8.2",
+  "version": "2.8.3",
   "description": "solid-js integration plugin for vite 3/4/5",
   "type": "module",
   "files": [
@@ -65,8 +65,12 @@
     "vite": "^5.0.0"
   },
   "peerDependencies": {
+    "@testing-library/jest-dom": "^5.16.6 || ^5.17.0 || ^6.*",
     "solid-js": "^1.7.2",
     "vite": "^3.0.0 || ^4.0.0 || ^5.0.0"
   },
+  "peerDependencyMeta": {
+    "@testing-library/jest-dom": { "optional": true }
+  },
   "packageManager": "[email protected]"
 }

pnpm-lock.yaml

@@ -280,12 +280,13 @@ function containsSolidField(fields: Record<string, any>) {
 }
 
 function getJestDomExport(setupFiles: string[]) {
-  return (setupFiles || []).some((path) => /jest-dom/.test(path))
+  return setupFiles?.some((path) => /jest-dom/.test(path))
     ? undefined
     : ['@testing-library/jest-dom/vitest', '@testing-library/jest-dom/extend-expect'].find(
         (path) => {
           try {
-            require(path);
+            require.resolve(path);
+            return true;
           } catch (e) {
             return false;
           }
@@ -328,19 +329,24 @@ export default function solidPlugin(options: Partial<Options> = {}): Plugin {
 
       const test = (userConfig as any).test || {};
 
-      // to simplify the processing of the config, we normalize the setupFiles to an array
-      const userSetupFiles: string[] =
-        typeof test.setupFiles === 'string' ? [test.setupFiles] : test.setupFiles || [];
-
       if (userConfig.mode === 'test') {
+        // to simplify the processing of the config, we normalize the setupFiles to an array
+        const userSetupFiles: string[] =
+          typeof test.setupFiles === 'string' ? [test.setupFiles] : test.setupFiles || [];
+
         if (!test.environment && !options.ssr) {
           test.environment = 'jsdom';
         }
 
-        const jestDomImport = getJestDomExport(userSetupFiles);
+        test.server = test.server || {};
+        test.server.deps = test.server.deps || {};
+        if (!test.server.deps.inline?.find((item: string | RegExp) => /solid-js/.test(item.toString()))) {
+          test.server.deps.inline = [...(test.server.deps.inline || []), /solid-js/];
+        }
 
+        const jestDomImport = getJestDomExport(userSetupFiles);
         if (jestDomImport) {
-          test.setupFiles = [...userSetupFiles, require.resolve(jestDomImport)];
+          test.setupFiles = [...userSetupFiles, jestDomImport];
         }
       }
 
@@ -364,7 +370,7 @@ export default function solidPlugin(options: Partial<Options> = {}): Plugin {
           exclude: solidPkgsConfig.optimizeDeps.exclude,
         },
         ssr: solidPkgsConfig.ssr,
-        ...(test ? { test } : {}),
+        ...(test.server ? { test } : {}),
       };
     },