ilib-lint 2.3.0 → 2.4.0

package/docs/ReleaseNotes.md

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+### v2.4.0
+
+- added the snake case match rule. If source strings contain only snake case and no whitespace, then the targets must be
+  the same. It is treated as Do Not Translate. If the target is different from the source, it is an error.
+
 ### v2.3.0
 
 - implemented the XML match rule. If there are XML tags and entities in the
@@ -19,17 +24,20 @@ Release Notes
 - updated dependencies
 
 ### v2.2.0
+
 - added --no-return-value command-line flag to have the linter always return 0, even
   when there are errors and warnings. This still reports the results to the output.
   The intention is that the linter can be used to report results without causing
   build pipelines to fail.
 
 ### v2.1.1
+
 - check to make sure that every result in the results array returned by the plugins
   is not undefined so that we do not run into the problem of dereferencing undefined
   results later on, which caused some exceptions
 
 ### v2.1.0
+
 - fixed a bug where the quote style checker was not converting the highlight quotes properly
 - added an option `output` to write the output to a file.
 - added an option `name` to give the project name. It is useful when the config file is shared in multiple projects.
@@ -40,6 +48,7 @@ Release Notes
   longer accepted.
 
 ### v2.0.1
+
 - fixed loading of plugins
     - if a plugin `ilib-lint-x` exists and a different package `x`
       also exists that is unrelated to ilib-lint, and the config
@@ -136,7 +145,7 @@ Release Notes
   substituted into a replacement parameter in the source English text. Nouns
   and the articles "a", "an", and "the" are not translatable to all languages
   because of gender and plurality agreement rules.
-- converted all unit tests from  nodeunit to jest
+- converted all unit tests from nodeunit to jest
 - updated dependencies
 
 ### v1.10.0
@@ -242,7 +251,7 @@ Release Notes
 - added rule to warn against half-width kana characters
 - added rule to warn against double-byte whitespace characters
 - added rule to warn of whitespace adjacent to certain fullwidth punctuation characters
-- added rule to warn of a space between double-byte and single-byte character 
+- added rule to warn of a space between double-byte and single-byte character
 - added rule to check whether or not there is a translation for each source string in
   a resource
 - removed ability for the ICU plural rule to report results on the

package/docs/resource-snake-case.md

@@ -0,0 +1,68 @@
+# resource-snake-case
+
+If the source string contains only snake case and no whitespace, then the target must be the same.
+
+The source string is treated as 'Do Not Translate' because snake-cased strings are generally not meant to be translated.
+Instead, they are commonly used in software as identifiers, variable names, or control strings.
+
+## Rule explanation
+Snake case is a way of writing phrases without spaces, where spaces are replaced with underscores (`_`), and the words are typically all lowercase.
+
+In this context, any string that conforms to the following rules is considered snake case and should not be translated:
+* Words in mixed case and/or digits separated by underscores (including trailing and leading whitespace), i.e:
+  * snake_case, 
+  * SOME_SCREAMING_SNAKE_CASE,
+  * camel_Snake_Case,
+  * mixed_CASE,
+  * RandomLY_MixED_case,
+  * even_MORE_RandomLY_MixED_case_with_numbers123_456,
+  * any_case_with_numbers123_456,
+  *  any_Case_with_Trailing_And_Leading_WHITESPACE ,
+  
+
+* Single word with leading underscore, i.e:
+  * _test,
+
+
+* Digits with leading underscore, i.e:
+   * _123,
+   * _123_456
+
+
+* Any case with a leading underscore and/or number, i.e:
+  * _test_and_retest,
+  * _test_And_REtest,
+  * _test_ANd_RETEST,
+  * _test_and_RETEST_and123_456,
+
+
+## Examples
+### Correct
+Correctly matched snake case variations in a Spanish (es-ES) translation, where both source and target are the same:
+
+1. snake_case
+   - source: `access_granted`
+   - target: `access_granted`
+
+2. SCREAMING_SNAKE_CASE
+   - source: `ACCESS_GRANTED`
+   - target: `ACCESS_GRANTED`
+
+3. camel_Snake_Case
+   - source: `access_Granted`
+   - target: `access_Granted`
+   
+4. mixed_CASE with digits
+   - source: `acceSS_GRantEd123_456`
+   - target: `acceSS_GRantEd123_456`
+
+### Incorrect
+Incorrectly matched snake case in a Spanish translation:
+
+1. snake_case
+- source: `access_granted`
+- target: `acceso_concedido`
+
+
+Problems in the above incorrect translation:
+The "access_granted" snake-cased string was translated when it should have been treated as "Do Not Translate".

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ilib-lint",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "module": "./src/index.js",
     "type": "module",
     "bin": "./src/index.js",

package/src/Project.js

@@ -38,7 +38,8 @@ const rulesetDefinitions = {
         "resource-quote-style": "localeOnly",
         "resource-unique-keys": true,
         "resource-url-match": true,
-        "resource-named-params": true
+        "resource-named-params": true,
+        "resource-snake-case": true,
     }
 };
 

package/src/plugins/BuiltinPlugin.js

@@ -227,7 +227,19 @@ export const regexRules = [
         ],
         link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-manual-date-formatting.md",
         severity: "error"
-    }
+    },
+    {
+        type: "resource-matcher",
+        name: "resource-snake-case",
+        description: "Ensure that when source strings contain only snake case (words and/or numbers separeated by underscores) and no whitespace, then the targets are the same",
+        note: "Do not translate the source string if it consists solely of snake-cased strings and/or digits. Please update the target string so it matches the source string.",
+        regexps: [
+            "^\\s*[a-zA-Z0-9]*(_[a-zA-Z0-9]+)+\\s*$",
+            "^\\s*[a-zA-Z0-9]+(_[a-zA-Z0-9]+)*_\\s*$"
+        ],
+        link: "https://gihub.com/ilib-js/ilib-lint/blob/main/docs/resource-snake-case.md",
+        severity: "error"
+    },
 ];
 
 // built-in ruleset that contains all the built-in rules
@@ -254,7 +266,8 @@ export const builtInRulesets = {
         "resource-no-space-between-double-and-single-byte-character": true,
         "resource-no-halfwidth-kana-characters": true,
         "resource-no-double-byte-space": true,
-        "resource-no-space-with-fullwidth-punctuation": true
+        "resource-no-space-with-fullwidth-punctuation": true,
+        "resource-snake-case": true,
     },
 
     source: {

package/src/rules/DeclarativeResourceRule.js

@@ -145,7 +145,7 @@ class DeclarativeResourceRule extends ResourceRule {
         let results = [];
         // only need 1 regexp to match in order to trigger this rule
         for (const re of this.re) {
-            results = results.concat(this.checkString({re, source, target, file, resource}));
+            results = results.concat(this.checkString({re, source, target, file, resource}) ?? []);
             if (results.length > 0) break;
         }
         results = results.filter(result => result);