@codfish/eslint-config 12.0.0 → 12.1.0

package/README.md

@@ -48,8 +48,32 @@ Install the package and required peer dependencies:
 
 ```sh
 npm i -D eslint@9 @codfish/eslint-config
+
+# Optionally, you can uninstall plugins or presets you don't need to manage anymore,
+# @codfish/eslint-config includes them all.
+npm uninstall typescript-eslint \
+  eslint-config-prettier \
+  eslint-plugin-jest \
+  eslint-plugin-jsx-a11y \
+  eslint-plugin-prettier \
+  eslint-plugin-react \
+  eslint-plugin-react-hooks \
+  eslint-plugin-simple-import-sort \
+  eslint-plugin-testing-library \
+  eslint-plugin-yml \
+  @next/eslint-plugin-next \
+  eslint-plugin-next \
+  commitlint \
+  @commitlint/cli \
+  @commitlint/config-conventional
 ```
 
+> [!NOTE]
+>
+> Optionally, you can uninstall prettier as well. If you don't have prettier installed already but you want to format
+> other file types (like Markdown, JSON, CSS, etc.), you can install it as a dev dependency: `npm i -D prettier`. Then
+> you can use Prettier to format your non-JS files directly. Eslint will still run Prettier as an ESLint rule.
+
 ## Usage
 
 Create an `eslint.config.js` file in your project root:
@@ -255,14 +279,7 @@ preferences.
 **Prettier is included and runs automatically** through ESLint for JavaScript, TypeScript, JSX, and TSX files using the
 [built-in configuration](./prettier.js). **You don't need to install or configure Prettier separately** for basic usage.
 
-However, if you want to format other file types (like Markdown, JSON, CSS, or YAML) or run Prettier directly, you can
-install it as a dev dependency:
-
-```sh
-npm i -D prettier
-```
-
-You can then override the defaults by creating your own Prettier config file, or extend the built-in config:
+You can then override the default config by creating your own Prettier config file, or extend the built-in config:
 
 **Option 1: Extend the built-in config (Recommended)**
 
@@ -322,12 +339,11 @@ npm i -D eslint@9 @codfish/eslint-config prettier-plugin-tailwindcss
 ```js
 // prettier.config.js
 
-import codfishPrettier from '@codfish/eslint-config/prettier';
-import tailwindcss from 'prettier-plugin-tailwindcss';
+import codfish from '@codfish/eslint-config/prettier';
 
 /** @type {import('prettier').Config & import('prettier-plugin-tailwindcss').PluginOptions} */
 export default {
-  ...codfishPrettier,
+  ...codfish,
   plugins: ['prettier-plugin-tailwindcss'],
   tailwindStylesheet: './src/styles/app.css',
   tailwindFunctions: ['clsx'], // optional

package/dist/vitest.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vite").UserConfig;
+export default _default;
+//# sourceMappingURL=vitest.config.d.ts.map

package/dist/vitest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.js"],"names":[],"mappings":""}

package/index.js

@@ -20,12 +20,11 @@ const useBuiltinPrettierConfig = !hasLocalConfig('prettier');
  * Supports TypeScript, React, Jest, Vitest, Prettier, YAML, and Next.js
  */
 export default defineConfig([
-  // Base JavaScript configuration
   js.configs.recommended,
 
   tseslint.configs.recommended,
 
-  // Base configuration for all files
+  // Base opinionated rules
   {
     name: 'codfish/base',
 
@@ -44,6 +43,20 @@ export default defineConfig([
     },
 
     rules: {
+      // Error handling rules to enforce using the Error object
+      'no-throw-literal': 'error',
+      'prefer-promise-reject-errors': 'error',
+
+      // Asynchronous functions that don’t use await might not need to be asynchronous functions
+      // Usually result of refactoring, leads to misunderstanding/misusage
+      'require-await': 'error',
+
+      // Disallow console statements in regular code (only allowed in test files)
+      'no-console': 'error',
+
+      // Consolidate your imports
+      'no-duplicate-imports': ['error', { includeExports: false }],
+
       // Custom Grouping: https://github.com/lydell/eslint-plugin-simple-import-sort#custom-grouping
       // Examples: https://github.com/lydell/eslint-plugin-simple-import-sort/blob/main/examples/.eslintrc.js
       'simple-import-sort/imports': [
@@ -91,6 +104,36 @@ export default defineConfig([
     },
   },
 
+  {
+    name: 'codfish/ts-overrides',
+
+    files: ['**/*.ts', '**/*.tsx'],
+
+    rules: {
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/naming-convention': [
+        'error',
+        {
+          selector: ['interface', 'typeAlias'],
+          format: ['PascalCase'],
+          custom: {
+            regex: '^I[A-Z]', // prevent prefixing interfaces and type alias declarations with "I"
+            match: false,
+          },
+        },
+      ],
+      '@typescript-eslint/ban-ts-comment': [
+        'error',
+        {
+          // If you need to use a ts comment, make sure you have a description.
+          'ts-ignore': 'allow-with-description',
+          'ts-expect-error': 'allow-with-description',
+          'ts-nocheck': 'allow-with-description',
+        },
+      ],
+    },
+  },
+
   // Custom ignores
   {
     name: 'codfish/ignores',
@@ -146,6 +189,16 @@ export default defineConfig([
   ymlPlugin.configs['flat/standard'],
   ymlPlugin.configs['flat/prettier'], // handles conflicting rules with the yml plugin
 
+  {
+    name: 'codfish/github-yml-overrides',
+
+    files: ['.github/**/*.yml', '.github/**/*.yaml'],
+
+    rules: {
+      'yml/no-empty-mapping-value': 'off', // somewhat common in github workflows
+    },
+  },
+
   // React configuration (dynamic)
   ifAnyDep('react', reactConfig, []),
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codfish/eslint-config",
-  "version": "12.0.0",
+  "version": "12.1.0",
   "description": "Modern ESLint configuration with TypeScript, React, and testing framework support.",
   "type": "module",
   "repository": {
@@ -48,6 +48,9 @@
     "type-check": "tsc --noEmit",
     "lint": "eslint .",
     "fix": "prettier --write \"**/*.{json,css,scss,md}\" --config ./prettier.js && npm run lint -- --fix",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage",
     "prepublishOnly": "npm run build",
     "prepare": "husky"
   },
@@ -78,7 +81,8 @@
     "eslint": "^9.35.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.1.6",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vitest": "^1.0.0"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -94,10 +98,11 @@
     "commitlint.js"
   ],
   "peerDependencies": {
-    "eslint": ">= 9"
+    "eslint": ">= 9",
+    "prettier": ">= 3"
   },
   "peerDependenciesMeta": {
-    "typescript": {
+    "prettier": {
       "optional": true
     }
   },

package/rules/react.js

@@ -38,8 +38,8 @@ export default defineConfig([
   ifAnyDep(
     'next',
     {
-      ...nextPlugin.flatConfig.recommended,
-      ...nextPlugin.flatConfig.coreWebVitals,
+      ...(nextPlugin?.flatConfig?.recommended || {}),
+      ...(nextPlugin?.flatConfig?.coreWebVitals || {}),
 
       name: 'codfish/next',
     },