chore: upgrade eslint and typescript-eslint

+ fix type issues
knjshimi · Dec 6, 2024 · efde5b0 · efde5b0
1 parent 3d33a95
commit efde5b0
Show file tree

Hide file tree

Showing 11 changed files with 323 additions and 251 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1 +1,22 @@
-{}
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.unicodeHighlight.ambiguousCharacters": false,
+    "editor.unicodeHighlight.invisibleCharacters": false,
+    "editor.wordWrap": "on",
+    "editor.rulers": [82]
+  },
+  "typescript.validate.enable": true,
+  "javascript.validate.enable": false,
+  "eslint.validate": ["javascript", "typescript"],
+  "eslint.useFlatConfig": true
+}
diff --git a/package.json b/package.json
@@ -30,13 +30,10 @@
   },
   "devDependencies": {
     "@types/node": "22.0.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
     "prettier": "^3.4.2",
     "tsup": "^8.3.5",
     "turbo": "^2.3.3",
-    "typescript": "^5.4.3",
-    "typescript-eslint": "^7.7.0"
+    "typescript": "^5.7.2"
   },
   "packageManager": "pnpm@9.14.4"
 }
diff --git a/packages/vite-plugin-shopify-assets/.eslintignore b/packages/vite-plugin-shopify-assets/.eslintignore
diff --git a/packages/vite-plugin-shopify-assets/.eslintrc.json b/packages/vite-plugin-shopify-assets/.eslintrc.json
diff --git a/packages/vite-plugin-shopify-assets/eslint.config.js b/packages/vite-plugin-shopify-assets/eslint.config.js
@@ -0,0 +1,33 @@
+// @ts-check
+
+import globals from 'globals';
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  {
+    ignores: ['**/dist/**', '**/node_modules/**'],
+  },
+  {
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+    },
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+  {
+    // disable type-aware linting on JS files
+    files: ['**/*.js'],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+);
diff --git a/packages/vite-plugin-shopify-assets/package.json b/packages/vite-plugin-shopify-assets/package.json
@@ -36,7 +36,7 @@
   "scripts": {
     "dev": "tsup --watch",
     "build": "tsup",
-    "lint": "eslint .",
+    "lint": "eslint . && tsc --noEmit",
     "format": "prettier --write .",
     "type-check": "tsc --noEmit"
   },
@@ -46,15 +46,17 @@
     "picomatch": "^3.0.1"
   },
   "devDependencies": {
+    "@eslint/js": "^9.16.0",
     "@types/node": "22.0.0",
     "@types/picomatch": "^2.3.3",
-    "eslint": "^8.57.0",
+    "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
+    "globals": "^15.13.0",
     "prettier": "^3.4.2",
     "rollup": "^4.13.0",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.3",
-    "typescript-eslint": "^7.7.0"
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.17.0"
   },
   "peerDependencies": {
     "vite": ">=5.0.0"

diff --git a/packages/vite-plugin-shopify-assets/src/build.ts b/packages/vite-plugin-shopify-assets/src/build.ts
@@ -8,7 +8,7 @@ import { normalizePath } from 'vite';
 import { copyAllAssetMap, getBundleFiles, isChildDir, logEvent, logWarn, logWarnConsole, renameFile } from './utils.js';
 
 import type { Logger, Plugin, ResolvedConfig, UserConfig } from 'vite';
-import type { RenderedChunk } from 'rollup';
+import type { OutputAsset, OutputChunk } from 'rollup';
 import type { ResolvedTarget, ResolvedPluginShopifyAssetsOptions } from './options.js';
 
 export type AssetMap = Map<string, ResolvedTarget>;
@@ -154,7 +154,7 @@ export const buildPlugin = ({
       }
     },
 
-    async writeBundle(_, bundle: { [fileName: string]: RenderedChunk }): Promise<void> {
+    async writeBundle(_, bundle: { [fileName: string]: OutputAsset | OutputChunk }): Promise<void> {
       if (!clean) return;
 
       const themeAssetFiles = readdirSync(themeAssetsDir);
@@ -174,7 +174,7 @@ export const buildPlugin = ({
         const matchToDelete = matchFiles.filter((file) => !assetDestSet.has(file));
         if (!matchToDelete.length) continue;
 
-        filesToDelete.add(...matchToDelete);
+        matchToDelete.forEach((file) => filesToDelete.add(file));
       }
 
       if (!filesToDelete.size) return;
@@ -183,8 +183,10 @@ export const buildPlugin = ({
         Array.from(filesToDelete).map(async (file) => {
           return existsSync(file) ? unlink(file).then(() => Promise.resolve(file)) : Promise.resolve(file);
         }),
-      ).catch((error: Error) => {
-        if (!silent) logger.error(error);
+      ).catch((error: unknown) => {
+        if (silent) return;
+        const message = error instanceof Error ? error.message : 'An unknown error occurred while deleting files';
+        logger.error(message);
       });
     },
 
@@ -219,8 +221,10 @@ export const buildPlugin = ({
               const relativeDeleted = relative(themeRoot, asset.dest);
               logEvent(event, relativeDeleted, logger);
             })
-            .catch((error: Error) => {
-              if (!silent) logger.error(error);
+            .catch((error: unknown) => {
+              if (silent) return;
+              const message = error instanceof Error ? error.message : 'An unknown error occurred while deleting files';
+              logger.error(message);
             });
         }
 

diff --git a/packages/vite-plugin-shopify-assets/src/serve.ts b/packages/vite-plugin-shopify-assets/src/serve.ts
@@ -93,8 +93,10 @@ export const servePlugin = ({
               logEvent('delete', relativePath, logger, true);
             }
           })
-          .catch((error: Error) => {
-            if (!silent) logger.error(error);
+          .catch((error: unknown) => {
+            if (silent) return;
+            const message = error instanceof Error ? error.message : 'An unknown error occurred while deleting files';
+            logger.error(message);
           });
       }
 
@@ -104,7 +106,7 @@ export const servePlugin = ({
       }
     },
 
-    watchChange(fileChanged: string, { event }): Promise<void> {
+    async watchChange(fileChanged: string, { event }): Promise<void> {
       if (!onServe) return;
 
       const target = targets.find((_target) => picomatch(_target.src)(fileChanged));
@@ -119,16 +121,18 @@ export const servePlugin = ({
       switch (event) {
         case 'create':
         case 'update':
-          copyAsset(target, fileChanged, event, logger, silent).catch((error: Error) => {
-            if (!silent) logger.error(error);
+          return copyAsset(target, fileChanged, event, logger, silent).catch((error: unknown) => {
+            if (silent) return;
+            const message = error instanceof Error ? error.message : 'An unknown error occurred while copying files';
+            logger.error(message);
           });
-          break;
 
         case 'delete':
-          deleteAsset(target, fileChanged, event, logger, silent).catch((error: Error) => {
-            if (!silent) logger.error(error);
+          return deleteAsset(target, fileChanged, event, logger, silent).catch((error: unknown) => {
+            if (silent) return;
+            const message = error instanceof Error ? error.message : 'An unknown error occurred while deleting files';
+            logger.error(message);
           });
-          break;
       }
     },
   };

diff --git a/packages/vite-plugin-shopify-assets/src/utils.ts b/packages/vite-plugin-shopify-assets/src/utils.ts
@@ -6,7 +6,8 @@ import fg from 'fast-glob';
 import { normalizePath } from 'vite';
 
 import type { Logger } from 'vite';
-import type { RenderedChunk } from 'rollup';
+import type { OutputAsset, OutputChunk } from 'rollup';
+// import type { RenderedChunk } from 'rollup';
 import type { AssetMap } from './build.js';
 import type { ResolvedTarget, RenameFunc } from './options.js';
 
@@ -140,9 +141,9 @@ export const copyAsset = async (
     preserveTimestamps: target.preserveTimestamps,
   })
     .then(() => logEvent(event, relativePath, logger, true))
-    .catch((error: Error) => {
+    .catch((error: unknown) => {
       logError(`could not create ${relativePath}`, logger, true);
-      if (!silent) logger.error(error);
+      if (!silent && error instanceof Error) logger.error(error.message);
     });
 };
 
@@ -163,9 +164,9 @@ export const deleteAsset = async (
 
   unlink(destPath)
     .then(() => logEvent(event, relativePath, logger, true))
-    .catch((error: Error) => {
+    .catch((error: unknown) => {
       logError(`Could not delete ${relativePath}`, logger, true);
-      if (!silent) logger.error(error);
+      if (!silent && error instanceof Error) logger.error(error.message);
     });
 };
 
@@ -203,9 +204,9 @@ export const copyAllAssets = async (
       .then(() => {
         if (!fileExists) logCopySuccess(dest, src, logger, timestamp);
       })
-      .catch((error: Error) => {
+      .catch((error: unknown) => {
         logCopyError(dest, src, logger, timestamp);
-        if (!silent) logger.error(error);
+        if (!silent && error instanceof Error) logger.error(error.message);
       });
   }
 };
@@ -238,16 +239,16 @@ export const copyAllAssetMap = async (
       .then(() => {
         if (!fileExists) logCopySuccess(target.dest, src, logger, timestamp);
       })
-      .catch((error: Error) => {
+      .catch((error: unknown) => {
         logCopyError(target.dest, src, logger, timestamp);
-        if (!silent) logger.error(error);
+        if (!silent && error instanceof Error) logger.error(error.message);
       });
   }
 };
 
 export const getFilesToDeleteInThemeAssets = async (
   themeAssetsDir: string,
-  bundle: { [fileName: string]: RenderedChunk },
+  bundle: { [fileName: string]: OutputAsset | OutputChunk },
   assetDestSet: Set<string>,
 ): Promise<string[]> => {
   if (!bundle || !Object.keys(bundle).length) {
@@ -262,6 +263,7 @@ export const getFilesToDeleteInThemeAssets = async (
     }
 
     if (chunk.type === 'asset') {
+      console.log('asset', fileName);
       return [...acc, fileName];
     }
 
@@ -293,7 +295,7 @@ export const getFilesToDeleteInThemeAssets = async (
   return filesToDelete;
 };
 
-export const getBundleFiles = (bundle: { [fileName: string]: RenderedChunk }): string[] => {
+export const getBundleFiles = (bundle: { [fileName: string]: OutputAsset | OutputChunk }): string[] => {
   if (!bundle || !Object.keys(bundle).length) {
     return [];
   }

diff --git a/packages/vite-plugin-shopify-assets/tsconfig.json b/packages/vite-plugin-shopify-assets/tsconfig.json
@@ -19,7 +19,7 @@
     "baseUrl": ".",
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    "skipLibCheck": false
+    "skipLibCheck": true
   },
   "include": ["*.ts", "src/**/*.ts"],
   "exclude": ["dist", "build", "node_modules"]