Please sign in to comment.
Add a link to rule documentation
Changes the (ruleID) to a link to the documentation for core rules, and adds some pages to link to for plugin rules describing how to add them.
- Loading branch information...
Showing with 94 additions and 15 deletions.
|@@ -0,0 +1,21 @@|
|+# What happened|
|+You arrived here after clicking on a stylelint plugin's rule name from a|
|+linting error message.|
|+Normally, clicking on a stylelint rule name in an error message takes you|
|+to the [stylelint.io](http://stylelint.io/user-guide/rules/) or plugin's page|
|+for that rule, so you can learn more about it. Unfortunately the plugin that|
|+implements the rule you clicked on is not in the current list of plugins known|
|+to the `linter-stylelint` package, so there is no way of knowing how to|
|+automatically link to the rule's documentation.|
|+## How you can help|
|+Would you mind submitting a PR to add a mapping for the plugin you're using that|
|+redirected you here? That way you, and everyone else using that plugin with|
|+`linter-stylelint`, will be able to click the name and get to the documentation|
|+To do so simply add a new case to the `switch` statement in the|
|+`generateHTMLMessage()` function, and send in your PR!|
|@@ -0,0 +1,13 @@|
|+# No Namespace Rules|
|+Unfortunately the rule you have clicked on comes from a plugin, but that|
|+plugin used the generic namespace of `plugin` instead of creating their own.|
|+This means that it is impossible to determine a URL to link to the definition|
|+of the rule.|
|+You can try filing an issue on the repository of the rule if you know where it|
|+came from asking them to use a namespace. If that happens then the new|
|+namespace can be added to the list of known plugins by following the|