@amedia/jest-config 1.0.3 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,85 @@
 # @amedia/jest-config
 
+## 2.1.0
+
+### Minor Changes
+
+- 326dc56: Declare `engines.node: ">=22"` on every published package. Matches the
+  constraint already set at the repository root. Consumers on older Node versions
+  will see an `npm WARN` on install (or an error with `engine-strict=true`).
+
+### Patch Changes
+
+- 7577d72: Rewrite all package READMEs to a consistent `# Title / tagline / Install / Use
+/ Notes` shape. Drops stale `.eslintrc.js` / CJS examples, removes redundant
+  "install plugin X yourself" instructions for plugins that are now bundled,
+  and adds READMEs for the eight packages that previously had none
+  (`biome-config`, `browserslist-config`, `jest-config`, `kragl-eslint`,
+  `kragl-lockfile-lint`, `kragl-ls-lint`, `kragl-utils`).
+
+  The `@amedia/eslint-config-react` README now documents its temporary freeze
+  on the previous major.
+
+## 2.0.0
+
+### Major Changes
+
+- d6346cc: Kragl 4.x
+
+  _Get ready: This release breaks the world._
+
+  ESLint 9 introduces a new configuration format (flat config files)[^1]
+  so as we move to ESLint 9 we need to re-do all the ESLint configuration
+  both in this package, and in downstream repos.
+
+  See the configuration docs for how to setup kragl for your project.
+
+  [^1]: https://eslint.org/docs/latest/use/configure/configuration-files
+
+  We are all-in on ECMAScript Modules at Amedia, but have been held back
+  in this repo due to the tools we depend on have lagged behind. Now the
+  world is ready, and we are making the move.
+
+  Changes that hit the consumer are things like `.prettierrc.cjs` will not
+  work with the `@amedia/prettier-config` package and the consumer needs
+  to move to `prettier.config.js` with ESM syntax.
+
+  `@amedia/eslint-config` exports an helper function that generates an
+  ESLint configuration that complies with our standards, it supports both
+  toggling options and full-on custom configuration.
+
+  For example, a TypeScript + Svelte project:
+
+  ```
+  import eslintConfig from '@amedia/eslint-config';
+
+  export default eslintConfig({
+    typescript: true,
+    svelte: true,
+  });
+  ```
+
+  We have had a long-standing issue of the LSP hanging when interacting
+  with our Prettier configuration. This was likely due to our Prettier
+  configuration dynamically loading the Svelte plugin if it was necessary.
+  Some versions of Prettier struggle with that, so for kragl 4.x the
+  consumer manually decides if the standard or svelte prettier
+  configuration should be used.
+
+  Standard:
+
+  ```
+  // prettier.config.js
+  export { default } from '@amedia/prettier-config';
+  ```
+
+  Svelte:
+
+  ```
+  // prettier.config.js
+  export { svelte as default } from '@amedia/prettier-config';
+  ```
+
 ## 1.0.3
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,36 @@
+# @amedia/jest-config
+
+Amedia's shared Jest base configuration. Sensible defaults for coverage,
+test environment, and verbosity.
+
+## Install
+
+```sh
+npm install --save-dev @amedia/jest-config jest
+```
+
+## Use
+
+```js
+// jest.config.js
+import base from '@amedia/jest-config';
+
+export default base;
+```
+
+Or extend it with project-specific options:
+
+```js
+// jest.config.js
+import base from '@amedia/jest-config';
+
+export default {
+  ...base,
+  setupFilesAfterEach: ['<rootDir>/jest.setup.js'],
+};
+```
+
+## Notes
+
+Requires Node 22+. Run Jest through [`@amedia/kragl-jest`](../kragl-jest) for
+the standard kragl pipeline.

package/{index.cjs → index.js}

@@ -1,7 +1,7 @@
-const { join } = require('node:path');
-const { cwd } = require('node:process');
+import { join } from 'node:path';
+import { cwd } from 'node:process';
 
-module.exports = {
+export default {
   rootDir: join(cwd()),
   cache: false,
   collectCoverage: true,

package/package.json

@@ -1,18 +1,20 @@
 {
   "name": "@amedia/jest-config",
-  "version": "1.0.3",
+  "version": "2.1.0",
   "description": "Jest config for Amedia",
-  "type": "commonjs",
-  "main": "./index.cjs",
+  "type": "module",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    }
+  },
   "author": "",
   "license": "ISC",
-  "devDependencies": {
-    "jest": "28.1.3"
-  },
-  "peerDependencies": {
-    "jest": "28.x"
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
   }
 }