@amedia/jest-config 1.0.2 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # @amedia/jest-config
 
+## 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
+
+- dbb3437: add two new rules to eslint-base
+
+  Adding rules may cause previously linted code to fail, though these two
+  rules may be automatically fixed, so running `kragl lint --fix` should
+  resolve the simple cases automatically.
+
+  The reason for adding a requirement for the `node:` protocol prefix is
+  to make it absolutely clear that this is an internal node module. This
+  makes it easier for the reader to, as one example, immediately spot any
+  node modules that may need polyfill for the browser.
+
+  The second rules pushes us to use ESM everywhere it is expected by
+  default. All CommonJS code needs to be moved to `.cjs` files, regardless
+  if the module type is "module" or not.
+
+  This also serves to help us move to a pure ESM based ecosystem for
+  our internal codebase.
+
 ## 1.0.2
 
 ### Patch Changes

package/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,17 +1,16 @@
 {
   "name": "@amedia/jest-config",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Jest config for Amedia",
-  "type": "commonjs",
-  "main": "./index.js",
+  "type": "module",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    }
+  },
   "author": "",
   "license": "ISC",
-  "devDependencies": {
-    "jest": "28.1.3"
-  },
-  "peerDependencies": {
-    "jest": "28.x"
-  },
   "publishConfig": {
     "access": "public"
   }