https://github.com/sebalaini/sebalaini-lints-config

Custom lint config
https://github.com/sebalaini/sebalaini-lints-config

eslint nextjs prettier stylelint tailwindcss typescript

Last synced: 1 day ago
JSON representation

Custom lint config

• Host: GitHub
• URL: https://github.com/sebalaini/sebalaini-lints-config
• Owner: sebalaini
• License: mit
• Created: 2023-07-30T17:38:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-13T20:53:50.000Z (4 months ago)
• Last Synced: 2024-09-15T09:46:08.201Z (3 months ago)
• Topics: eslint, nextjs, prettier, stylelint, tailwindcss, typescript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@sebalaini/sebalaini-lints-config
• Size: 5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub release](https://img.shields.io/github/release/sebalaini/sebalaini-lints-config?include_prereleases=&sort=semver&color=blue)](https://github.com/sebalaini/sebalaini-lints-config/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![issues - sebalaini-lints-config](https://img.shields.io/github/issues/sebalaini/sebalaini-lints-config)](https://github.com/sebalaini/sebalaini-lints-config/issues)

---

# 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:

```bash

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.

```js

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

```

or 

```js

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

```

This config includes specific Next.js & TypeScript rules.




### Stylelint

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

```js

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

```




### Prettier

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

```js

module.exports = {

  ...require('@sebalaini/sebalaini-lints-config/prettierrc'),

}

```

--- 

## License

Released under [MIT](/LICENSE) by [@sebalaini](https://github.com/sebalaini).

---

# Create a release

Run `yarn changeset` to add a new release.