Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/indielayer/eslint-config

Indielayer ESLint Config
https://github.com/indielayer/eslint-config

eslint eslint-config eslint-rules eslintconfig indielayer javascript nuxt typescript vue vue3

Last synced: 9 days ago
JSON representation

Indielayer ESLint Config

Awesome Lists containing this project

README

        

![IndielayerUI-Logo-Dark](.github/logo_dark.svg#gh-dark-mode-only)
![IndielayerUI-Logo-Light](.github/logo.svg#gh-light-mode-only)

> < Tools for creators. />

# Indielayer ESLint Config


ci
Downloads
Version
License

ESlint config by Indielayer

## Getting Started

Do you want to add the config to your own projects? There you go:

1. Add to your devDependencies

```bash
$ npm i -D @indielayer/eslint-config eslint
# or
$ yarn add -D @indielayer/eslint-config eslint
```

2. Create a `.eslintrc` file

3. Extend our config (you can use just the scope name as ESLint will assume the `eslint-config` suffix):

```json
{
"extends": [
"@indielayer"
]
}
```

## Full example

A full example `.eslintrc`:

```json
{
"root": true,
"extends": [
"@indielayer"
]
}
```

## Vue 3

If you're using Vue 3, follow [Getting Started](#getting-started) section by replacing `@indielayer/eslint-config` by `@indielayer/eslint-config-vue`.

And in your `.eslintrc` all you need is :

```json
{
"extends": [
"@indielayer/eslint-config-vue"
]
}
```

## Stylelint

1. Add this package to your devDependencies

```bash
$ npm i -D stylelint @indielayer/stylelint-config
# or
$ yarn add -D stylelint @indielayer/stylelint-config
```

2. Create a `.stylelintrc.js` file

3. Extend our config:

```js
module.exports = {
root: true,
extends: ['@indielayer/stylelint-config'],
}
```

## License

[MIT license](https://github.com/indielayer/eslint-config/blob/master/LICENSE) - Indielayer