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

https://github.com/mkloubert/eslint-config-marcel

Personal ESlint settings.
https://github.com/mkloubert/eslint-config-marcel

eslint eslint-config javascript js ts tsc tslint typescript

Last synced: about 1 month ago
JSON representation

Personal ESlint settings.

Awesome Lists containing this project

README

          

[![npm](https://img.shields.io/npm/v/eslint-config-marcel.svg)](https://www.npmjs.com/package/eslint-config-marcel)
[![last build](https://img.shields.io/github/workflow/status/mkloubert/eslint-config-marcel/Publish)](https://github.com/mkloubert/eslint-config-marcel/actions?query=workflow%3APublish)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/mkloubert/eslint-config-marcel/pulls)

# eslint-config-marcel

> Personal ESLint settings, which can be (used by anyone)[http://eslint.org/docs/developer-guide/shareable-configs.html].

## Installation

```
$ npm i -D eslint eslint-config-marcel
```

## Usage

Once the `eslint-config-marcel` package is installed, you can use it by specifying `marcel` in the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) section of your [ESLint configuration](http://eslint.org/docs/user-guide/configuring).

Create a `.eslintrc.js` file in the root folder of your project and use the following skeleton:

```js
module.exports = {
"extends": "marcel",
"rules": {
// Additional, per-project rules...
},
};
```

As optional feature, you can add script entry, called `lint` e.g., to your `package.json`:

```json
{
"scripts": {
"lint": "eslint -c .eslintrc.js --ext .ts ",
"lint:fix": "eslint --fix -c .eslintrc.js --ext .ts "
}
}
```

### Visual Studio Code

First install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for [Visual Studio Code](https://code.visualstudio.com/) by [Dirk Baeumer](https://marketplace.visualstudio.com/publishers/dbaeumer).

Then setup your `settings.json` inside your `.vscode` subfolder by adding the following entries:

```json
{
"editor.formatOnSave": true,
"editor.tabSize": 2,
"eslint.quiet": false,
"eslint.workingDirectories": [""],
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}
```

To keep sure, to have the extension installed, create a `extensions.json` file inside the same folder, if needed, and add the following entry as recommendation:

```json
{
"recommendations": ["dbaeumer.vscode-eslint"]
}
```

## License

MIT © [Marcel Joachim Kloubert](https://github.com/mkloubert)

## Support

PayPal donate button
Patreon donate button
Buy Me A Coffee donate button

Or visit https://marcel.coffee