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

Eslint and prettier config for awesome tools
https://github.com/basantech89/eslint-config

Last synced: about 1 month ago
JSON representation

Eslint and prettier config for awesome tools

• Host: GitHub
• URL: https://github.com/basantech89/eslint-config
• Owner: basantech89
• Created: 2022-01-02T11:34:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-27T15:37:15.000Z (almost 3 years ago)
• Last Synced: 2024-03-14T18:36:14.097Z (10 months ago)
• Language: JavaScript
• Size: 41 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# @awesome-tools/eslint-config

# Eslint config for my personal projects. Feel free to use this package

[![CI](https://github.com/basantech89/eslint-config/actions/workflows/main.yml/badge.svg)](https://github.com/basantech89/eslint-config/actions/workflows/main.yml)

[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![Code of Conduct](https://img.shields.io/badge/code-of%20conduct-green.svg)](https://publiclab.org/conduct)

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

  - [Things to know](#Things-to-know)

- [Issues](#issues)

  - [🐛 Bugs](#-bugs)

  - [💡 Feature Requests](#-feature-requests)

- [LICENSE](#license)

## Installation

This module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and

should be installed as one of your project's `devDependencies`:

```

npm install --save-dev @awesome-tools/eslint-config

```

## Usage

Then add the extends to your `.eslintrc.js`:

```javascript

module.exports = {

  extends: '@awesome-tools/eslint-config',

  rules: {

    // your overrides

  },

}

```

You can import prettier config as well

```javascript

const base = require('eslint-config-storybook/prettier.config')

module.exports = {

  ...base,

  arrowParens: 'avoid',

  overrides: [

      // your overrides

  ]

}

```

### Things to know

- All plugins needed for rules used by these configs are dependencies of this

  module so you don't have to install anything on your own.

- The default config actually is composed of several configurations, and you can

  use those individually. You can use each of these configs yourself if you want

  to leave my own personal style out of it.

## Issues

_Looking to contribute? Look for the [Good First Issue](https://github.com/basantech89/eslint-config/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

label._ 😀

### 🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[**See Bugs**](https://github.com/basantech89/eslint-config/issues)

### 💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding

a 👍. This helps maintainers prioritize what to work on.

## LICENSE

ISC