ilib-lint 1.1.0 → 1.2.0

package/README.md

@@ -248,11 +248,12 @@ Here is an example of a configuration file:
     "rules": [
         // test that named parameters like {param} appear in both the source and target
         {
-            "type": "resource-matcher",
             "name": "resource-named-params",
+            "type": "resource-matcher",
             "description": "Ensure that named parameters that appear in the source string are also used in the translated string",
             "note": "The named parameter '{matchString}' from the source string does not appear in the target string",
-            "regexps": [ "\\{\\w+\\}" ]
+            "regexps": [ "\\{\\w+\\}" ],
+            "link": "https://github.com/ilib-js/i18nlint/blob/main/README.md"
         }
     ],
     "formatters": [
@@ -459,6 +460,11 @@ Each declarative rule should have the following properties:
   in the source and target strings. If any one of those expressions
   matches in the source, but not the target, the rule will create
   a Result that will be formatted for the user.
+* link (String) - an URL to a website with a more complete explanation
+  of the problem that was found and how the problem can be resolved
+  and avoided in the future. Often, this is a link to a markdown file
+  in the docs folder on the github repo for the plugin, but it can be
+  any link you like.
 
 Programmatic rules are used when the requirements for the rules are more complicated
 than a simple regular expression string can handle. For example, a rule that checks
@@ -509,6 +515,22 @@ Declarative formatters are simply a template string where properties of the Resu
 instances are formatted into it. These can be declared in the config file. (See the
 example config file above.)
 
+The template strings may have any of the following fields from the Result instance
+in them:
+
+- severity
+- pathName
+- lineNumber
+- source
+- highlight
+- id
+
+Additionally, they may have the following fields from the Rule instance in them:
+
+- ruleDescription
+- ruleName
+- ruleLink
+
 Programmatic formatters are used when the requirements for formatting are more complicated
 than a simple template string can handle. For example, a CSV formatter would have to make
 sure that fields in a CSV file are escaped properly to conform to CSV syntax, and would
@@ -521,6 +543,8 @@ The constructor of this class should define the following properties:
 
 - `this.name` - a unique name for this formatter
 - `this.description` - a description of this type of formatter to display to users
+- `this.link` - (optional) a link to a web page that gives a more complete explanation
+  the the rule and how to resolve the problem it found
 
 The formatter should also override and implement the
 [format()](https://github.com/iLib-js/i18nlint-common/blob/main/src/Formatter.js) method,
@@ -563,6 +587,11 @@ limitations under the License.
 
 ## Release Notes
 
+### v1.2.0
+
+- added Rule links to give rule writers a way of giving a more complete explanation
+  of the rule and how to resolve the problem.
+
 ### v1.1.0
 
 - added support for plugins

package/docs/AnsiConsoleFormatter.html

@@ -348,7 +348,7 @@ formatted string.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ConfigBasedFormatter.html

@@ -355,7 +355,7 @@ formatted string.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/DirItem.html

@@ -705,7 +705,7 @@ The options parameter can contain any of the following properties:
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/DirItem.js.html

@@ -149,7 +149,7 @@ export default DirItem;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FileType.html

@@ -480,7 +480,7 @@ all of the ruleset definitions
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FileType.js.html

@@ -202,7 +202,7 @@ export default FileType;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FormatterManager.html

@@ -731,7 +731,7 @@ values are the formatter descriptions.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FormatterManager.js.html

@@ -182,7 +182,7 @@ export default FormatterManager;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ParserManager.html

@@ -594,7 +594,7 @@ values are the parser descriptions.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ParserManager.js.html

@@ -155,7 +155,7 @@ export default ParserManager;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/PluginManager.html

@@ -85,7 +85,7 @@ and then maintains references to them</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line125">line 125</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line127">line 127</a>
     </li></ul></dd>
     
 
@@ -191,7 +191,7 @@ and then maintains references to them</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line209">line 209</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line211">line 211</a>
     </li></ul></dd>
     
 
@@ -328,7 +328,7 @@ loaded from the plugins.</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line178">line 178</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line180">line 180</a>
     </li></ul></dd>
     
 
@@ -439,7 +439,7 @@ loaded from the plugins.</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line166">line 166</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line168">line 168</a>
     </li></ul></dd>
     
 
@@ -550,7 +550,7 @@ loaded from the plugins.</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line190">line 190</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line192">line 192</a>
     </li></ul></dd>
     
 
@@ -660,7 +660,7 @@ built-in rules and the rules loaded from the plugins.</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line200">line 200</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line202">line 202</a>
     </li></ul></dd>
     
 
@@ -770,7 +770,7 @@ each named plugin is loaded. This method returns Promise</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line230">line 230</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line232">line 232</a>
     </li></ul></dd>
     
 
@@ -930,7 +930,7 @@ each named plugin is loaded. This method returns Promise</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/PluginManager.js.html

@@ -86,14 +86,16 @@ export const regexRules = [
         name: "resource-url-match",
         description: "Ensure that URLs that appear in the source string are also used in the translated string",
         note: "URL '{matchString}' from the source string does not appear in the target string",
-        regexps: [ "((https?|github|ftps?|mailto|file|data|irc):\\/\\/)([\\da-zA-Z\\.-]+)\\.([a-zA-Z\\.]{2,6})([\\/\w\\.-]*)*\\/?" ]
+        regexps: [ "((https?|github|ftps?|mailto|file|data|irc):\\/\\/)([\\da-zA-Z\\.-]+)\\.([a-zA-Z\\.]{2,6})([\\/\w\\.-]*)*\\/?" ],
+        link: "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-url-match.md"
     },
     {
         type: "resource-matcher",
         name: "resource-named-params",
         description: "Ensure that named parameters that appear in the source string are also used in the translated string",
         note: "The named parameter '{matchString}' from the source string does not appear in the target string",
-        regexps: [ "\\{\\w+\\}" ]
+        regexps: [ "\\{\\w+\\}" ],
+        link: "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-named-params.md"
     }
 ];
 
@@ -302,7 +304,7 @@ export default PluginManager;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/Project.html

@@ -2056,7 +2056,7 @@ plugins and initializes them.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/Project.js.html

@@ -387,7 +387,7 @@ export default Project;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ResourceICUPlurals.html

@@ -187,7 +187,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="rules_ResourceICUPlurals.js.html">rules/ResourceICUPlurals.js</a>, <a href="rules_ResourceICUPlurals.js.html#line188">line 188</a>
+        <a href="rules_ResourceICUPlurals.js.html">rules/ResourceICUPlurals.js</a>, <a href="rules_ResourceICUPlurals.js.html#line189">line 189</a>
     </li></ul></dd>
     
 
@@ -271,7 +271,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ResourceMatcher.html

@@ -2179,7 +2179,7 @@ The options must contain the following required properties:
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ResourceQuoteStyle.html

@@ -187,7 +187,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="rules_ResourceQuoteStyle.js.html">rules/ResourceQuoteStyle.js</a>, <a href="rules_ResourceQuoteStyle.js.html#line54">line 54</a>
+        <a href="rules_ResourceQuoteStyle.js.html">rules/ResourceQuoteStyle.js</a>, <a href="rules_ResourceQuoteStyle.js.html#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -271,7 +271,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ResourceUniqueKeys.html

@@ -321,7 +321,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/RuleManager.html

@@ -1579,7 +1579,7 @@ known by this instance of the rule manager.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/RuleManager.js.html

@@ -339,7 +339,7 @@ export default RuleManager;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/RuleSet.html

@@ -943,7 +943,7 @@ all rules are returned.</td>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/RuleSet.js.html

@@ -157,7 +157,7 @@ export default RuleSet;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/SourceFile.html

@@ -719,7 +719,7 @@ resource files, or lines in the case of other types of files.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/SourceFile.js.html

@@ -211,7 +211,7 @@ export default SourceFile;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/XliffParser.html

@@ -383,7 +383,7 @@ that result from parsing the file.</li></ul></dd>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/XliffPlugin.html

@@ -299,7 +299,7 @@ plugin
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/formatters_AnsiConsoleFormatter.js.html

@@ -109,6 +109,9 @@ class AnsiConsoleFormatter extends Formatter {
         output = output.replace(/<e\d><\/e\d>/g, "\u001B[91m \u001B[0m");
         output = output.replace(/<e\d>/g, "\u001B[91m");
         output = output.replace(/<\/e\d>/g, "\u001B[0m");
+        if (typeof(result.rule.getLink) === 'function' && result.rule.getLink()) {
+            output += `  More info: ${result.rule.getLink()}\n`;
+        }
         return output;
     }
 }
@@ -128,7 +131,7 @@ export default AnsiConsoleFormatter;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/formatters_ConfigBasedFormatter.js.html

@@ -122,7 +122,7 @@ export class ConfigBasedFormatter extends Formatter {
         let output = this.template;
         
         for (let prop of resultFields) {
-            output = output.replace(new RegExp(`{${prop}}`, "g"), result[prop]);
+            output = output.replace(new RegExp(`{${prop}}`, "g"), result[prop] || "");
         }
         output = output.replace(new RegExp("{ruleName}", "g"), result.rule.getName());
         output = output.replace(new RegExp("{ruleDescription}", "g"), result.rule.getDescription());
@@ -130,6 +130,12 @@ export class ConfigBasedFormatter extends Formatter {
         output = output.replace(/<e\d><\/e\d>/g, `${this.highlightStart}${this.highlightEnd}`);
         output = output.replace(/<e\d>/g, this.highlightStart);
         output = output.replace(/<\/e\d>/g, this.highlightEnd);
+
+        let link = "";
+        if (typeof(result.rule.getLink) === 'function') {
+            link = result.rule.getLink() || "";
+        }
+        output = output.replace(new RegExp("{ruleLink}", "g"), link);
         return output;
     }
 }
@@ -147,7 +153,7 @@ export class ConfigBasedFormatter extends Formatter {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/global.html

@@ -147,7 +147,7 @@ the regular i18nlint stream.</li></ul></dd>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line115">line 115</a>
+        <a href="PluginManager.js.html">PluginManager.js</a>, <a href="PluginManager.js.html#line117">line 117</a>
     </li></ul></dd>
     
 
@@ -511,7 +511,7 @@ by the the excludes and includes list
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/plugins_XliffParser.js.html

@@ -126,7 +126,7 @@ export default XliffParser;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/plugins_XliffPlugin.js.html

@@ -106,7 +106,7 @@ export default XliffPlugin;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/resource-icu-plurals.md

@@ -0,0 +1,21 @@
+# resource-icu-plurals
+
+If you received this error, then there is a syntax error in your plural string in
+the source String or in the translation string. Strings are expected to follow the
+ICU format plurals. More info can be found [here](https://formatjs.io/docs/core-concepts/icu-syntax/#plural-format).
+
+There may be multiple types of errors:
+
+- The source contains a plural, but the translation does not. Obviously, you need
+  to ask the translator to put in the correct plural.
+- The translation contains a plural, but it is not in the right syntax. Make sure
+  it follows the syntax as per above.
+- The translation contains a plural and it is in the right syntax, but it has the
+  wrong categories. Each locale uses a different set of categories of plurals. For
+  example, Russian uses "one", "few", and "other", whereas Japanese only uses
+  "other". The translator should know which categories their language uses and add
+  the appropriate categories to the plural or subtract the ones that are not
+  needed.
+- The translation contains a plural in the right syntax, but it uses plural categories
+  that the target locale does not need. In this case, simply remove the unneeded
+  plural category translation.

package/docs/resource-named-params.md

@@ -0,0 +1,8 @@
+# resource-named-params
+
+Ensure that named parameters that appear in the source string are also used in the
+translated string. Named parameters have the syntax {name}. That is, they are a
+simple name surrounded by curly braces. The same parameter must also exist in the
+target string with the same name. Sometimes translators accidentally translate
+the name of the parameter. Also, if the target string contains a parameter that
+the source string does not, you will also get this error.

package/docs/resource-quote-style.md

@@ -0,0 +1,21 @@
+# resource-quote-style
+
+If you received this error in your project, that means that a string was found where:
+
+- the source string contains quotes
+- the target string does not contain quotes or the quotes are not correct for the
+  target locale
+
+Try adding quotes around the translation of the part of the source string that was
+quoted, or adjusting the quotes in the target string to be appropriate for the target
+locale.
+
+Example string with a problem:
+
+source in English: This is a “string” in English.
+target in German: Dies ist eine "Zeichenfolge" auf deutsch.
+
+This would be flagged because the target is using the ASCII quotes instead of the
+proper quotes in German. The correct proper quotes would look like this:
+
+target: Dies ist eine „Zeichenfolge“ auf deutsch.

package/docs/resource-unique-keys.md

@@ -0,0 +1,6 @@
+# resource-unique-keys
+
+If you received this error, it means that there are multiple resources in your project
+that have the same unique key, making them not actually unique. To resolve this,
+try changing the unique key for one of the instances so that they are both actually
+unique.

package/docs/resource-url-match.md

@@ -0,0 +1,7 @@
+# resource-url-match
+
+Ensure that URLs that appear in the source string are also used in the translated string.
+This rule checks the source string for anything that matches an URL. If found, the same
+URL must appear in the translation of the string as well. In some cases, you may want a
+different URL in the translation. In that case, this rule should be turned off for that
+string.

package/docs/rules_ResourceICUPlurals.js.html

@@ -108,6 +108,7 @@ class ResourceICUPlurals extends Rule {
         this.name = "resource-icu-plurals";
         this.description = "Ensure that plurals in translated resources have the correct syntax";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
+        this.link = "https://gihub.com/ilib-js/i18nlint/blob/main/docs/resource-icu-plurals.md";
     }
 
     getRuleType() {
@@ -289,7 +290,7 @@ export default ResourceICUPlurals;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_ResourceMatcher.js.html

@@ -107,7 +107,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";
@@ -240,7 +240,7 @@ export default ResourceMatcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_ResourceQuoteStyle.js.html

@@ -89,6 +89,7 @@ class ResourceQuoteStyle extends Rule {
             // only localized quotes are allowed in the target string
             this.localeOnly = true;
         }
+        this.link = "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-quote-style.md";
     }
 
     getRuleType() {
@@ -236,7 +237,7 @@ export default ResourceQuoteStyle;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_ResourceSourceChecker.js.html

@@ -106,7 +106,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";
@@ -239,7 +239,7 @@ export default ResourceMatcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_ResourceTargetChecker.js.html

@@ -106,7 +106,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";
@@ -239,7 +239,7 @@ export default ResourceMatcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_ResourceUniqueKeys.js.html

@@ -83,7 +83,7 @@ class ResourceUniqueKeys extends Rule {
         this.name = "resource-unique-keys";
         this.description = "Ensure that the keys are unique within a locale across all resource files";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-
+        this.link = "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-unique-keys.md";
         this.ts = new TranslationSet();
     }
 
@@ -138,7 +138,7 @@ export default ResourceUniqueKeys;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/rules_SourceFileChecker.js.html

@@ -106,7 +106,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";
@@ -239,7 +239,7 @@ export default ResourceMatcher;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/walk.js.html

@@ -213,7 +213,7 @@ export default walk;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Sun Jan 29 2023 19:20:30 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Mon Feb 06 2023 10:29:33 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ilib-lint",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "module": "./src/index.js",
     "type": "module",
     "bin": "./src/index.js",
@@ -71,7 +71,7 @@
     },
     "dependencies": {
         "@formatjs/intl": "^2.6.3",
-        "i18nlint-common": "^1.2.0",
+        "i18nlint-common": "^1.3.0",
         "ilib-common": "^1.1.3",
         "ilib-lint-plugin-test": "file:test/ilib-lint-plugin-test",
         "ilib-locale": "^1.2.2",

package/src/PluginManager.js

@@ -39,14 +39,16 @@ export const regexRules = [
         name: "resource-url-match",
         description: "Ensure that URLs that appear in the source string are also used in the translated string",
         note: "URL '{matchString}' from the source string does not appear in the target string",
-        regexps: [ "((https?|github|ftps?|mailto|file|data|irc):\\/\\/)([\\da-zA-Z\\.-]+)\\.([a-zA-Z\\.]{2,6})([\\/\w\\.-]*)*\\/?" ]
+        regexps: [ "((https?|github|ftps?|mailto|file|data|irc):\\/\\/)([\\da-zA-Z\\.-]+)\\.([a-zA-Z\\.]{2,6})([\\/\w\\.-]*)*\\/?" ],
+        link: "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-url-match.md"
     },
     {
         type: "resource-matcher",
         name: "resource-named-params",
         description: "Ensure that named parameters that appear in the source string are also used in the translated string",
         note: "The named parameter '{matchString}' from the source string does not appear in the target string",
-        regexps: [ "\\{\\w+\\}" ]
+        regexps: [ "\\{\\w+\\}" ],
+        link: "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-named-params.md"
     }
 ];
 

package/src/formatters/AnsiConsoleFormatter.js

@@ -62,6 +62,9 @@ class AnsiConsoleFormatter extends Formatter {
         output = output.replace(/<e\d><\/e\d>/g, "\u001B[91m \u001B[0m");
         output = output.replace(/<e\d>/g, "\u001B[91m");
         output = output.replace(/<\/e\d>/g, "\u001B[0m");
+        if (typeof(result.rule.getLink) === 'function' && result.rule.getLink()) {
+            output += `  More info: ${result.rule.getLink()}\n`;
+        }
         return output;
     }
 }

package/src/formatters/ConfigBasedFormatter.js

@@ -75,7 +75,7 @@ export class ConfigBasedFormatter extends Formatter {
         let output = this.template;
         
         for (let prop of resultFields) {
-            output = output.replace(new RegExp(`{${prop}}`, "g"), result[prop]);
+            output = output.replace(new RegExp(`{${prop}}`, "g"), result[prop] || "");
         }
         output = output.replace(new RegExp("{ruleName}", "g"), result.rule.getName());
         output = output.replace(new RegExp("{ruleDescription}", "g"), result.rule.getDescription());
@@ -83,6 +83,12 @@ export class ConfigBasedFormatter extends Formatter {
         output = output.replace(/<e\d><\/e\d>/g, `${this.highlightStart}${this.highlightEnd}`);
         output = output.replace(/<e\d>/g, this.highlightStart);
         output = output.replace(/<\/e\d>/g, this.highlightEnd);
+
+        let link = "";
+        if (typeof(result.rule.getLink) === 'function') {
+            link = result.rule.getLink() || "";
+        }
+        output = output.replace(new RegExp("{ruleLink}", "g"), link);
         return output;
     }
 }

package/src/rules/ResourceICUPlurals.js

@@ -61,6 +61,7 @@ class ResourceICUPlurals extends Rule {
         this.name = "resource-icu-plurals";
         this.description = "Ensure that plurals in translated resources have the correct syntax";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
+        this.link = "https://gihub.com/ilib-js/i18nlint/blob/main/docs/resource-icu-plurals.md";
     }
 
     getRuleType() {

package/src/rules/ResourceMatcher.js

@@ -60,7 +60,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";

package/src/rules/ResourceQuoteStyle.js

@@ -42,6 +42,7 @@ class ResourceQuoteStyle extends Rule {
             // only localized quotes are allowed in the target string
             this.localeOnly = true;
         }
+        this.link = "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-quote-style.md";
     }
 
     getRuleType() {

package/src/rules/ResourceSourceChecker.js

@@ -59,7 +59,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";

package/src/rules/ResourceTargetChecker.js

@@ -59,7 +59,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";

package/src/rules/ResourceUniqueKeys.js

@@ -36,7 +36,7 @@ class ResourceUniqueKeys extends Rule {
         this.name = "resource-unique-keys";
         this.description = "Ensure that the keys are unique within a locale across all resource files";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-
+        this.link = "https://github.com/ilib-js/i18nlint/blob/main/docs/resource-unique-keys.md";
         this.ts = new TranslationSet();
     }
 

package/src/rules/SourceFileChecker.js

@@ -59,7 +59,7 @@ class ResourceMatcher extends Rule {
         if (!options || !options.name || !options.description || !options.note || !options.regexps) {
             throw "Missing required options for the ResourceMatcher constructor";
         }
-        ["name", "description", "regexps", "note", "sourceLocale"].forEach(prop => {
+        ["name", "description", "regexps", "note", "sourceLocale", "link"].forEach(prop => {
             this[prop] = options[prop];
         });
         this.sourceLocale = this.sourceLocale || "en-US";