2.1.0

This PR was merged into the main branch.

Discussion
----------

Deprecate the package

I don't think there is any interest in _maintaining_ it anymore. Because of Jest and Babel, installing ``@symfony`/stimulus-testing` installs [**~500 subdependencies**](https://npmgraph.js.org/?q=%40symfony%2Fstimulus-testing), which is totally unacceptable, since the added-value of this package is only these two functions:
```js
export function mountDOM(html = '') {
    const div = document.createElement('div');
    div.innerHTML = html;
    document.body.appendChild(div);

    return div;
}

export function clearDOM() {
    document.body.innerHTML = '';
}
```

It's like a Composer package, but all its dependencies being shadowed and not removable by the final user.

Removing it from `@symfony`/ux, where we don't use Jest and Babel but Vitest, allowed us to remove ~400 useless Node.js dev dependencies: https://github.com/symfony/ux/pull/2879

The package is still experimental, and I suggest to deprecate this package. I've added migration steps for people being stuck with it, even if I think we, Symfony, are maybe the only ones to use it:

https://github.com/user-attachments/assets/86a21c37-8560-43dc-bec9-0043875831ea

We can observe:
1. it always had ~1k downloads per week this last year,
2. more recently we had ~21k downloads per week, and I believe that's correlated to my last two-months work on UX
3. and since a few days, it started to drop again (currently at 8k downloads for the last full week), when I removed it from UX

Commits
-------

07d2209 Deprecate the package

.babelrc

@@ -1,4 +1,3 @@
 {
-    "presets": ["@babel/env"],
-    "plugins": ["@babel/plugin-proposal-class-properties"]
+    "presets": ["@babel/env"]
 }

.github/workflows/test.yaml

@@ -1,6 +1,6 @@
 name: Symfony UX
 
-on: push
+on: [push, pull_request]
 
 jobs:
     coding-style:
@@ -9,5 +9,13 @@ jobs:
             - uses: actions/checkout@master
             - name: Prettier
               run: |
-                  yarn global add prettier@^2.2.0
-                  ~/.yarn/bin/prettier --check src/**/*.js --config .prettierrc.json
+                  yarn add prettier@^2.2.0
+                  yarn run prettier --check {src,test}/**/*.js --config .prettierrc.json
+
+    tests:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@master
+            - run: |
+                  yarn
+                  yarn test

README.md

@@ -1,10 +1,50 @@
 # Symfony UX Stimulus testing
 
-Symfony UX Stimulus testing is an low-level package to help write tests for Stimulus controllers
-in applications and reusable packages.
+> [!WARNING]
+> **Deprecated**: This package is deprecated and will not receive any further updates.
 
-**If you are developing a project with Symfony Flex, you should probably use the ux-test-pack
-instead**. The pack includes this package and configures it automatically in your application.
+Because this package only provides very small helpers to help write tests for Stimulus controllers, and is tightly coupled with [Jest](https://jestjs.io/), [jsdom](https://github.com/jsdom/jsdom) and [Testing Library](https://testing-library.com/) dependencies, we can no longer recommend it.
+
+In 2025, we cannot force developers to install Jest (and [~270 sub-dependencies](https://npmgraph.js.org/?q=jest) including [Babel](https://babeljs.io/)) and the like, since [many test runners exist](https://npmtrends.com/ava-vs-japa-vs-jasmine-vs-jest-vs-karma-vs-mocha-vs-tap-vs-vitest), and many of them are more modern and much faster, like [Vitest](https://vitest.dev/).
+
+We want to give you the choice to use the best tools for your needs, and not force you to use what we suggested in the past.
+
+To migrate from `@symfony/stimulus-testing`, you can follow these steps:
+
+1. Install the dev dependencies `@testing-library/jest-dom @testing-library/dom`;
+    you may also want to install `mutationobserver-shim regenerator-runtime` if you still have 
+    legacy code or _architecture_.
+2. In the file `assets/test/setup.js`, replace imports:
+```diff
+-import '@symfony/stimulus-testing/setup';
++import '@testing-library/jest-dom';
+```
+3. Create the file `assets/test/stimulus-helpers.js` with the following content:
+```js
+export function mountDOM(html = '') {
+    const div = document.createElement('div');
+    div.innerHTML = html;
+    document.body.appendChild(div);
+
+    return div;
+}
+
+export function clearDOM() {
+    document.body.innerHTML = '';
+}
+```
+4. In your tests files, replace imports for `mountDOM` and `clearDOM`:
+```diff
+// assets/test/controllers/hello_controller.test.js
+-import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
++import { clearDOM, mountDOM } from '../stimulus-helpers';
+```
+5. And finally, remove the `@symfony/stimulus-testing` dependency from your project.
+
+---
+
+Symfony UX Stimulus testing is a low-level package to help write tests for Stimulus controllers
+in applications and reusable packages.
 
 Symfony UX Stimulus testing is currently considered **experimental**.
 
@@ -31,7 +71,7 @@ To start using Symfony UX Testing, you first need to configure a testing environ
 2. Create a `assets/test/setup.js` file to initialize Symfony UX Testing:   
 
 ```js
-import '@symfony/ux-testing/setup';
+import '@symfony/stimulus-testing/setup';
 ```
 
 3. Create a `assets/jest.config.js` file for Jest configuration:
@@ -48,14 +88,15 @@ module.exports = {
 
 ```json
 {
-    "presets": ["@babel/env"],
+    "presets": ["@babel/preset-env"],
     "plugins": ["@babel/plugin-proposal-class-properties"]
+}
 ```
 
 5. Finally, create your first test, for instance `hello_controller.test.js`:
 
 ```js
-import { Application } from 'stimulus';
+import { Application } from '@hotwired/stimulus';
 import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
 import HelloController from '../controllers/hello_controller.js';
 

dist/index.js

@@ -1,30 +0,0 @@
-/*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mountDOM = exports.clearDOM = void 0;
-
-var mountDOM = function mountDOM() {
-  var htmlString = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  var div = document.createElement('div');
-  div.innerHTML = htmlString;
-  document.body.appendChild(div);
-  return div;
-};
-
-exports.mountDOM = mountDOM;
-
-var clearDOM = function clearDOM() {
-  document.body.innerHTML = '';
-};
-
-exports.clearDOM = clearDOM;

dist/setup.js

@@ -1,15 +0,0 @@
-/*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-'use strict';
-
-require("mutationobserver-shim");
-
-require("regenerator-runtime/runtime.js");
-
-require("@testing-library/jest-dom");

package.json

@@ -1,18 +1,15 @@
 {
     "name": "@symfony/stimulus-testing",
     "description": "@testing-library integration for Symfony UX",
-    "version": "1.0.0",
-    "main": "dist/index.js",
+    "version": "2.1.0",
+    "main": "src/index.js",
     "license": "MIT",
     "author": "Titouan Galopin <galopintitouan@gmail.com>",
     "engines": {
         "node": "^10.13.0 || >=12.0.0"
     },
     "scripts": {
-        "build": "babel src -d dist"
-    },
-    "peerDependencies": {
-        "stimulus": "^1.0"
+        "test": "jest"
     },
     "dependencies": {
         "@testing-library/dom": "^7.28.1",
@@ -24,14 +21,18 @@
         "regenerator-runtime": "^0.13.7"
     },
     "devDependencies": {
-        "@babel/cli": "^7.12.1",
         "@babel/core": "^7.12.3",
-        "@babel/plugin-proposal-class-properties": "^7.12.1",
-        "@babel/preset-env": "^7.12.7"
+        "@babel/preset-env": "^7.12.7",
+        "@hotwired/stimulus": "^3.0.0"
+    },
+    "jest": {
+        "testRegex": "test/.*\\.test.js",
+        "setupFilesAfterEnv": [
+            "./setup.js"
+        ]
     },
     "files": [
         "src/",
-        "dist/",
         "setup.js"
     ]
 }

setup.js

@@ -1 +1 @@
-require('./dist/setup.js');
+require('./src/setup.js');

src/index.js

@@ -9,7 +9,7 @@
 
 'use strict';
 
-const mountDOM = (htmlString = '') => {
+module.exports.mountDOM = (htmlString = '') => {
     const div = document.createElement('div');
     div.innerHTML = htmlString;
     document.body.appendChild(div);
@@ -17,8 +17,6 @@ const mountDOM = (htmlString = '') => {
     return div;
 };
 
-const clearDOM = () => {
+module.exports.clearDOM = () => {
     document.body.innerHTML = '';
 };
-
-export { clearDOM, mountDOM };

src/setup.js

@@ -9,6 +9,6 @@
 
 'use strict';
 
-import 'mutationobserver-shim';
-import 'regenerator-runtime/runtime.js';
-import '@testing-library/jest-dom';
+require('mutationobserver-shim');
+require('regenerator-runtime/runtime.js');
+require('@testing-library/jest-dom');

test/controller.test.js

@@ -0,0 +1,47 @@
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+import { Application, Controller } from '@hotwired/stimulus';
+import { getByTestId, waitFor } from '@testing-library/dom';
+import { clearDOM, mountDOM } from '../src/index';
+
+// Controller used to check the actual controller was properly booted
+class AppController extends Controller {
+    connect() {
+        this.element.classList.add('connected');
+    }
+}
+
+const startStimulus = () => {
+    const application = Application.start();
+    application.register('app', AppController);
+};
+
+describe('AppController', () => {
+    let container;
+
+    beforeEach(() => {
+        container = mountDOM(`
+            <div data-testid="app" data-controller="app"></div>
+        `);
+    });
+
+    afterEach(() => {
+        clearDOM();
+    });
+
+    it('connect', async () => {
+        expect(getByTestId(container, 'app')).not.toHaveClass('connected');
+
+        startStimulus();
+        await waitFor(() => expect(getByTestId(container, 'app')).toHaveClass('connected'));
+    });
+});