chore(eslint): comments in config

Author: coldlink

eslint.config.mjs

@@ -62,6 +62,7 @@ const config = tseslint.config(
 		},
 
 		rules: {
+			// fix no-unused-vars errors based on `noUnusedVarsPattern`
 			'@typescript-eslint/no-unused-vars': [
 				'error',
 				{
@@ -75,22 +76,24 @@ const config = tseslint.config(
 				},
 			],
 
-			'@typescript-eslint/only-throw-error': 'off',
-
+			// override functional rules
 			'functional/immutable-data': [
 				'error',
 				{
 					ignoreImmediateMutation: true,
 				},
 			],
-
 			'functional/prefer-immutable-types': 'off',
 			'functional/type-declaration-immutability': 'off',
+
+			// eslint rules
 			'no-var': 'error',
 			'no-param-reassign': 'error',
 			'no-sequences': 'error',
 			'no-console': 'error',
 			'prefer-const': 'error',
+
+			// disabled @guardian/eslint-config rules, we should enable some of them later
 			'import/order': 'off',
 			'@typescript-eslint/consistent-type-imports': 'off',
 			'@typescript-eslint/no-unsafe-assignment': 'off',
@@ -108,6 +111,7 @@ const config = tseslint.config(
 			'@typescript-eslint/no-unsafe-enum-comparison': 'off',
 			'import/no-named-as-default-member': 'off',
 			'import/no-cycle': 'off',
+			'@typescript-eslint/only-throw-error': 'off',
 		},
 	},
 	{