@drazenbebic/eslint-config-next 1.0.0 → 1.0.1

package/README.md

@@ -2,52 +2,21 @@
 
 > Opinionated, shareable [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for personal Next.js projects.
 
-It composes the official [`eslint-config-next`](https://www.npmjs.com/package/eslint-config-next) (Core Web Vitals + TypeScript) with Prettier, import sorting, unused-import removal, and [`perfectionist`](https://perfectionist.dev/) sorting — so a new Next.js app gets a consistent, batteries-included lint setup from a single dependency.
+Composes the official [`eslint-config-next`](https://www.npmjs.com/package/eslint-config-next) (Core Web Vitals + TypeScript) with Prettier, import sorting, unused-import removal, and [`perfectionist`](https://perfectionist.dev/) — a batteries-included setup from a single dependency.
 
-> **Heads up:** this is a personal config tuned to my own preferences. You're welcome to use it, but it will change to suit my projects, not yours. Pin a version if that matters to you.
+> **Heads up:** a personal config tuned to my preferences. Use it if you like, but it changes to suit my projects — pin a version if that matters.
 
-## What's inside
-
-- **`eslint-config-next/core-web-vitals`** and **`eslint-config-next/typescript`** — the official Next.js rules.
-- **Prettier** via [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) (`prettier/prettier` runs as an ESLint rule, and conflicting stylistic rules are turned off by `eslint-config-prettier`).
-- **`simple-import-sort`** — deterministic import/export ordering grouped as: side-effects → React/Next/node builtins → third-party → `@/` alias → relative.
-- **`unused-imports`** — auto-removes unused imports and warns on unused vars.
-- **`perfectionist`** — alphabetical sorting of JSX props, named imports/exports, union/intersection types, arrays, and more.
-- A few hand-picked core rules: `no-console` (allowing `warn`/`error`), `curly: all`, and `padding-line-between-statements` (blank lines around `if`/`for`/`try`/`return`).
-- Default ignores: `.next/**`, `out/**`, `build/**`, `next-env.d.ts`.
-
-## Requirements
-
-- **Node.js** `>= 20`
-- **ESLint** `^9 || ^10` (flat config only — there is no `.eslintrc` support)
-- **Next.js** (`next`) `>= 15` — already in your app; required because this config extends `eslint-config-next`, whose parser loads from `next`
-- **Prettier** `^3`
-- **TypeScript** `>= 5` (optional, only if your project uses it)
-
-The ESLint plugins themselves ship as dependencies of this package, so you don't install them separately — only the peers above. In a real Next.js project `next` is already present, so you typically only add `eslint` and `prettier`.
-
-## Installation
+## Install
 
 ```bash
 pnpm add -D @drazenbebic/eslint-config-next eslint prettier
-# add typescript if your project uses it:
-pnpm add -D typescript
 ```
 
-<details>
-<summary>npm / yarn</summary>
-
-```bash
-npm install -D @drazenbebic/eslint-config-next eslint prettier typescript
-# or
-yarn add -D @drazenbebic/eslint-config-next eslint prettier typescript
-```
-
-</details>
+All ESLint plugins are bundled. Peers you provide: **ESLint** `^9 || ^10` and **Prettier** `^3`, plus **Next.js** `>= 15` and **TypeScript** `>= 5` — both already present in a typical Next.js + TS app. Requires Node `>= 20` and flat config (no `.eslintrc`).
 
 ## Usage
 
-Create an `eslint.config.mjs` (flat config) at the root of your project:
+Create `eslint.config.mjs` at your project root:
 
 ```js
 import config from '@drazenbebic/eslint-config-next';
@@ -55,11 +24,11 @@ import config from '@drazenbebic/eslint-config-next';
 export default config;
 ```
 
-That's it. The default export is a flat-config array, so you can spread it and add your own overrides on top.
+Formatting runs through ESLint (`prettier/prettier`), but the style stays yours — add your own `.prettierrc`.
 
-### Adding project-specific overrides
+### Overrides
 
-Because the config is a plain array, anything you add **after** the spread wins:
+The default export is a flat-config array, so anything you append wins:
 
 ```js
 import { globalIgnores } from 'eslint/config';
@@ -68,58 +37,21 @@ import config from '@drazenbebic/eslint-config-next';
 
 const eslintConfig = [
   ...config,
-
-  // Ignore generated files (e.g. Sanity TypeGen output).
-  globalIgnores(['sanity.types.ts']),
-
-  // Tweak or disable rules for your project.
-  {
-    rules: {
-      'no-console': 'off',
-    },
-  },
+  globalIgnores(['sanity.types.ts']), // e.g. Sanity TypeGen output
+  { rules: { 'no-console': 'off' } },
 ];
 
 export default eslintConfig;
 ```
 
-> **Note:** This config no longer ignores `sanity.types.ts` by default — add the `globalIgnores` line above in projects that use Sanity TypeGen.
-
-### Prettier
-
-`prettier/prettier` runs inside ESLint, so formatting issues show up as lint errors and are fixable with `eslint --fix`. Add your own `.prettierrc` to control formatting (this config does not impose a Prettier style on your project). A typical `package.json`:
-
-```json
-{
-  "scripts": {
-    "lint": "next lint",
-    "lint:fix": "eslint . --fix"
-  }
-}
-```
-
-### The `@/` import group
-
-The import-sort rules put imports matching `^@/` in their own group, which assumes you use the `@/*` path alias (the Next.js default). If you use a different alias, override `simple-import-sort/imports` in your project config.
-
-## Releasing (maintainer notes)
-
-This package uses [release-please](https://github.com/googleapis/release-please) with **Conventional Commits**. Versions, the changelog, and the GitHub release are derived from commit messages on `main`:
-
-- `feat: …` → minor bump
-- `fix: …` / `perf: …` → patch bump
-- `feat!: …` or a `BREAKING CHANGE:` footer → major bump (minor while pre-1.0)
-
-When release-please's "Version Packages" PR is merged, the `release-please` workflow publishes to npm with [provenance](https://docs.npmjs.com/generating-provenance-statements) using [npm trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC) — there is no long-lived `NPM_TOKEN` secret to manage.
-
-**One-time bootstrap** (because npm can only attach a trusted publisher to a package that already exists):
+## What's inside
 
-1. Publish once manually to claim the name and create the package:
-   ```bash
-   npm publish --access public
-   ```
-2. On npmjs.com → the package's **Settings → Trusted Publisher**, add this repo's GitHub Actions workflow (`.github/workflows/release-please.yml`).
-3. From then on, merging the release-please PR publishes hands-free via OIDC.
+- **`eslint-config-next`** — official Core Web Vitals + TypeScript rules.
+- **Prettier** (`eslint-plugin-prettier` + `eslint-config-prettier`) — formatting as a lint rule.
+- **`perfectionist`** — import grouping (side-effects → React/Next/Node → third-party → `@/` alias → relative, with `import type` intermixed by path) plus sorted JSX props, named imports/exports, types, and arrays.
+- **`unused-imports`** — removes unused imports, warns on unused vars.
+- Core rules: `no-console` (allows `warn`/`error`), `curly`, and blank lines around `if`/`for`/`try`/`return`.
+- Ignores `.next/`, `out/`, `build/`, `next-env.d.ts`.
 
 ## License
 

package/index.js

@@ -1,10 +1,9 @@
-import { defineConfig, globalIgnores } from 'eslint/config';
 import nextVitals from 'eslint-config-next/core-web-vitals';
 import nextTs from 'eslint-config-next/typescript';
 import pluginPerfectionist from 'eslint-plugin-perfectionist';
 import prettierRecommended from 'eslint-plugin-prettier/recommended';
-import simpleImportSort from 'eslint-plugin-simple-import-sort';
 import pluginUnusedImports from 'eslint-plugin-unused-imports';
+import { defineConfig, globalIgnores } from 'eslint/config';
 
 const PERFECTIONIST_DEFAULT_ARGS = {
   type: 'alphabetical',
@@ -26,7 +25,6 @@ const eslintConfig = defineConfig([
     plugins: {
       perfectionist: pluginPerfectionist,
       'unused-imports': pluginUnusedImports,
-      'simple-import-sort': simpleImportSort,
     },
     rules: {
       'prettier/prettier': 'error',
@@ -44,21 +42,28 @@ const eslintConfig = defineConfig([
         { blankLine: 'always', prev: 'try', next: '*' },
         { blankLine: 'always', prev: '*', next: 'return' },
       ],
-      'simple-import-sort/exports': 'error',
-      'simple-import-sort/imports': [
+      'perfectionist/sort-imports': [
         'error',
         {
+          ...PERFECTIONIST_DEFAULT_ARGS,
+          sortSideEffects: true,
+          customGroups: [
+            { groupName: 'side-effects', selector: 'side-effect' },
+            {
+              groupName: 'react-next-node',
+              elementNamePattern: ['^react', '^next', '^node:'],
+            },
+            { groupName: 'third-party', elementNamePattern: ['^@?\\w'] },
+            { groupName: 'internal', elementNamePattern: ['^@/'] },
+            { groupName: 'relative', elementNamePattern: ['^\\.'] },
+          ],
           groups: [
-            // 1. Side effect imports (e.g. import 'style.css')
-            ['^\\u0000'],
-            // 2. React, Next.js, and other node built-ins
-            ['^react', '^next', '^node:'],
-            // 3. Third-party packages (starting with a letter or @)
-            ['^@?\\w'],
-            // 4. Internal imports (using your @/ alias)
-            ['^@/'],
-            // 5. Relative imports (starting with .)
-            ['^\\.'],
+            'side-effects',
+            'react-next-node',
+            'third-party',
+            'internal',
+            'relative',
+            'unknown',
           ],
         },
       ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drazenbebic/eslint-config-next",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Opinionated, shareable ESLint flat config for personal Next.js projects (Next + TypeScript + Prettier + import sorting + perfectionist).",
   "keywords": [
     "eslint",
@@ -50,7 +50,6 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-perfectionist": "^5.9.1",
     "eslint-plugin-prettier": "^5.5.6",
-    "eslint-plugin-simple-import-sort": "^13.0.0",
     "eslint-plugin-unused-imports": "^4.4.1"
   },
   "peerDependencies": {