Migrate to ESM Only (#48)

* feat!: migrate to ESM-only

* chore: speed up web build

* chore: fix ESM

* fix: mark Vitest 5 as supported

* ci: apply automated fixes and generate docs

* chore: fix CI

* docs: remove all contributors mention

Closees #42

* chore: fix tsconfig problems

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: crutchcorn

.changeset/modernize-dependencies.md

@@ -0,0 +1,5 @@
+---
+"cli-testing-library": major
+---
+
+Upgrade runtime dependencies to their latest major versions, require Node.js 22.18 or newer, publish ESM-only output built with tsdown, and spawn commands without a shell by default.

.prettierignore

@@ -1,6 +1,7 @@
 **/.next
 **/.nx/cache
 **/.svelte-kit
+**/.astro
 **/build
 **/coverage
 **/dist

docs/api.md

@@ -22,27 +22,25 @@ Instead, the following API is what `CLI Testing Library` provides the following.
 function render(
   command: string,
   args: string[],
-  options?: {
-    /* You won't often use this, expand below for docs on options */
-  },
-): RenderResult
+  options?: {/* You won't often use this, expand below for docs on options */},
+): RenderResult;
 ```
 
 Run the CLI application in a newly spawned process.
 
 ```javascript
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-render('node', ['./path/to/script.js'])
+render("node", ["./path/to/script.js"]);
 ```
 
 ```javascript
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-test('renders a message', () => {
-  const {getByText} = render('node', ['./console-out.js'])
-  expect(getByText('Hello, world!')).toBeTruthy()
-})
+test("renders a message", () => {
+  const { getByText } = render("node", ["./console-out.js"]);
+  expect(getByText("Hello, world!")).toBeTruthy();
+});
 ```
 
 # `render` Options
@@ -62,11 +60,11 @@ to have to specify the absolute path every time. In this case, you can specify a
 directory as the render `cwd`.
 
 ```javascript
-const containingPath = path.resolve(__dirname, './movables')
+const containingPath = path.resolve(__dirname, "./movables");
 
-const {getByText} = render('node', ['mover.js'], {
+const { getByText } = render("node", ["mover.js"], {
   cwd: containingPath,
-})
+});
 ```
 
 ## `spawnOpts`
@@ -79,11 +77,11 @@ underlying
 [`child_process.spawn` NodeJS API](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options).
 
 ```javascript
-const {getByText} = render('script.ps1', {
+const { getByText } = render("script.ps1", {
   spawnOpts: {
-    shell: 'powershell.exe',
+    shell: "powershell.exe",
   },
-})
+});
 ```
 
 # `render` Result
@@ -127,7 +125,7 @@ These options are all standard for text matching. To learn more, see our
 ## `userEvent[eventName]`
 
 ```javascript
-userEvent[eventName](...eventProps)
+userEvent[eventName](...eventProps);
 ```
 
 > While `userEvent` isn't usually returned on `render` in, say,
@@ -144,10 +142,10 @@ This object is the same as described with
 This method is a shortcut for `console.log(prettyCLI(instance)).`
 
 ```javascript
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-const {debug} = render('command')
-debug()
+const { debug } = render("command");
+debug();
 // Hello, world! How are you?
 //
 // you can also pass an instance: debug(getByText('message'))
@@ -166,9 +164,9 @@ This method allows you to check if the spawned process has exit, and if so, what
 exit code it closed with.
 
 ```javascript
-const instance = render('command')
+const instance = render("command");
 
-await waitFor(() => expect(instance.hasExit()).toMatchObject({exitCode: 1}))
+await waitFor(() => expect(instance.hasExit()).toMatchObject({ exitCode: 1 }));
 ```
 
 This method returns `null` if still running, but `{exitCode: number}` if it has
@@ -189,8 +187,8 @@ They're defined as:
 
 ```typescript
 interface TestInstance {
-  stdoutArr: Array<{contents: Buffer | string; timestamp: number}>
-  stderrArr: Array<{contents: Buffer | string; timestamp: number}>
+  stdoutArr: Array<{ contents: Buffer | string; timestamp: number }>;
+  stderrArr: Array<{ contents: Buffer | string; timestamp: number }>;
 }
 ```
 
@@ -214,15 +212,15 @@ For example, if you're using the [ava](https://github.com/avajs/ava) testing
 framework, then you would need to use the `test.afterEach` hook like so:
 
 ```javascript
-import {cleanup, render} from 'cli-testing-library'
-import test from 'ava'
+import { cleanup, render } from "cli-testing-library";
+import test from "ava";
 
-test.afterEach(cleanup)
+test.afterEach(cleanup);
 
-test('renders into document', () => {
-  render('long-running-command')
+test("renders into document", () => {
+  render("long-running-command");
   // ...
-})
+});
 
 // ... more tests ...
 ```

docs/configure.md

@@ -32,7 +32,7 @@ To disable a suggestion for a single query just add `{suggest:false}` as an
 option.
 
 ```js
-getByText('foo', {suggest: false}) // will not throw a suggestion
+getByText("foo", { suggest: false }); // will not throw a suggestion
 ```
 
 ### `getInstanceError`

docs/debug.md

@@ -9,7 +9,7 @@ When you use any `get` calls in your test cases, the current state of the
 
 ```javascript
 // Hello world
-getByText(container, 'Goodbye world') // will fail by throwing error
+getByText(container, "Goodbye world"); // will fail by throwing error
 ```
 
 The above test case will fail, however it prints the state of your DOM under
@@ -45,7 +45,7 @@ a process. This can be helpful for instance when debugging tests.
 It is defined as:
 
 ```typescript
-function prettyDOM(instance: TestInstance, maxLength?: number): string
+function prettyDOM(instance: TestInstance, maxLength?: number): string;
 ```
 
 It receives the `TestInstance` to print out, an optional extra parameter to

docs/differences.md

@@ -94,18 +94,18 @@ Usually, in a Testing Library testbed, you'd expect a `getByText` to look
 something like this:
 
 ```javascript
-const {getByText} = render(/* Something */)
+const { getByText } = render(/* Something */);
 
-expect(getByText('Hello World')).toBeInTheDocument()
+expect(getByText("Hello World")).toBeInTheDocument();
 ```
 
 In today's version of `CLI Testing Library`, the same would look something like
 this:
 
 ```javascript
-const {getByText} = render(/* Something */)
+const { getByText } = render(/* Something */);
 
-expect(getByText('Hello World')).toBeInTheConsole()
+expect(getByText("Hello World")).toBeInTheConsole();
 ```
 
 # Similarities

docs/fire-event.md

@@ -16,7 +16,7 @@ fireEvent(instance: TestInstance, event: EventString, eventProperties?: Object)
 Fire CLI events.
 
 ```javascript
-fireEvent(getByText(instance, 'Username:'), 'write', {value: 'crutchcorn'})
+fireEvent(getByText(instance, "Username:"), "write", { value: "crutchcorn" });
 ```
 
 ## `fireEvent[eventName]`

docs/matchers.md

@@ -14,10 +14,10 @@ and you're good to go:
 
 ```javascript
 // In your own jest-setup.js (or any other name)
-import 'cli-testing-library/jest'
+import "cli-testing-library/jest";
 
 // In jest.config.js add (if you haven't already)
-setupFilesAfterEnv: ['<rootDir>/jest-setup.js']
+setupFilesAfterEnv: ["<rootDir>/jest-setup.js"];
 ```
 
 ### With TypeScript
@@ -41,7 +41,7 @@ haven't already:
 ### `toBeInTheConsole`
 
 ```typescript
-toBeInTheConsole()
+toBeInTheConsole();
 ```
 
 This allows you to assert whether an instance is present or not. Useful when
@@ -55,7 +55,7 @@ Input your name:
 ```
 
 ```javascript
-expect(getByText(instance, 'Input your name:')).toBeInTheConsole()
+expect(getByText(instance, "Input your name:")).toBeInTheConsole();
 ```
 
 <hr />
@@ -86,5 +86,5 @@ File not found in output
 ```
 
 ```javascript
-expect(instance).toHaveErrorMessage('File not found in output')
+expect(instance).toHaveErrorMessage("File not found in output");
 ```

docs/queries.md

@@ -16,13 +16,13 @@ Library's,
 # Example
 
 ```javascript
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-test('should show login form', () => {
-  const {getByText} = render('ftp-automation.sh')
-  const input = getByText('Username')
+test("should show login form", () => {
+  const { getByText } = render("ftp-automation.sh");
+  const input = getByText("Username");
   // Events and assertions...
-})
+});
 ```
 
 # Types of Queries
@@ -68,33 +68,33 @@ Hello World
 
 ```javascript
 // Matching a string:
-getByText('Hello World') // full string match
-getByText('llo Worl', {exact: false}) // substring match
-getByText('hello world', {exact: false}) // ignore case
+getByText("Hello World"); // full string match
+getByText("llo Worl", { exact: false }); // substring match
+getByText("hello world", { exact: false }); // ignore case
 
 // Matching a regex:
-getByText(/World/) // substring match
-getByText(/world/i) // substring match, ignore case
-getByText(/^hello world$/i) // full string match, ignore case
-getByText(/Hello W?oRlD/i) // substring match, ignore case, searches for "hello world" or "hello orld"
+getByText(/World/); // substring match
+getByText(/world/i); // substring match, ignore case
+getByText(/^hello world$/i); // full string match, ignore case
+getByText(/Hello W?oRlD/i); // substring match, ignore case, searches for "hello world" or "hello orld"
 
 // Matching with a custom function:
-getByText((content, instance) => content.startsWith('Hello'))
+getByText((content, instance) => content.startsWith("Hello"));
 ```
 
 **_Will not_ find the instance:**
 
 ```javascript
 // full string does not match
-getByText('Goodbye World')
+getByText("Goodbye World");
 
 // case-sensitive regex with different case
-getByText(/hello world/)
+getByText(/hello world/);
 
 // function looking contents that don't exist:
 getByText((content, instance) => {
-  return instance.stdoutStr.includes('Goodbye World')
-})
+  return instance.stdoutStr.includes("Goodbye World");
+});
 ```
 
 ## Precision
@@ -143,19 +143,19 @@ behaviour:
 To perform a match against text without trimming:
 
 ```javascript
-getByText('text', {
-  normalizer: getDefaultNormalizer({trim: false}),
-})
+getByText("text", {
+  normalizer: getDefaultNormalizer({ trim: false }),
+});
 ```
 
 To override normalization to remove some Unicode characters whilst keeping some
 (but not all) of the built-in normalization behavior:
 
 ```javascript
-getByText('text', {
-  normalizer: str =>
-    getDefaultNormalizer({trim: false})(str).replace(/[\u200E-\u200F]*/g, ''),
-})
+getByText("text", {
+  normalizer: (str) =>
+    getDefaultNormalizer({ trim: false })(str).replace(/[\u200E-\u200F]*/g, ""),
+});
 ```
 
 # ByText
@@ -183,10 +183,10 @@ Input your name:
 ```
 
 ```jsx
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-const {getByText} = render('command')
-const instance = getByText(/input your name/i)
+const { getByText } = render("command");
+const instance = getByText(/input your name/i);
 ```
 
 ## Options
@@ -218,10 +218,10 @@ Could not find file
 ```
 
 ```jsx
-import {render} from 'cli-testing-library'
+import { render } from "cli-testing-library";
 
-const {getByError} = render('command')
-const instance = getByError(/not find file/)
+const { getByError } = render("command");
+const instance = getByError(/not find file/);
 ```
 
 ## Options