Skip to content
This repository has been archived by the owner on Oct 6, 2024. It is now read-only.

sebalaini/sebalaini-lints-config

Repository files navigation

GitHub release License issues - sebalaini-lints-config


sebalaini-lints-config

Shared lint configuration package with various base configurations which can be extended by your project's eslint, stylelint & prettier configuration

What this package is

This package is a complete lint configuration including eslint, stylelint & prettier. These are the base configurations for linting your code.


Installation

Simply install the package by running:

yarn add -D @sebalaini/sebalaini-lints-config

alternatively you can use npm or your preferred package manager.


Usage

By default, the package exports the Eslint eslint-config-next configuration, extend these in your project's configuration file as needed.

Eslint

The Eslint configuration exported by default includes eslint-config-next prettier & tailwindcss.

Add the below code to your .eslintrc.js file.

extends: ['@sebalaini/sebalaini-lints-config'],

or

extends: ['@sebalaini/sebalaini-lints-config/next'],

This config includes specific Next.js & TypeScript rules.


Stylelint

Add the below code to your .stylelintrc.js file.

extends: ['@sebalaini/sebalaini-lints-config/stylelintrc'],

Prettier

Add the below code to your .prettierrc.js file.

module.exports = {
  ...require('@sebalaini/sebalaini-lints-config/prettierrc'),
}

License

Released under MIT by @sebalaini.


Create a release

Run yarn changeset to add a new release.