style: update prettier@2 to prettier@3, reformat all files

prettier@3 defaults trailingComma to on, which is nicer anyways.
Since this change is accepted, all files are formatted with the new
style using `fd . --exec npx prettier --write;`.

This change was spurred on by the update included in #18.

README.md

@@ -4,13 +4,13 @@ Encourage use of defined aliases in TSConfig/JSConfig through ESLint.
 
 ## Why
 
--   Automatic imports by tsserver resolve to relative paths that can be normalized.
--   It's easier to refactor by finding and replacing an absolute module path
-    without worrying about crafting the regex for `../` and `./`
+- Automatic imports by tsserver resolve to relative paths that can be normalized.
+- It's easier to refactor by finding and replacing an absolute module path
+  without worrying about crafting the regex for `../` and `./`
 
 ## Requirements
 
--   Node 14+
+- Node 14+
 
 ## Install
 
@@ -32,8 +32,8 @@ Check the [rules documentation][docs-import-alias] for further configuration.
 {
     "plugins": ["@limegrass/import-alias"],
     "rules": {
-        "@limegrass/import-alias/import-alias": "error"
-    }
+        "@limegrass/import-alias/import-alias": "error",
+    },
 }
 ```
 
@@ -44,8 +44,8 @@ The configuration above is also equivalent to
 {
     "extends": [
         // ... - your other extends, such as `"eslint:recommended"`
-        "plugin:@limegrass/import-alias/recommended"
-    ]
+        "plugin:@limegrass/import-alias/recommended",
+    ],
 }
 ```
 

docs/rules/import-alias.md

@@ -11,9 +11,9 @@ Given the following `tsconfig.json`
         // ...
         "paths": {
             "#src/*": ["src/*"],
-            "#rules/*": ["src/rules/*"]
-        }
-    }
+            "#rules/*": ["src/rules/*"],
+        },
+    },
 }
 ```
 
@@ -55,10 +55,10 @@ parameter of a function named `potato` for aliasing.
         "@limegrass/import-alias/import-alias": [
             "error",
             {
-                "aliasImportFunctions": ["require", "mock", "potato"]
-            }
-        ]
-    }
+                "aliasImportFunctions": ["require", "mock", "potato"],
+            },
+        ],
+    },
 }
 ```
 
@@ -79,10 +79,10 @@ configuration key. An example for a tsconfig found in a `config` folder of a pro
         "@limegrass/import-alias/import-alias": [
             "error",
             {
-                "aliasConfigPath": "config/tsconfig.json"
-            }
-        ]
-    }
+                "aliasConfigPath": "config/tsconfig.json",
+            },
+        ],
+    },
 }
 ```
 
@@ -110,10 +110,10 @@ The follow example would allow sibling imports for the entire project.
         "@limegrass/import-alias/import-alias": [
             "error",
             {
-                "relativeImportOverrides": [{ "path": ".", "depth": 0 }]
-            }
-        ]
-    }
+                "relativeImportOverrides": [{ "path": ".", "depth": 0 }],
+            },
+        ],
+    },
 }
 ```
 

eslint.config.mjs

@@ -26,8 +26,8 @@ export default [
             "plugin:@typescript-eslint/recommended",
             "plugin:import/recommended",
             "plugin:import/typescript",
-            "prettier",
             "plugin:@limegrass/import-alias/recommended",
+            "prettier",
         ),
     ),
     {

package.json

@@ -49,7 +49,7 @@
         "jest": "^29.7.0",
         "jest-mock": "^29.7.0",
         "lint-staged": "^12.3.5",
-        "prettier": "^2.5.1",
+        "prettier": "^3",
         "rimraf": "^6.0.1",
         "ts-jest": "^29.1.4",
         "ts-node": "^10.7.0",

src/alias-config.ts

@@ -17,7 +17,7 @@ type AliasConfig = {
 function loadTsconfig(
     eslintConfigPath: string,
     aliasConfigPath: string | undefined,
-    codeFilePath: string
+    codeFilePath: string,
 ) {
     let config: ConfigLoaderResult;
     try {
@@ -26,7 +26,7 @@ function loadTsconfig(
                 config = loadConfig(aliasConfigPath);
             } else {
                 config = loadConfig(
-                    joinPath(eslintConfigPath, aliasConfigPath)
+                    joinPath(eslintConfigPath, aliasConfigPath),
                 );
             }
         } else {
@@ -35,15 +35,15 @@ function loadTsconfig(
     } catch (error) {
         if (error instanceof SyntaxError) {
             throw new Error(
-                `SyntaxError in TSConfig/JSConfig: ${error.message}`
+                `SyntaxError in TSConfig/JSConfig: ${error.message}`,
             );
         }
         throw error;
     }
 
     if (config.resultType !== "success") {
         throw new Error(
-            `validate tsconfig or jsconfig provided and ensure compilerOptions.baseUrl is set: ${config.message}`
+            `validate tsconfig or jsconfig provided and ensure compilerOptions.baseUrl is set: ${config.message}`,
         );
     }
 
@@ -52,7 +52,7 @@ function loadTsconfig(
 
 function loadAliasConfigs(
     config: ConfigLoaderSuccessResult,
-    projectBaseDir: string
+    projectBaseDir: string,
 ): AliasConfig[] {
     return Object.entries(config.paths).reduce(
         (configs, [aliasGlob, aliasPaths]) => {
@@ -67,7 +67,7 @@ function loadAliasConfigs(
             });
             return configs;
         },
-        [] as AliasConfig[]
+        [] as AliasConfig[],
     );
 }
 

src/rules/import-alias.ts

@@ -22,7 +22,7 @@ function isPermittedRelativeImport(
     importModuleName: string,
     relativeImportOverrides: RelativeImportConfig[],
     filepath: string,
-    projectBaseDir: string
+    projectBaseDir: string,
 ) {
     const isRelativeImport =
         importModuleName.length > 0 && importModuleName[0] !== ".";
@@ -32,7 +32,7 @@ function isPermittedRelativeImport(
 
     const importParts = importModuleName.split("/");
     const relativeDepth = importParts.filter(
-        (moduleNamePart) => moduleNamePart === ".."
+        (moduleNamePart) => moduleNamePart === "..",
     ).length;
     const relativeFilepath = relative(projectBaseDir, filepath);
 
@@ -53,13 +53,13 @@ function isPermittedRelativeImport(
 function getAliasSuggestion(
     importModuleName: string,
     aliasConfigs: AliasConfig[],
-    absoluteDir: string
+    absoluteDir: string,
 ) {
     const currentAliasConfig: AliasConfig | undefined = aliasConfigs.find(
         ({ alias }) => {
             const [baseModulePath] = importModuleName.split("/");
             return baseModulePath === alias;
-        }
+        },
     );
 
     let absoluteModulePath: string | undefined = undefined;
@@ -75,15 +75,15 @@ function getAliasSuggestion(
         const bestAliasConfig = getBestAliasConfig(
             aliasConfigs,
             currentAliasConfig,
-            absoluteModulePath
+            absoluteModulePath,
         );
 
         if (bestAliasConfig && bestAliasConfig !== currentAliasConfig) {
             return slash(
                 absoluteModulePath.replace(
                     bestAliasConfig.path.absolute,
-                    bestAliasConfig.alias
-                )
+                    bestAliasConfig.alias,
+                ),
             );
         }
     }
@@ -92,7 +92,7 @@ function getAliasSuggestion(
 function getBestAliasConfig(
     aliasConfigs: AliasConfig[],
     currentAlias: AliasConfig | undefined,
-    absoluteModulePath: string
+    absoluteModulePath: string,
 ) {
     const importPathParts = absoluteModulePath.split(pathSep);
     return aliasConfigs.reduce((currentBest, potentialAlias) => {
@@ -101,7 +101,7 @@ function getBestAliasConfig(
             (isValid, aliasPathPart, index) => {
                 return isValid && importPathParts[index] === aliasPathPart;
             },
-            true
+            true,
         );
         const isMoreSpecificAlias =
             !currentBest ||
@@ -303,7 +303,7 @@ const importAliasRule: Rule.RuleModule = {
             return reportProgramError(
                 "a filepath must be provided, try with --stdin-filename, " +
                     "call eslint on a file, " +
-                    "or save your buffer as a file and restart eslint in your editor."
+                    "or save your buffer as a file and restart eslint in your editor.",
             );
         }
 
@@ -331,7 +331,7 @@ const importAliasRule: Rule.RuleModule = {
 
         const getReportDescriptor = (
             [moduleStart, moduleEnd]: [number, number],
-            importModuleName: string
+            importModuleName: string,
         ) => {
             // preserve user quote style
             const quotelessRange: AST.Range = [moduleStart + 1, moduleEnd - 1];
@@ -341,7 +341,7 @@ const importAliasRule: Rule.RuleModule = {
                     importModuleName,
                     relativeImportOverrides,
                     filepath,
-                    projectBaseDir
+                    projectBaseDir,
                 )
             ) {
                 return undefined;
@@ -350,7 +350,7 @@ const importAliasRule: Rule.RuleModule = {
             const aliasSuggestion = getAliasSuggestion(
                 importModuleName,
                 aliasesResult,
-                absoluteDir
+                absoluteDir,
             );
 
             if (aliasSuggestion) {
@@ -359,7 +359,7 @@ const importAliasRule: Rule.RuleModule = {
                     fix: (fixer: Rule.RuleFixer) => {
                         return fixer.replaceTextRange(
                             quotelessRange,
-                            aliasSuggestion
+                            aliasSuggestion,
                         );
                     },
                 };
@@ -370,7 +370,7 @@ const importAliasRule: Rule.RuleModule = {
             if (!isAllowBaseUrlResolvedImport) {
                 const joinedModulePath = joinPath(
                     projectBaseDir,
-                    importModuleName
+                    importModuleName,
                 );
                 let moduleExists = false;
                 try {
@@ -387,22 +387,22 @@ const importAliasRule: Rule.RuleModule = {
                     const aliasConfig = getBestAliasConfig(
                         aliasesResult,
                         undefined,
-                        joinedModulePath
+                        joinedModulePath,
                     );
 
                     if (aliasConfig) {
                         const suggestedPathImport = slash(
                             joinedModulePath.replace(
                                 aliasConfig.path.absolute,
-                                aliasConfig.alias
-                            )
+                                aliasConfig.alias,
+                            ),
                         );
                         return {
                             message: `import ${importModuleName} can be written as ${suggestedPathImport}`,
                             fix: (fixer: Rule.RuleFixer) => {
                                 return fixer.replaceTextRange(
                                     quotelessRange,
-                                    suggestedPathImport
+                                    suggestedPathImport,
                                 );
                             },
                         };
@@ -421,12 +421,12 @@ const importAliasRule: Rule.RuleModule = {
             node:
                 | ImportDeclaration
                 | ExportAllDeclaration
-                | ExportNamedDeclaration
+                | ExportNamedDeclaration,
         ) => {
             if (node.source?.range && typeof node.source.value === "string") {
                 const suggestion = getReportDescriptor(
                     node.source.range,
-                    node.source.value
+                    node.source.value,
                 );
 
                 if (suggestion) {
@@ -455,7 +455,7 @@ const importAliasRule: Rule.RuleModule = {
                     ) {
                         const suggestion = getReportDescriptor(
                             importNameNode.range,
-                            importNameNode.value
+                            importNameNode.value,
                         );
 
                         if (suggestion) {

tests/rules/import-alias.config.ts

@@ -30,7 +30,7 @@ export function mockReaddir(filepath: string) {
 export function getMockAliasConfig(
     pathModule: typeof path,
     platform: "win32" | "posix",
-    projectDir: string
+    projectDir: string,
 ) {
     return [
         {
@@ -51,7 +51,7 @@ export function getMockAliasConfig(
                 absolute: pathModule[platform].join(
                     projectDir,
                     "src",
-                    "sub-directory"
+                    "sub-directory",
                 ),
             },
         },