owowagency/eslint-config

OWOW Eslint Config

📖 Table of contents

1. Installation
2. Packages
3. Contributing
4. License
5. OWOW

⚙️ Installation

Installation of the basic ESLint config can be done by using npm or yarn, see packages for all our ESLint configurations

# npm
npm install @owowagency/eslint-config-basic

# yarn
yarn add @owowagency/eslint-config-basic

Add the following to your ESLint configuration file

export default {
    extends: [
        '@owowagency/eslint-config-basic',
    ],
};

📦 Packages

1. Basic
2. Cypress Basic
3. Cypress TS
4. React
5. TypeScript
6. Vue

🫶 Contributing

Please see CONTRIBUTING for details.

📜 License

The MIT License (MIT). Please see License File for more information.

This package has been brought to you with much love by the wizkids of OWOW. Do you like this package? We’re still looking for new talent and Wizkids. So do you want to contribute to open source, while getting paid? Apply now.

eslint-config's Issues

Supporting prettier

I did a first attempt to add prettier support to this config; there are some decisions to be made so let's discuss.

About prettier

First of all. If we want to support Prettier, we should be aware that prettier is very opinionated. This has pro's and cons. I personally prefer Prettier because of the simple fact that it makes me more productive and efficient -- since I spend no time on manually formatting my code. Though, some people dislike the opinionated nature of Prettier.

Committing to Prettier will most prominently mean that we will use ESLint for code quality, and Prettier for formatting.

Before we start working on this

We need to decide on some things:

• Should we commit to Prettier?
• Should we incorporate Prettier into @owowagency/eslint-config?
• Should we create a separate Prettier config package e.g. @owowagency/prettier-config?
• Should we simply add instructions to the readme on how to add Prettier?

Incorporating Prettier and ESLint

When using Prettier: Prettier is for formatting, ESLint is for code quality.

If we want to support prettier in this package, there are some formatting rules that need to be omitted/removed from ESLint configs:

• array-bracket-spacing
• arrow-parens
• block-spacing
• brace-style
• comma-dangle
• comma-spacing
• comma-style
• indent
• key-spacing
• no-multi-spaces
• object-curly-spacing
• operator-linebreak
• quote-props
• semi
• space-before-function-paren
• template-curly-spacing
• unicorn/number-literal-case
• quotes

All of these are formatting rules -- therefor handled by Prettier, thus it is better to remove these rules from ESLint config.

Feature branch https://github.com/owowagency/eslint-config/tree/feature/prettier.