@amedia/prettier-config - npm Package Compare versions

Comparing version 0.0.0-SNAPSHOT-20240830181555 to 0.0.0-esm-rc-20241115102141

CHANGELOG.md

 # @amedia/prettier-config
 
-## 0.0.0-SNAPSHOT-20240830181555
+## 0.0.0-esm-rc-20241115102141
 
+### Major Changes
+
+- 5db918d: 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';
+  ```
+
 ### Patch Changes
 
-- 2722a78: bump prettier-plugin-svelte to 3.2.6
+- Updated dependencies [5db918d]
+  - @amedia/prettier-config-base@0.0.0-esm-rc-20241115102141
 
@@ -9,0 +68,0 @@ ## 1.0.6

package.json

 {
   "name": "@amedia/prettier-config",
-  "version": "0.0.0-SNAPSHOT-20240830181555",
+  "version": "0.0.0-esm-rc-20241115102141",
   "description": "Prettier config for Amedia",
-  "type": "commonjs",
-  "main": "./index.cjs",
+  "type": "module",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    }
+  },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@amedia/kragl-utils": "1.2.1",
-    "@amedia/prettier-config-base": "1.0.2",
-    "prettier-plugin-svelte": "3.2.6"
+    "@amedia/prettier-config-base": "0.0.0-esm-rc-20241115102141",
+    "prettier-plugin-svelte": "3.2.7"
   },
-  "devDependencies": {
-    "prettier": "3.1.0"
-  },
-  "peerDependencies": {
-    "prettier": "3.x"
-  },
   "publishConfig": {
@@ -21,0 +19,0 @@ "access": "public"

No alert changes

Improved metrics

Total package byte prevSize

9111

increased by23.56%

Dependency count

2

decreased by-50%

Dev dependency count

0

decreased by-100%

Number of package files

6

increased by50%

Is type module

Yes

Worsened metrics

Lines of code

14

decreased by-26.32%

Dependency changes

• + Added@amedia/prettier-config-base@0.0.0-esm-rc-20241115102141(transitive)

• + Addedprettier-plugin-svelte@3.2.7(transitive)

• - Removed@amedia/kragl-utils@1.2.1

• - Removed@amedia/kragl-utils@1.2.1(transitive)

• - Removed@amedia/prettier-config-base@1.0.2(transitive)

• - Removed@nodelib/fs.scandir@2.1.5(transitive)

• - Removed@nodelib/fs.stat@2.0.5(transitive)

• - Removed@nodelib/fs.walk@1.2.8(transitive)

• - Removedbraces@3.0.3(transitive)

• - Removedcross-spawn@7.0.6(transitive)

• - Removedexeca@6.1.0(transitive)

• - Removedfast-glob@3.2.11(transitive)

• - Removedfastq@1.19.0(transitive)

• - Removedfill-range@7.1.1(transitive)

• - Removedget-stream@6.0.1(transitive)

• - Removedglob-parent@5.1.2(transitive)

• - Removedhuman-signals@3.0.1(transitive)

• - Removedis-extglob@2.1.1(transitive)

• - Removedis-glob@4.0.3(transitive)

• - Removedis-number@7.0.0(transitive)

• - Removedis-stream@3.0.0(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removedmerge-stream@2.0.0(transitive)

• - Removedmerge2@1.4.1(transitive)

• - Removedmicromatch@4.0.8(transitive)

• - Removedmimic-fn@4.0.0(transitive)

• - Removednpm-run-path@5.3.0(transitive)

• - Removedonetime@6.0.0(transitive)

• - Removedpath-key@3.1.14.0.0(transitive)

• - Removedpicomatch@2.3.1(transitive)

• - Removedprettier-plugin-svelte@3.2.6(transitive)

• - Removedqueue-microtask@1.2.3(transitive)

• - Removedreusify@1.0.4(transitive)

• - Removedrun-parallel@1.2.0(transitive)

• - Removedshebang-command@2.0.0(transitive)

• - Removedshebang-regex@3.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedstrip-final-newline@3.0.0(transitive)

• - Removedto-regex-range@5.0.1(transitive)

• - Removedwhich@2.0.2(transitive)

• Updated@amedia/prettier-config-base@0.0.0-esm-rc-20241115102141

• Updatedprettier-plugin-svelte@3.2.7