ilib-lint 2.9.2 → 2.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ilib-lint",
-  "version": "2.9.2",
+  "version": "2.10.0",
   "type": "module",
   "main": "./src/index.js",
   "module": "./src/index.js",
@@ -72,9 +72,9 @@
     "options-parser": "^0.4.0",
     "xml-js": "^1.6.11",
     "ilib-common": "^1.1.6",
-    "ilib-lint-common": "^3.2.0",
+    "ilib-lint-common": "^3.4.0",
     "ilib-locale": "^1.2.4",
-    "ilib-tools-common": "^1.15.0"
+    "ilib-tools-common": "^1.16.0"
   },
   "scripts": {
     "coverage": "pnpm test -- --coverage",

package/src/LintableFile.js

@@ -348,7 +348,7 @@ class LintableFile extends DirItem {
                         const newIR = transformer.transform(this.irs[i], results);
                         if (newIR) {
                             this.irs[i] = newIR;
-                            this.dirty = true;
+                            this.dirty = newIR.isDirty();
                         }
                     }
                 });

package/src/Project.js

@@ -668,7 +668,7 @@ class Project extends DirItem {
                 errorsOnly : this.options.opt.errorsOnly || false
             });
         } else {
-            results.forEach(result => {
+            resultAll = results.map(result => {
                 const str = this.formatter.format(result);
                 if (str) {
                     if (result.severity === "error") {
@@ -683,7 +683,8 @@ class Project extends DirItem {
                         }
                     }
                 }
-            });
+                return str;
+            }).join("\n");
 
             logger.info(`Total Elapse Time: ${String(totalTime)} seconds`);
             logger.info(`                             ${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}`);

package/src/formatters/JsonFormatter.js

@@ -70,7 +70,8 @@ class JsonFormatter extends Formatter {
                 return {
                     pathName: result.pathName,
                     rule: result.rule.getName(),
-                    severity: result.severity
+                    severity: result.severity,
+                    locale: result.locale
                 };
             })
         };
@@ -86,6 +87,7 @@ class JsonFormatter extends Formatter {
             obj[name].stats.lines = fileStats.lines;
             obj[name].stats.bytes = fileStats.bytes;
             obj[name].stats.modules = fileStats.modules;
+            obj[name].stats.words = fileStats.words;
         }
 
         // write as compressed JSON to save space;

package/src/plugins/ErrorFilterTransformer.js

@@ -19,6 +19,7 @@
  */
 
 import { IntermediateRepresentation, Transformer, Result } from 'ilib-lint-common';
+import { Resource } from 'ilib-tools-common';
 
 /**
  * Filter out errors from the intermediate representation.
@@ -46,12 +47,18 @@ class ErrorFilterTransformer extends Transformer {
             return ir;
         }
         const resources = ir.getRepresentation();
-        const idsToExclude = results.filter(result => result.id && result.severity === 'error').map(result => result.id);
-        const filteredResources = resources.filter(resource => !idsToExclude.includes(resource.getKey()));
+        const hashesToExclude = results.filter(result => result.id && result.severity === 'error').
+            map(result => [result.id, result.locale, result.pathName].join('_'));
+        const filteredResources = resources.filter(/** @type Resource */ resource => {
+            const filePath = resource.getResFile() ?? resource.getPath();
+            const hash = [resource.getKey(), resource.getTargetLocale(), filePath].join('_');
+            return !hashesToExclude.includes(hash);
+        });
         return new IntermediateRepresentation({
             type: ir.getType(),
             ir: filteredResources,
-            sourceFile: ir.getSourceFile()
+            sourceFile: ir.getSourceFile(),
+            dirty: (filteredResources.length !== resources.length)
         });
     }
 };

package/src/plugins/XliffParser.js

@@ -1,7 +1,7 @@
 /*
  * XliffParser.js - Parser for XLIFF files
  *
- * Copyright © 2022-2024 JEDLSoft
+ * Copyright © 2022-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,9 +17,39 @@
  * limitations under the License.
  */
 
-import { ResourceXliff } from 'ilib-tools-common';
+import { ResourceXliff, Resource } from 'ilib-tools-common';
 import { FileStats, Parser, IntermediateRepresentation, SourceFile } from 'ilib-lint-common';
 
+/**
+ * Count the number of words in the source strings of the resources.
+ * This is a very simple word count that splits the source string
+ * on whitespace and counts the number of resulting pieces. We can replace it
+ * later with a more sophisticated word count if needed.
+ *
+ * @param {Array.<Resource>} resources the resources to count words in
+ * @returns {Number} the total number of words in the source strings
+ */
+function countSourceWords(resources) {
+    return resources.reduce((sum, res) =>
+        sum + (res.getSource() ? res.getSource().split(/\s+/).length : 0), 0);
+}
+
+/**
+ * Count the number of bytes in the source strings of the resources.
+ * This is a simple byte count that counts the number of characters in the
+ * source string, assuming that each character is one byte. This is not
+ * necessarily accurate for all languages, but it is a good enough approximation
+ * for most cases. We can replace it later with a more sophisticated byte count
+ * if needed.
+ *
+ * @param {Array.<Resource>} resources the resources to count bytes in
+ * @returns {Number} the total number of bytes in the source strings
+ */
+function countSourceBytes(resources) {
+    return resources.reduce((sum, res) =>
+        sum + (res.getSource() ? res.getSource().length : 0), 0);
+}
+
 /**
  * @class Parser for XLIFF files based on the ilib-xliff library.
  */
@@ -49,15 +79,17 @@ class XliffParser extends Parser {
         });
 
         xliff.parse(data);
-        const resources = xliff.getResources();
+        const resources = xliff.getResources() ?? [];
         return [new IntermediateRepresentation({
             type: "resource",
             ir: resources,
             sourceFile,
             stats: new FileStats({
                 lines: xliff.getLines(),
-                bytes: xliff.size(),
-                modules: resources.length
+                files: 1,
+                bytes: countSourceBytes(resources),
+                modules: resources.length,
+                words: countSourceWords(resources)
             })
         })];
     }

package/src/rules/ResourceCompleteness.js

@@ -66,7 +66,8 @@ class ResourceCompleteness extends ResourceRule {
             return new Result({
                 ...resultMetaProps,
                 severity: "error",
-                description: "Missing target string in resource"
+                description: "Missing target string in resource",
+                locale: resource.getTargetLocale()
             });
         }
         // if there's an extra translation string for which there is no source, just warn
@@ -75,7 +76,8 @@ class ResourceCompleteness extends ResourceRule {
                 ...resultMetaProps,
                 severity: "warning",
                 description: "Extra target string in resource",
-                highlight: `<e0>${target}</e0>`
+                highlight: `<e0>${target}</e0>`,
+                locale: resource.getTargetLocale()
             });
         }
         else return /* no error */;

package/src/rules/ResourceRule.js

@@ -25,7 +25,7 @@ import { Rule } from 'ilib-lint-common';
 class ResourceRule extends Rule {
     /**
      * Construct a new resource checker rule.
-*
+     *
      * If a subclass defines a property "locales" with the
      * value being a Set of locale lang-specs, then this
      * class will ensure that the rule is only applied to

package/src/rules/ResourceSourceICUPluralCategories.js

@@ -1,7 +1,7 @@
 /*
  * ResourceSourceICUPluralCategories.js
  *
- * Copyright © 2023-2024 JEDLSoft
+ * Copyright © 2023-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -116,6 +116,7 @@ export class ResourceSourceICUPluralCategories extends ResourceRule {
                             highlight: `<e0>${this.substringForLocation(source, partialResult.location)}</e0>`,
                             severity: partialResult.severity,
                             description: partialResult.description,
+                            locale: resource.getTargetLocale(),
                         })
                 )
         );

package/src/rules/ResourceSourceICUPluralParams.js

@@ -1,7 +1,7 @@
 /*
  * ResourceSourceICUPluralParams.js
  *
- * Copyright © 2023-2024 JEDLSoft
+ * Copyright © 2023-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -117,6 +117,7 @@ export class ResourceSourceICUPluralParams extends ResourceRule {
                         highlight: `<e0>${this.substringForLocation(source, partialResult.location)}</e0>`,
                         severity: partialResult.severity,
                         description: partialResult.description,
+                        locale: resource.getTargetLocale(),
                     });
                 }
                 return undefined;

package/src/rules/ResourceSourceICUPluralSyntax.js

@@ -1,7 +1,7 @@
 /*
  * ResourceSourceICUPluralSyntax.js
  *
- * Copyright © 2023-2024 JEDLSoft
+ * Copyright © 2023-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -74,6 +74,7 @@ export class ResourceSourceICUPluralSyntax extends ResourceRule {
                 id: resource.getKey(),
                 pathName: file,
                 lineNumber,
+                locale: resource.getSourceLocale(),
             });
         }
         return undefined;

package/src/rules/ResourceSourceICUUnexplainedParams.js

@@ -1,7 +1,7 @@
 /*
  * ResourceSourceICUUnexplainedParams.js
  *
- * Copyright © 2023-2024 JEDLSoft
+ * Copyright © 2023-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -136,7 +136,8 @@ export class ResourceSourceICUUnexplainedParams extends ResourceRule {
                     source: source,
                     severity: "warning",
                     description: `Replacement parameter "${name}" is not mentioned in the string's comment for translators.`,
-                    highlight: this.highlightLocation(source, location)
+                    highlight: this.highlightLocation(source, location),
+                    locale: resource.getTargetLocale()
                 })
         );
     }

package/src/rules/ResourceUniqueKeys.js

@@ -64,12 +64,13 @@ class ResourceUniqueKeys extends Rule {
 
             if (other) {
                 logger.trace(`hash '${hash}' already found in the translation set!`);
+                const otherFile = other.getResFile() ?? other.getPath();
                 let value = {
                     severity: "error",
                     id: resource.getKey(),
                     rule: this,
                     pathName: file,
-                    highlight: `Key is also defined in this file: ${other.resfile}`,
+                    highlight: `Key is also defined in this file: ${otherFile}`,
                     description: `Key is not unique within locale ${locale}.`,
                     locale
                 };
@@ -79,7 +80,6 @@ class ResourceUniqueKeys extends Rule {
                 return new Result(value);
             }
 
-            resource.resfile = file;
             this.ts.add(resource);
 
             // no result

package/src/rules/SourceRegexpChecker.js

@@ -1,7 +1,7 @@
 /*
  * SourceRegexpChecker.js - rule to check if regexps match in the source
  *
- * Copyright © 2023-2024 JEDLSoft
+ * Copyright © 2023-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -126,7 +126,8 @@ class SourceRegexpChecker extends Rule {
                 pathName: ir.getSourceFile().getPath(),
                 highlight: snippet,
                 description: this.note.replace(/\{matchString\}/g, match[0]),
-                lineNumber
+                lineNumber,
+                locale: ir.getSourceFile().sourceLocale || this.sourceLocale
             }));
             match = re.exec(src);
         }