Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/brandonkal/eslint-config-gatsby-standard

Yet Another ESLint Config. This one installs rules required to use standardJS with Gatsby
https://github.com/brandonkal/eslint-config-gatsby-standard

eslint eslint-config eslint-rules eslint-shareable-configs gatsby standardjs

Last synced: 26 days ago
JSON representation

Yet Another ESLint Config. This one installs rules required to use standardJS with Gatsby

Host: GitHub
URL: https://github.com/brandonkal/eslint-config-gatsby-standard
Owner: brandonkal
License: mit
Created: 2018-05-04T23:24:41.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-03-15T02:01:10.000Z (8 months ago)
Last Synced: 2024-04-18T09:31:47.918Z (7 months ago)
Topics: eslint, eslint-config, eslint-rules, eslint-shareable-configs, gatsby, standardjs
Homepage: https://git.io/gatsby-standard
Size: 30.3 KB
Stars: 13
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Gatsby Standard - ESLint Config

Easily Lint your Gatsby site projects for StandardJS.

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![npm](https://img.shields.io/npm/v/eslint-config-gatsby-standard.svg)](https://www.npmjs.com/package/eslint-config-gatsby-standard)
[![npm](https://img.shields.io/npm/dt/eslint-config-gatsby-standard.svg)](https://www.npmjs.com/package/eslint-config-gatsby-standard)

ESLint rule configuration for Gatsby Sites. This rule set is designed to closely match the Gatsby Starters while still following StandardJS. Simply install and extend to clean up your GatsbyJS code! The plugins and parser used are dependencies of this project. No need to specify them separately in your project.

This config is designed to be used in conjunction with prettier for automatic code formatting. Conflicting rules have been disabled through `eslint-config-prettier`. See the "Use With Atom" section below for a suggestion on how to implement this config with prettier for automatic linting and formatting.

`@babel/eslint-parser` is included to support new JavaScript features used in advanced Gatsby projects.

## Usage

Install the configs by running:

```sh
npm install --save-dev eslint eslint-config-gatsby-standard
```

Then simply create a `.eslintrc.json` at your project root:

```json
{
"extends": "gatsby-standard"
}
```

Be sure you also have an `.eslintignore` file in your project root so you won't receive unnecessary lint errors from Gatsby:

```
public
static
.cache
content
```

## Plugins Used:

- [@babel/eslint-plugin](https://github.com/babel/babel/tree/main/eslint/babel-eslint-plugin)
- [eslint-config-standard](https://www.npmjs.com/package/eslint-config-standard)
- [eslint-plugin-standard](https://www.npmjs.com/package/eslint-plugin-standard)
- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)
- [eslint-config-standard-react](https://www.npmjs.com/package/eslint-config-standard-react)
- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
- [eslint-plugin-node](https://www.npmjs.com/package/eslint-plugin-node)
- [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise)
- [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier)

## Use With Atom

To use with prettier just add the `.prettierrc.json` config file to the root of the project:

```json
{
"semi": false,
"singleQuote": true,
"trailingComma": "es5"
}
```

If you use Atom, you can install linter-eslint to view the results of Gatsby Standard immediately.

```
apm install linter-eslint
```

Disable "Fix errors on save" and install prettier-atom:

```
apm install prettier-atom
```

Choose "ESLint Integration" in the package settings. This will use a global install of prettier-eslint but it will still follow the Gatsby Standard linting rules.

Be sure to check "Run Prettier Last" and optionally "Format Files on Save" and "Show in Status Bar." Most other code editors have similar packages to format on demand.

## License