Patched Rulesets

Collection of eslint configs for various plugins. There are automatically loaded by [Patched Linter & Formatter][1].

Installation

``bash
yarn add patched-rulesets
`

*

#### createConfig

Returns a complete eslint configuration object that contains rules for the plugins of
each specified plugin group.

`javascript
const { createConfig, getPlugins } = require("patched-rulesets")

const jsConfig = createConfig({
pluginNames: getPlugins(["react"]),
})

module.exports = {
overrides: [
{
files: [".js", ".jsx"],
...jsConfig,
}
],
}
`

---

#### getRuleSet

Returns the rules, patches, and options for the specified plugin. This is used
internally by createConfig, but exposed in case some extra manual adjustments are
necessary.

`javascript
const { getRuleSet } = require("patched-rulesets")

const reactRuleSet = getRuleSet("react")
// { rules: {...}, patches: {...}, options: {...} }

module.exports = {
// ...
...reactRuleSet.options,
rules: {
...reactRuleSet.patches.eslint,
...reactRuleSet.rules,
},
}
`

---

#### groups

Returns an object of groups, with each containing an array of plugin names.

Name | Plugins included
--- | ---
core | eslint-comments, node, sort-requires, , sort-destructure-keys, no-loops
coreES6 | import, simple-import-sort, unused-imports, promise, unicorn
react | react, react-hooks
reactES6 | better-styled-components
redux | react-redux, redux-saga
typescript | @typescript-eslint, tsdoc
safety | security
prose | markdown, spellcheck
json | json
jsonPackage | package-json

---

#### getPlugins

Converts the provided array of group names into the actual list of plugin names.

`javascript
const { getPlugins } = require("patched-rulesets")

const plugins = getPlugins(["react"])
// -> ["react", "react-hooks"]
`

---

#### configs

A collection of preset configurations that are generated from the methods above. While this only provides the rules, it may be useful if someone is manually piecing together
ther own eslint config.

Name | Plugin groups used
--- | ---
nodeOnly | none
js | core
jsReact | core, react
jsReactRedux | core, react, redux
ts | core, typescript
tsReact | core, typescript, react
tsReactRedux | core, typescript, react, redux
mdJs | core, prose
mdJsReact | core, prose, react
mdJsReactRedux | core, prose, react, redux
mdTs | core, prose, typescript
mdTsReact | core, prose, react, typescript
mdTsReactRedux | core, prose, react, redux, typescript
json | json
jsonPackage | jsonPackage

`javascript
const { configs } = require("patched-rulesets")

module.exports = {
overrides: [
{
files: [".js", ".jsx"],
...configs.js,
},
],
}
``

[1]: https://github.com/alexseitsinger/patched