ilib-lint 1.6.1 → 1.7.0

package/README.md

@@ -717,6 +717,26 @@ limitations under the License.
 
 ## Release Notes
 
+### v1.7.0
+
+- added the ability to include or exclude locales from declarative rules
+    - the "locales" property gives the list of locales that the
+      the rule applies to
+    - the "skipLocales" property gives the list of locales that
+      the rule does not apply to
+    - modified a few locales to be Japanese-only:
+        - resource-no-fullwidth-punctuation-subset
+        - resource-no-space-between-double-and-single-byte-character
+        - resource-no-double-byte-space
+        - this fixes a bug where these rules erroneously applied to
+          Chinese
+- fixed plural checker to not produce a result if the source plural
+  category is empty. Previously, if the source category and the target
+  category were both empty, it would complain that the target string
+  is the same as the source string.
+- fixed parsing of select and selectordinal plurals so they don't complain
+  about a missing "one" category
+
 ### v1.6.1
 
 - resource-quote-style: don't emit error when quotes are missing in SV target

package/README.md.orig

@@ -717,16 +717,39 @@ limitations under the License.
 
 ## Release Notes
 
+<<<<<<< HEAD
+### v1.6.2
+
+- fixed plural checker to not produce a result if the source plural
+  category is empty. Previously, if the source category and the target
+  category were both empty, it would complain that the target string
+  is the same as the source string.
+- fixed parsing of select and selectordinal plurals so they don't complain
+  about a missing "one" category
+=======
+### v1.7.0
+
+- added the ability to include or exclude locales from declarative rules
+    - the "locales" property gives the list of locales that the
+      the rule applies to
+    - the "skipLocales" property gives the list of locales that
+      the rule does not apply to
+    - modified a few locales to be Japanese-only:
+        - resource-no-fullwidth-punctuation-subset
+        - resource-no-space-between-double-and-single-byte-character
+        - resource-no-double-byte-space
+        - this fixes a bug where these rules erroneously applied to
+          Chinese
+    - modified a rule to be every language except Swedish:
+        - resource-quote-style
+>>>>>>> c833d2b (Added "locales" and "skipLocales")
+
 ### v1.6.1
 
-<<<<<<< HEAD
 - resource-quote-style: don't emit error when quotes are missing in SV target
 - fixed a problem of false positives when there is a plural and the target
   language has less plural categories than the source language
-- Having no state attribute on the target tag of a translation unit would
-=======
 - having no state attribute on the target tag of a translation unit would
->>>>>>> main
   cause an exception. Now it properly gives an error that no state was found.
 - fixed a problem where the same results were printed out multiple times
 

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.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/BuiltinPlugin.html

@@ -299,7 +299,7 @@ plugin
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight 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.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/DeclarativeResourceRule.html

@@ -74,19 +74,13 @@
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Construct a new regular expression-based declarative resource rule.
-
-In addition to the options required by the ResourceRule class, the
-options must contain the following required properties:
-
-- regexps - an array of strings that encode regular expressions to
-  look for</li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li>Construct a new regular expression-based declarative resource rule.</li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line36">line 36</a>
+        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line66">line 66</a>
     </li></ul></dd>
     
 
@@ -146,6 +140,8 @@ options must contain the following required properties:
         <th>Type</th>
 
         
+        <th>Attributes</th>
+        
 
         
 
@@ -172,10 +168,352 @@ options must contain the following required properties:
             </td>
 
             
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">options as documented above
+                <h6>Properties</h6>
+                
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Attributes</th>
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the unique name of this rule</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>description</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">a one-line description of what
+  this rule checks for. Example: "Check that URLs in the source also
+  appear in the target"</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>note</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">a one-line note that will be printed on
+  screen when the check fails. Example: "The URL {matchString} did
+  not appear in the target." (Currently, matchString is the only
+  replacement param that is supported.)</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>regexps</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">an array of strings that encode
+  regular expressions to look for</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>sourceLocale</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the source locale of this rule</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>link</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
 
             
 
-            <td class="description last">options as documented above</td>
+            <td class="description last">the URL to a web page that explains this
+  rule in more detail</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+            </td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code></code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>options.locales</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;String></span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the target locales to which this
+  rule applies. If specified, this rule will skip resources that have a
+  target locale that does not match either the language or the language-script
+  part of each of the locales. If not specified, the rule applies to all
+  target locales.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>options.skipLocales</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;String></span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the target locales to which this
+  rule does not apply. If specified, this rule will skip resources that have a
+  target locale that matches either the language or the language-script
+  part of any of the given locales. If not specified, the rule applies to all
+  target locales. If both locales and skipLocales are specified, only the
+  locales will used.</td>
         </tr>
 
     
@@ -242,7 +580,7 @@ options must contain the following required properties:
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line66">line 66</a>
+        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line109">line 109</a>
     </li></ul></dd>
     
 
@@ -556,7 +894,7 @@ any matches to the regular expression
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line71">line 71</a>
+        <a href="rules_DeclarativeResourceRule.js.html">rules/DeclarativeResourceRule.js</a>, <a href="rules_DeclarativeResourceRule.js.html#line114">line 114</a>
     </li></ul></dd>
     
 
@@ -640,7 +978,7 @@ any matches to the regular expression
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/DirItem.html

@@ -574,7 +574,7 @@ representations of this file
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/DirItem.js.html

@@ -140,7 +140,7 @@ export default DirItem;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FileType.html

@@ -483,7 +483,7 @@ all of the ruleset definitions
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FileType.js.html

@@ -215,7 +215,7 @@ export default FileType;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight 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.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/FormatterManager.js.html

@@ -191,7 +191,7 @@ export default FormatterManager;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/LineParser.html

@@ -274,7 +274,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/LineRegexpChecker.html

@@ -340,7 +340,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.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight 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.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/ParserManager.js.html

@@ -160,7 +160,7 @@ export default ParserManager;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri May 19 2023 07:03:58 GMT-0700 (Pacific Daylight 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.2</a> on Tue May 23 2023 10:08:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>