search

getify / eslint-plugin-proper-arrows

ESLint rules to ensure proper arrow function definitions
MIT License
305 stars 14 forks source link

add config preset(s) #18

Open getify opened 5 years ago

getify commented 5 years ago

Define one (or more) configs that make it easier to use this plugin out of the box.

Add a "configs" to the plugin definition: https://eslint.org/docs/developer-guide/working-with-plugins#configs-in-plugins

AlokTakshak commented 5 years ago

Hi kyle, I would like to contribute

getify commented 5 years ago

The way to contribute on this particular issue is to help collect information on what particular arrangement of config settings would be good as a preset default.

There's one config preset already, which is my own personal opinion on config, and can be seen here: https://github.com/getify/eslint-plugin-proper-arrows/blob/master/lib/index.js#L5-L14

I'd like for example have config presets that match (as closely as possible) the style guides of big projects like AirBnB, React, etc. But I don't know what those configs would need to be, so that needs to be researched and figured out.

Ideally, a preset could be discussed (in its own thread) and once we're all agreed on what it should consist of, then a simple PR would add it alongside the existing "getify-says" one.

AlokTakshak commented 5 years ago

so we have to find a proper name for config instead of 'getify-says' according to style guide of AirBnB, React, etc?

getify commented 5 years ago

We'll have multiple presets... One will be "getify-says", but then yes we'll name the other presets according to their purpose or intended environment.

AlokTakshak commented 5 years ago

@getify I have gone through some different plugins, the most common are:

  1. recommended (it only changes in major version update) 2.all
  2. strongly-recommended
  3. base
  4. recommended-with-html(in case of differnet environment)
  5. best-practices

I have one more question , as currently we have only one config-'getify-says', are we planning to add more configs for differnet environment and usecases?