1.0.0-rc.0 • Published 1 year ago

@rainstormy/presets-eslint-next v1.0.0-rc.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Next.js Preset for ESLint

This package provides a predefined, opinionated ESLint configuration suitable for any Next.js app.

This preset configures a subset of rules from the following plugin, which is installed along with the preset package:

Additionally, it includes the following presets:

Installation

Install the @rainstormy/presets-eslint-next package and its peer dependencies:

npm install --save-dev @rainstormy/presets-eslint-next @rainstormy/presets-eslint eslint typescript
pnpm install --save-dev @rainstormy/presets-eslint-next @rainstormy/presets-eslint eslint typescript
yarn add --dev @rainstormy/presets-eslint-next @rainstormy/presets-eslint eslint typescript

Usage

Create or extend a flat ESLint configuration file (eslint.config.js) and apply the eslintPresetNext preset.

For example (with the default options in comments):

import { eslintPresets } from "@rainstormy/presets-eslint"
import { eslintPresetNext } from "@rainstormy/presets-eslint-next"

export default eslintPresets({
	additionalPresets: [
		// ...other presets...
		eslintPresetNext({
			// targetFilePatterns: ["**/*.@(jsx|tsx)"],
		}),
	],
})

In Combination with Storybook, Tailwind CSS, and Testing Library

For example (with the default options applied):

import {
	eslintPresetAmbientTypeScriptModules,
	eslintPresetTestData,
	eslintPresets,
} from "@rainstormy/presets-eslint"
import { eslintPresetNext } from "@rainstormy/presets-eslint-next"
import { eslintPresetStorybook } from "@rainstormy/presets-eslint-storybook"
import { eslintPresetTailwind } from "@rainstormy/presets-eslint-tailwind"
import { eslintPresetTestingLibrary } from "@rainstormy/presets-eslint-testing-library"
import { eslintPresetVitest } from "@rainstormy/presets-eslint-vitest"

export default eslintPresets({
	additionalPresets: [
		eslintPresetAmbientTypeScriptModules(),
		eslintPresetNext(),
		eslintPresetStorybook(),
		eslintPresetTailwind(),
		eslintPresetTestData(),
		eslintPresetTestingLibrary(),
		eslintPresetVitest(),
	],
})