Add support for eslint-plugin-redux-saga

[amercier]

Description

This PR adds support for eslint-plugin-redux-saga.

Note: eslint-plugin-redux-saga supports the https://github.com/USERNAME/eslint-plugin-PLUGINNAME/blob/master/docs/rules/RULENAME.md convention.

Ex: redux-saga/no-yield-in-race.

PR

• Read contributing guidelines.
• Added support for eslint-plugin-redux-saga
• CCed plugin author

[amercier]

/cc @pke This PR unlocks documentation support for eslint-plugin-redux-saga in multiple places, including Atom's Linter (through linter-eslint). I hope you're ok with that :)

Example in Atom. After this PR is merged and plugin updated, the 🔗 link will point to the corresponding .md file in your repo.

[pke]

👍 absolutely @amercier, thanks for the info.
Thats what open source is all about! Building on top of each others contributions.
If there is anything I can do to help improving the docs, give me a hint.

I wonder however where the text from your screenshot is derived from?

[amercier]

Thanks! Do you mean, the A saga must [...] (use try/catch) error message? It's coming through ESLint from your plugin itself, I suppose: https://github.com/pke/eslint-plugin-redux-saga/blob/develop/lib/rules/no-unhandled-errors.js#L58

[pke]

Yes, I thought it extracts it from the documentation somehow.

[amercier]

Yep, errors are extracted from ESLint output and processed here: https://github.com/AtomLinter/linter-eslint/blob/master/src/helpers.js#L240-L334

[Arcanemagus]

Please note that this package is only a legacy workaround for this functionality. The correct way to specify documentation is to specify the meta.docs.url property as shown in the documentation for rules.

linter-eslint at least supports both methods of specifying the documentation location, but ideally you should be using the official method!

[Arcanemagus]

Although this is a legacy workaround, there's nothing against merging this 😉.

[amercier]

@Arcanemagus Thanks for merging and the explanation! Good to know :)