Broken rule documentation links

[jaydenseric]

Error tooltip rule documentation links in tools like Atom linter-eslint are broken.

For example, https://github.com/xjamundx/eslint-plugin-promise#catch-or-return should be https://github.com/xjamundx/eslint-plugin-promise#rule-catch-or-return.

[macklinu]

Looking into this, it seems like Atom's linter-eslint package tries to determine a rule URL if one does not exist - check out this code.

One area of improvement for each rule in this plugin would be to refactor to include the meta.docs.url field.

For example, the catch-or-return rule would go from looking like this:

module.exports = {
  create: function (context) {
    // ...snippet
  }
}

To this:

module.exports = {
  meta: {
    docs: {
      url: 'https://github.com/xjamundx/eslint-plugin-promise#rule-catch-or-return'
    }
  },
  create: function (context) {
    // ...snippet
  }
}

I am sure PRs are welcome for this contribution - can probably take a look this week, but feel free to comment if you'd like to contribute this, @jaydenseric. 🙂

[macklinu]

This wasn't resolved in #86 - mistyped in that PR description. Will resolve this issue in another PR.