.github/dependabot.yml

@@ -23,15 +23,6 @@ updates:
       development:
         dependency-type: 'development'
 
-    # TODO(mcous, 2024-04-30): update to ESLint v9 + flat config
-    ignore:
-      - dependency-name: 'eslint'
-        versions: ['>=9']
-      - dependency-name: 'eslint-plugin-n'
-        versions: ['>=17']
-      - dependency-name: 'eslint-plugin-promise'
-        versions: ['>=7']
-
   # Update GitHub Actions dependencies
   - package-ecosystem: 'github-actions'
     directory: '/'

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
   main:
     # ignore all-contributors PRs
     if: ${{ !contains(github.head_ref, 'all-contributors') }}
-    name: Node ${{ matrix.node }}, Svelte ${{ matrix.svelte }}, ${{ matrix.check }}
+    name: Svelte ${{ matrix.svelte }}, Node ${{ matrix.node }}, ${{ matrix.check }}
     runs-on: ubuntu-latest
 
     # enable OIDC for codecov uploads
@@ -27,20 +27,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['16', '18', '20']
-        svelte: ['3', '4']
+        node: ['16', '18', '20', '22']
+        svelte: ['3', '4', '5']
         check: ['test:vitest:jsdom', 'test:vitest:happy-dom', 'test:jest']
+        exclude:
+          # Don't run Svelte 3 on Node versions greater than 20
+          - { svelte: '3', node: '22' }
+          # Only run Svelte 5 on Node versions greater than or equal to 20
+          - { svelte: '5', node: '16' }
+          - { svelte: '5', node: '18' }
         include:
           # We only need to lint once, so do it on latest Node and Svelte
-          - { node: '20', svelte: '4', check: 'lint' }
-          # Run type checks in latest node
-          - { node: '20', svelte: '3', check: 'types:legacy' }
-          - { node: '20', svelte: '4', check: 'types:legacy' }
-          - { node: '20', svelte: '5', check: 'types' }
-          # Only run Svelte 5 checks on latest Node
-          - { node: '20', svelte: '5', check: 'test:vitest:jsdom' }
-          - { node: '20', svelte: '5', check: 'test:vitest:happy-dom' }
-          - { node: '20', svelte: '5', check: 'test:jest' }
+          - { svelte: '5', node: '22', check: 'lint' }
+          # Run type checks in latest applicable Node
+          - { svelte: '3', node: '20', check: 'types:legacy' }
+          - { svelte: '4', node: '22', check: 'types:legacy' }
+          - { svelte: '5', node: '22', check: 'types' }
 
     steps:
       - name: ⬇️ Checkout repo
@@ -73,10 +75,10 @@ jobs:
       - name: ⎔ Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
 
       - name: 📥 Download deps
-        run: npm install --no-package-lock
+        run: npm install
 
       - name: 🏗️ Build types
         run: npm run build
@@ -100,7 +102,7 @@ jobs:
       - name: ⎔ Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
 
       - name: 📥 Downloads types build
         uses: actions/download-artifact@v4

.npmrc

@@ -1 +1,2 @@
 package-lock=false
+engine-strict=true

.prettierignore

@@ -1,4 +1 @@
-scripts/*
-.eslintignore
-.prettierignore
 .all-contributorsrc

CONTRIBUTING.md

@@ -28,25 +28,24 @@ npm run preview-release
 
 ## Development setup
 
-After cloning the repository, install the project's dependencies and run the `validate` script to run all checks and tests to verify your setup.
+After cloning the repository, use the `setup` script to install dependencies and run all checks:
 
 ```shell
-npm install # or `pnpm install`, or `yarn install`, etc.
-npm run validate
+npm run setup
 ```
 
 ### Lint and format
 
 Run auto-formatting to ensure any changes adhere to the code style of the repository:
 
 ```shell
-npm run format:delta
+npm run format
 ```
 
 To run lint and format checks without making any changes:
 
 ```shell
-npm run lint:delta
+npm run lint
 ```
 
 ### Test
@@ -63,18 +62,19 @@ npm run test:watch
 Use the provided script to set up your environment for different versions of Svelte:
 
 ```shell
-# install Svelte 5
+# Svelte 5
 npm run install:5
+npm run all
 
-# install Svelte 4
+# Svelte 4
 npm run install:4
+npm run all:legacy
 
-# install Svelte 3
+# Svelte 3
 npm run install:3
+npm run all:legacy
 ```
 
-Not all checks will pass on `svelte<5`. Reference the CI workflows to see which checks are expected to pass on older versions.
-
 ### Docs
 
 Use the `toc` script to ensure the README's table of contents is up to date:

README.md

@@ -70,6 +70,7 @@
 - [This Solution](#this-solution)
 - [Installation](#installation)
 - [Setup](#setup)
+  - [Auto-cleanup](#auto-cleanup)
 - [Docs](#docs)
 - [Issues](#issues)
   - [🐛 Bugs](#-bugs)
@@ -140,6 +141,39 @@ test runners like Jest.
 [vitest]: https://vitest.dev/
 [setup docs]: https://testing-library.com/docs/svelte-testing-library/setup
 
+### Auto-cleanup
+
+In Vitest (via the `svelteTesting` plugin) and Jest (via the `beforeEach` and `afterEach` globals),
+this library will automatically setup and cleanup the test environment before and after each test.
+
+To do your own cleanup, or if you're using another framework, call the `setup` and `cleanup` functions yourself:
+
+```js
+import { cleanup, render, setup } from '@testing-library/svelte'
+
+// before
+setup()
+
+// test
+render(/* ... */)
+
+// after
+cleanup()
+```
+
+To disable auto-cleanup in Vitest, set the `autoCleanup` option of the plugin to false:
+
+```js
+svelteTesting({ autoCleanup: false })
+```
+
+To disable auto-cleanup in Jest and other frameworks with global test hooks,
+set the `STL_SKIP_AUTO_CLEANUP` environment variable:
+
+```shell
+STL_SKIP_AUTO_CLEANUP=1 jest
+```
+
 ## Docs
 
 See the [**docs**][stl-docs] over at the Testing Library website.

eslint.config.js

@@ -0,0 +1,95 @@
+import js from '@eslint/js'
+import eslintPluginVitest from '@vitest/eslint-plugin'
+import eslintConfigPrettier from 'eslint-config-prettier'
+import eslintPluginJestDom from 'eslint-plugin-jest-dom'
+import eslintPluginPromise from 'eslint-plugin-promise'
+import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort'
+import eslintPluginSvelte from 'eslint-plugin-svelte'
+import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
+import eslintPluginUnicorn from 'eslint-plugin-unicorn'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  js.configs.recommended,
+  tseslint.configs.strict,
+  tseslint.configs.stylistic,
+  eslintPluginUnicorn.configs['flat/recommended'],
+  eslintPluginPromise.configs['flat/recommended'],
+  eslintPluginSvelte.configs['flat/recommended'],
+  eslintPluginSvelte.configs['flat/prettier'],
+  eslintConfigPrettier,
+  {
+    name: 'settings',
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      parserOptions: {
+        parser: tseslint.parser,
+        extraFileExtensions: ['.svelte'],
+      },
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+  },
+  {
+    name: 'ignores',
+    ignores: ['coverage', 'types'],
+  },
+  {
+    name: 'simple-import-sort',
+    plugins: {
+      'simple-import-sort': eslintPluginSimpleImportSort,
+    },
+    rules: {
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+    },
+  },
+  {
+    name: 'tests',
+    files: ['**/*.test.js'],
+    extends: [
+      eslintPluginVitest.configs.recommended,
+      eslintPluginJestDom.configs['flat/recommended'],
+      eslintPluginTestingLibrary.configs['flat/dom'],
+    ],
+    rules: {
+      'testing-library/no-node-access': [
+        'error',
+        { allowContainerFirstChild: true },
+      ],
+    },
+  },
+  {
+    name: 'extras',
+    rules: {
+      'unicorn/prevent-abbreviations': 'off',
+    },
+  },
+  {
+    name: 'svelte-extras',
+    files: ['**/*.svelte'],
+    rules: {
+      'svelte/no-unused-svelte-ignore': 'off',
+      'unicorn/filename-case': ['error', { case: 'pascalCase' }],
+      'unicorn/no-useless-undefined': 'off',
+    },
+  },
+  {
+    name: 'ts-extras',
+    files: ['**/*.ts'],
+    extends: [
+      tseslint.configs.strictTypeChecked,
+      tseslint.configs.stylisticTypeChecked,
+    ],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  }
+)

jest.config.js

@@ -1,26 +1,28 @@
 import { VERSION as SVELTE_VERSION } from 'svelte/compiler'
 
 const SVELTE_TRANSFORM_PATTERN =
-  SVELTE_VERSION >= '5' ? '^.+\\.svelte(?:\\.js)?$' : '^.+\\.svelte$'
+  SVELTE_VERSION >= '5'
+    ? String.raw`^.+\.svelte(?:\.js)?$`
+    : String.raw`^.+\.svelte$`
 
 export default {
-  testMatch: ['<rootDir>/src/__tests__/**/*.test.js'],
+  testMatch: ['<rootDir>/tests/**/*.test.js'],
   transform: {
     [SVELTE_TRANSFORM_PATTERN]: 'svelte-jester',
   },
   moduleFileExtensions: ['js', 'svelte'],
   extensionsToTreatAsEsm: ['.svelte'],
   testEnvironment: 'jsdom',
-  setupFilesAfterEnv: ['<rootDir>/src/__tests__/_jest-setup.js'],
-  injectGlobals: false,
+  setupFilesAfterEnv: ['<rootDir>/tests/_jest-setup.js'],
+  injectGlobals: true,
   moduleNameMapper: {
-    '^vitest$': '<rootDir>/src/__tests__/_jest-vitest-alias.js',
+    '^vitest$': '<rootDir>/tests/_jest-vitest-alias.js',
+    [String.raw`^@testing-library\/svelte$`]: '<rootDir>/src/index.js',
   },
   resetMocks: true,
   restoreMocks: true,
   collectCoverageFrom: ['<rootDir>/src/**/*'],
   coveragePathIgnorePatterns: [
-    '/__tests__/',
     '<rootDir>/src/vite.js',
     '<rootDir>/src/vitest.js',
   ],