fix: Disable @trivago/prettier-plugin-sort-imports temporarily (#142)

See #141

Author: jhnns

.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

package-lock.json

@@ -14,6 +14,7 @@
         "test:node": "cd tests/node; eslint --max-warnings 0 .",
         "test:typescript": "cd tests/typescript; eslint --max-warnings 0 .",
         "test:react": "cd tests/react; eslint --max-warnings 0 .",
+        "test:prettier": "prettier --check .",
         "prepare": "husky",
         "release": "semantic-release"
     },
@@ -43,7 +44,7 @@
         "eslint": "^8.1.0"
     },
     "dependencies": {
-        "@babel/core": "^7.24.3",
+        "@babel/core": "^7.24.4",
         "@babel/eslint-parser": "^7.24.1",
         "@babel/eslint-plugin": "^7.23.5",
         "@trivago/prettier-plugin-sort-imports": "^4.3.0",
@@ -58,7 +59,8 @@
     },
     "devDependencies": {
         "@babel/plugin-proposal-class-properties": "^7.18.6",
-        "@babel/preset-env": "^7.24.3",
+        "@babel/plugin-syntax-import-attributes": "^7.24.1",
+        "@babel/preset-env": "^7.24.4",
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/git": "^10.0.1",
         "@types/react": "^18.2.69",

package.json

@@ -1,6 +1,9 @@
 "use strict";
 
 module.exports = {
-    plugins: ["@trivago/prettier-plugin-sort-imports"],
-    importOrder: ["^node:", "<THIRD_PARTY_MODULES>", "^[./]"],
+    // TODO: Re-add this plugin once it's fixed, https://github.com/peerigon/eslint-config-peerigon/issues/141
+    // This plugin breaks with import attributes like `import ... with { type: "json" }
+    // See https://github.com/trivago/prettier-plugin-sort-imports/issues/270
+    // plugins: ["@trivago/prettier-plugin-sort-imports"],
+    // importOrder: ["^node:", "<THIRD_PARTY_MODULES>", "^[./]"],
 };

prettier.config.js

@@ -1,4 +1,7 @@
 {
     "presets": ["@babel/preset-env"],
-    "plugins": ["@babel/plugin-proposal-class-properties"]
+    "plugins": [
+        "@babel/plugin-proposal-class-properties",
+        "@babel/plugin-syntax-import-attributes"
+    ]
 }

tests/javascript/babel.config.json

@@ -1,4 +1,6 @@
 import { getMessage } from "./message.js";
+// Check if import attributes are detected and formatted correctly
+import test from "./test.json" with { type: "json" };
 
 class SomeClass {
     #someProp = true;
@@ -8,4 +10,4 @@ class SomeClass {
     }
 }
 
-console.log(getMessage(), SomeClass);
+console.log(getMessage(), SomeClass, test);

tests/javascript/main.js

@@ -0,0 +1 @@
+{}

tests/javascript/test.json

@@ -1,4 +1,6 @@
 import { getMessage } from "./message.js";
+// Check if import attributes are detected and formatted correctly
+import test from "./test.json" with { type: "json" };
 
 // Should be an error
 // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -22,4 +24,4 @@ class SomeClass {
     snake_case() {}
 }
 
-console.log(getMessage(), SomeClass, snake_case);
+console.log(getMessage(), SomeClass, snake_case, test);

tests/typescript/main.ts

@@ -0,0 +1 @@
+{}

tests/typescript/test.json

@@ -5,6 +5,7 @@
         "lib": ["dom", "esnext"],
         "strict": true,
         "moduleResolution": "node",
-        "esModuleInterop": true
+        "esModuleInterop": true,
+        "resolveJsonModule": true
     }
 }