@notcodev/eslint 1.3.0

package/README.md

@@ -0,0 +1,3 @@
+# 🐈‍⬛ ESLint Configs
+
+This package contains ESLint confuguration

package/index.d.ts

@@ -0,0 +1,69 @@
+import type { OptionsConfig, TypedFlatConfigItem } from '@antfu/eslint-config'
+import type { ConfigNames } from '@antfu/eslint-config'
+import type { OptionsOverrides } from '@antfu/eslint-config'
+import type { FlatConfigComposer } from 'eslint-flat-config-utils'
+
+declare module '@notcodev/eslint' {
+  export type EslintOptions = Omit<OptionsConfig, 'lessOpinionated' | 'react' | 'stylistic'> &
+    TypedFlatConfigItem & {
+      /**
+       * Enable react rules.
+       *
+       * @see https://eslint-react.xyz
+       * @default false
+       */
+      react?: boolean | OptionsOverrides
+
+      /**
+       * Enable stylistic rules.
+       *
+       * @see https://eslint.style/
+       * @default false
+       */
+      stylistic?: boolean
+
+      /**
+       * Enable a11y rules on JSX elements.
+       *
+       * @default false
+       */
+      jsxA11y?: boolean
+
+      /**
+       * Enable Next.js rules.
+       *
+       * @see https://nextjs.org/docs/app/api-reference/config/eslint
+       * @default false
+       */
+      next?: boolean
+
+      /**
+       * Enable prettier rules.
+       *
+       * @default true
+       */
+      prettier?: boolean
+
+      /**
+       * Enable rules for TanStack Query.
+       *
+       * @see https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query
+       * @default false
+       */
+      tanstackQuery?: boolean
+
+      /**
+       * Enable rules for TanStack Router.
+       *
+       * @see https://tanstack.com/router/latest/docs/eslint/eslint-plugin-router
+       * @default false
+       */
+      tanstackRouter?: boolean
+    }
+
+  export type Eslint = (
+    options?: EslintOptions,
+  ) => FlatConfigComposer<TypedFlatConfigItem, ConfigNames>
+
+  export const eslint: Eslint
+}

package/index.js

@@ -0,0 +1,200 @@
+import antfu from '@antfu/eslint-config'
+import pluginNext from '@next/eslint-plugin-next'
+import pluginTanstackQuery from '@tanstack/eslint-plugin-query'
+import pluginTanstackRouter from '@tanstack/eslint-plugin-router'
+import pluginJsxA11y from 'eslint-plugin-jsx-a11y'
+import pluginPrettier from 'eslint-plugin-prettier'
+
+/** @type {import('@notcodev/eslint').Eslint} */
+export function eslint({
+  jsxA11y,
+  stylistic = false,
+  next,
+  prettier = true,
+  tanstackRouter,
+  tanstackQuery,
+  ...options
+}) {
+  const configs = []
+
+  if (prettier) {
+    configs.push({
+      name: 'notcodev/prettier/setup',
+      plugins: { prettier: pluginPrettier },
+    })
+
+    configs.push({
+      name: 'notcodev/prettier/rules',
+      rules: {
+        'prettier/prettier': 'warn',
+      },
+    })
+  }
+
+  if (stylistic) {
+    configs.push({
+      name: 'notcodev/stylistic',
+      rules: {
+        'style/arrow-parens': ['error', 'always'],
+        'style/brace-style': 'off',
+        'style/comma-dangle': ['error', 'never'],
+        'style/indent': ['error', 2, { SwitchCase: 1 }],
+        'style/jsx-curly-newline': 'off',
+        'style/jsx-one-expression-per-line': 'off',
+        'style/jsx-quotes': ['error', 'prefer-single'],
+        'style/linebreak-style': ['error', 'unix'],
+        'style/max-len': [
+          'error',
+          100,
+          2,
+          { ignoreComments: true, ignoreStrings: true, ignoreTemplateLiterals: true },
+        ],
+        'style/member-delimiter-style': 'off',
+        'style/multiline-ternary': 'off',
+        'style/no-tabs': 'error',
+        'style/operator-linebreak': 'off',
+        'style/quote-props': 'off',
+        'style/quotes': ['error', 'single', { allowTemplateLiterals: true }],
+      },
+    })
+  }
+
+  configs.push({
+    name: 'notcodev/unicorn/rules',
+    rules: {
+      'unicorn/filename-case': ['error', { case: 'kebabCase', ignore: ['^.*\.(vue|md)$'] }],
+    },
+  })
+
+  configs.push({
+    name: 'notcodev/imports/rules',
+    rules: {
+      'import/no-default-export': next ? 'off' : 'warn',
+    },
+  })
+
+  configs.push({
+    name: 'notcodev/perfectionist/rules',
+    rules: {
+      'perfectionist/sort-array-includes': ['error', { order: 'asc', type: 'alphabetical' }],
+      'perfectionist/sort-imports': [
+        'error',
+        {
+          groups: [
+            'type',
+            ['builtin', 'external'],
+            'internal-type',
+            ['internal'],
+            ['parent-type', 'sibling-type', 'index-type'],
+            ['parent', 'sibling', 'index'],
+            'object',
+            'style',
+            'side-effect-style',
+            'unknown',
+          ],
+          internalPattern: ['^~/.*', '^@/.*'],
+          newlinesBetween: 'always',
+          order: 'asc',
+          type: 'natural',
+        },
+      ],
+      'perfectionist/sort-interfaces': [
+        'error',
+        { groups: ['unknown', 'method', 'multiline'], order: 'asc', type: 'alphabetical' },
+      ],
+      'perfectionist/sort-jsx-props': [
+        'error',
+        {
+          customGroups: { callback: 'on*', reserved: ['key', 'ref'] },
+          groups: ['reserved', 'multiline', 'unknown', 'callback', 'shorthand'],
+          order: 'asc',
+          type: 'alphabetical',
+        },
+      ],
+      'perfectionist/sort-union-types': [
+        'error',
+        {
+          groups: [
+            'conditional',
+            'function',
+            'import',
+            'intersection',
+            'keyword',
+            'literal',
+            'named',
+            'object',
+            'operator',
+            'tuple',
+            'union',
+            'nullish',
+          ],
+          order: 'asc',
+          specialCharacters: 'keep',
+          type: 'alphabetical',
+        },
+      ],
+    },
+  })
+
+  if (options.react) {
+    configs.push({
+      name: 'notcodev/react/rules',
+      rules: {
+        'react/jsx-no-undef': 'error',
+        'react/prefer-destructuring-assignment': 'warn',
+        'react/no-useless-fragment': 'warn',
+        'react/prefer-shorthand-boolean': 'warn',
+      },
+    })
+  }
+
+  if (next) {
+    configs.push({
+      name: 'notcodev/next/setup',
+      plugins: { '@next/next': pluginNext },
+    })
+
+    configs.push({
+      name: 'notcodev/next/rules',
+      rules: pluginNext.configs.recommended.rules,
+    })
+  }
+
+  if (jsxA11y) {
+    configs.push({
+      name: 'notcodev/jsx-a11y/setup',
+      plugins: { 'jsx-a11y': pluginJsxA11y },
+    })
+
+    configs.push({
+      name: 'notcodev/jsx-a11y/rules',
+      rules: pluginJsxA11y.configs.recommended.rules,
+    })
+  }
+
+  if (tanstackQuery) {
+    configs.push({
+      name: 'notcodev/tanstack-query/setup',
+      plugins: { '@tanstack/query': pluginTanstackQuery },
+    })
+
+    configs.push({
+      name: 'notcodev/tanstack-query/rules',
+      rules: pluginTanstackQuery.configs.recommended.rules,
+    })
+  }
+
+  if (tanstackRouter) {
+    configs.push({
+      name: 'notcodev/tanstack-router/setup',
+      plugins: { '@tanstack/router': pluginTanstackRouter },
+    })
+
+    configs.push({
+      name: 'notcodev/tanstack-router/rules',
+      rules: pluginTanstackRouter.configs.recommended.rules,
+    })
+  }
+
+  return antfu({ ...options, stylistic, lessOpinionated: true }, configs)
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@notcodev/eslint",
+  "type": "module",
+  "version": "1.3.0",
+  "private": false,
+  "description": "ESLint Configs",
+  "author": {
+    "name": "Erik Codev",
+    "url": "https://github.com/notcodev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/notcodev/core",
+  "repository": {
+    "url": "https://github.com/notcodev/core"
+  },
+  "bugs": {
+    "url": "https://github.com/notcodev/core/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "eslint",
+    "react",
+    "node"
+  ],
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
+  "engines": {
+    "node": ">=22.9.0"
+  },
+  "peerDependencies": {
+    "eslint": "~9.22.0"
+  },
+  "dependencies": {
+    "@antfu/eslint-config": "~4.13.2",
+    "@eslint-react/eslint-plugin": "~1.38.4",
+    "@next/eslint-plugin-next": "~15.3.3",
+    "@tanstack/eslint-plugin-query": "^5.81.2",
+    "@tanstack/eslint-plugin-router": "^1.121.21",
+    "eslint": "~9.22.0",
+    "eslint-config-prettier": "~10.1.5",
+    "eslint-flat-config-utils": "~2.1.0",
+    "eslint-plugin-jsx-a11y": "~6.10.2",
+    "eslint-plugin-prettier": "~5.4.1",
+    "eslint-plugin-react-hooks": "~5.2.0",
+    "eslint-plugin-react-refresh": "~0.4.19"
+  },
+  "devDependencies": {
+    "@types/eslint-plugin-jsx-a11y": "^6.10.0",
+    "prettier": "^3.5.3",
+    "@notcodev/prettier": "1.1.0"
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,cjs,mjs,cts,mts}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "scripts": {
+    "format": "prettier --write \"*.js\"",
+    "lint": "eslint . --fix",
+    "lint-inspector": "npx @eslint/config-inspector"
+  }
+}