Got transformers working

packages/ilib-lint/src/FileType.js

@@ -32,6 +32,78 @@ const logger = log4js.getLogger("ilib-lint.FileType");
  * Files in the unknown file type are usually not processed.
  */
 class FileType {
+    /**
+     * The lint project that this file is a part of.
+     * @type {Project}
+     */
+    project;
+
+    /**
+     * The name or glob spec for this file type
+     * @type {String|undefined}
+     */
+    name;
+
+    /**
+     * The list of locales to use with this file type
+     * @type {Array.<String>|undefined}
+     */
+    locales;
+
+    /**
+     * The intermediate representation type of this file type.
+     * @type {String}
+     */
+    type;
+
+    /**
+     * The array of names of classes of parsers to use with this file type.
+     * @type {Array.<String>|undefined}
+     */
+    parsers = undefined;
+
+    /**
+     * The array of classes of parsers to use with this file type.
+     * @type {Array.<Class>|undefined}
+     */
+    parserClasses = undefined;
+
+    /**
+     * The array of names of transformers to use with this file type.
+     * @type {Array.<String>|undefined}
+     */
+    transformers = undefined;
+
+    /**
+     * The array of instances of transformers to use with this file type.
+     * @type {Array.<Transformer>|undefined}
+     */
+    transformerInstances = undefined;
+
+    /**
+     * The serializer to use with this file type.
+     * @type {String|undefined}
+     */
+    serializer = undefined;
+
+    /**
+     * The instance of the serializer to use with this file type.
+     * @type {Serializer|undefined}
+     */
+    serializerInst = undefined;
+
+    /**
+     * The array of rule sets to apply to files of this type.
+     * @type {Array<String>|undefined}
+     */
+    ruleset = undefined;
+
+    /**
+     * The path template for this file type.
+     * @type {String|undefined}
+     */
+    template = undefined;
+
     /**
      * Contructor a new instance of a file type.
      *
@@ -84,24 +156,20 @@ class FileType {
             }
         });
 
-        let parserType;
-
         if (this.parsers) {
             const parserMgr = this.project.getParserManager();
             this.parserClasses = this.parsers.map(parserName => {
                 const parser = parserMgr.getByName(parserName);
                 if (!parser) {
                     throw `Could not find parser ${parserName} named in the configuration for filetype ${this.name}`;
                 }
-                if (!parserType) {
-                    parserType = parserMgr.getType(parserName);
+                if (!this.type) {
+                    this.type = parserMgr.getType(parserName);
                 }
                 return parser;
             });
         }
 
-        this.type = parserType || "string";
-
         if (this.ruleset) {
             if (typeof(this.ruleset) === 'string') {
                 // single string -> convert to an array with a single element
@@ -118,22 +186,23 @@ class FileType {
             }
         }
 
-        /*
         if (this.transformers) {
+            const names = Array.isArray(this.transformers) ? this.transformers : [ this.transformers ];
             const transformerMgr = this.project.getTransformerManager();
-            this.transformerClasses = this.transformers.map(transformerName => {
-                const transformer = transformerMgr.getByName(transformerName);
+            this.transformerInstances = names.map(transformerName => {
+                const transformer = transformerMgr.get(transformerName);
                 if (!transformer) {
                     throw `Could not find transformer ${transformerName} named in the configuration for filetype ${this.name}`;
                 }
-                const transformerType = this.transformerInst.getType();
-                if (transformerType !== this.type) {
-                     throw new Error(`The transformer ${name} processes representations of type ${transformerType}, but the filetype ${this.name} handles representations of type ${this.type}. The two types must match.`);
+                const transformerType = transformer.getType();
+                if (!this.type) {
+                    this.type = transformerType;
+                } else if (transformerType !== this.type) {
+                     throw new Error(`The transformer ${transformerName} processes representations of type ${transformerType}, but the filetype ${this.name} handles representations of type ${this.type}. The two types must match.`);
                 }
                 return transformer;
             });
         }
-        */
 
         if (this.serializer) {
             // if it is a string, then that string is the name of the serializer. If it is an object,
@@ -145,10 +214,16 @@ class FileType {
                 throw new Error(`Could not find or instantiate serializer ${this.serializer} named in the configuration for filetype ${this.name}`);
             }
             const serializerType = this.serializerInst.getType();
-            if (serializerType !== this.type) {
+            if (!this.type) {
+                this.type = serializerType;
+            } else if (serializerType !== this.type) {
                 throw new Error(`The serializer ${name} processes representations of type ${serializerType}, but the filetype ${this.name} handles representations of type ${this.type}. The two types must match.`);
             }
         }
+
+        if (!this.type) {
+            this.type = "string";
+        }
     }
 
     getName() {
@@ -235,6 +310,16 @@ class FileType {
         return this.rules;
     }
 
+    /**
+     * Return the list of transformers to use with this file type.
+     *
+     * @returns {Array.<Transformer>|undefined} an array of transformer instances to use
+     * with this file type, or undefined if there are none.
+     */
+    getTransformers() {
+        return this.transformerInstances;
+    }
+
     /**
      * Return an instance of the serializer class for this file type.
      *

packages/ilib-lint/src/LintableFile.js

@@ -96,6 +96,7 @@ class LintableFile extends DirItem {
             extension = extension.substring(1);
             this.parsers = this.filetype.getParserClasses(extension);
         }
+        this.transformers = this.filetype.getTransformers();
         this.serializer = this.filetype.getSerializer();
     }
 
@@ -327,6 +328,33 @@ class LintableFile extends DirItem {
     getFileType() {
         return this.filetype;
     }
+
+    /**
+     * Apply the available transformers to the intermediate representations of this file.
+     * @param {Array.<Result>} results the results of the rules that were applied earlier
+     *   in the pipeline, or undefined if there are no results or if the rules have not been
+     *   applied yet
+     */
+    applyTransformers(results) {
+        const transformers = this.filetype.getTransformers();
+        if (this.irs && this.irs.length > 0 && transformers && transformers.length > 0) {
+            // For each intermediate representation, attempt to apply every transformer.
+            // However, only those transformers that have the same type as the intermediate
+            // representation can be applied.
+            for (let i = 0; i < this.irs.length; i++) {
+                if (!this.irs[i]) continue;
+                transformers.forEach(transformer => {
+                    if (this.irs[i].getType() === transformer.getType()) {
+                        const newIR = transformer.transform(this.irs[i], results);
+                        if (newIR) {
+                            this.irs[i] = newIR;
+                            this.dirty = true;
+                        }
+                    }
+                });
+            }
+        }
+    }
 }
 
 export default LintableFile;

packages/ilib-lint/src/PluginManager.js

@@ -289,7 +289,7 @@ class PluginManager {
             this.fixerMgr.add(plugin.getFixers());
         }
         if (typeof(plugin.getTransformers) === 'function') {
-            this.serializerMgr.add(plugin.getTransformers());
+            this.transformerMgr.add(plugin.getTransformers());
         }
         if (typeof(plugin.getSerializers) === 'function') {
             this.serializerMgr.add(plugin.getSerializers());

packages/ilib-lint/src/Project.js

@@ -426,6 +426,15 @@ class Project extends DirItem {
         return pluginMgr.getFixerManager();
     }
 
+    /**
+     * Return the serializer manager for this project.
+     * @returns {TransformerManager} the serializer
+     */
+    getTransformerManager() {
+        const pluginMgr = this.options.pluginManager;
+        return pluginMgr.getTransformerManager();
+    }
+
     /**
      * Return the serializer manager for this project.
      * @returns {SerializerManager} the serializer
@@ -548,7 +557,7 @@ class Project extends DirItem {
      * @param {Array.<Result>} results the results of the linting process
      */
     applyTransformers(results) {
-        // this.files.forEach(file => file.applyTransformers());
+        this.files.forEach(file => file.applyTransformers(results));
     }
 
     /**

packages/ilib-lint/src/plugins/string/StringFixCommand.js

@@ -152,10 +152,10 @@ export class StringFixCommand {
 
     /**
      * Apply multiple StringFixCommands to a supplied string
-     * 
+     *
      * @throws when some of the provided commands overlap (as defined in {@link StringFixCommand.overlaps})
      * @throws when some of the provided commands intend to modify range outside of input string bounds
-     * 
+     *
      * @param {string} content string to apply commands to
      * @param {StringFixCommand[]} commands commands that should be applied to the content string
      * @return {string} modified content

packages/ilib-lint/src/plugins/string/StringParser.js

@@ -59,7 +59,7 @@ class StringParser extends Parser {
 
     canWrite = true;
 
-    /** 
+    /**
      * @override
      * @param {IntermediateRepresentation} ir
      */

packages/ilib-lint/src/rules/DeclarativeResourceRule.js

@@ -2,7 +2,7 @@
  * DeclarativeResourceRule.js - subclass of ResourceRule that can iterate over
  * an arrays of regular expressions to apply to a resource
  *
- * Copyright © 2023 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.
@@ -52,7 +52,7 @@ class DeclarativeResourceRule extends ResourceRule {
     /**
      * Construct a new regular expression-based declarative resource rule.
      *
-     * @param {Object} options options as documented above
+     * @param {Object} options options as documented below
      * @param {String} options.name the unique name of this rule
      * @param {String} options.description a one-line description of what
      *   this rule checks for. Example: "Check that URLs in the source also

packages/ilib-lint/src/rules/LineRegexpChecker.js

@@ -136,7 +136,7 @@ class LineRegexpChecker extends Rule {
 
         let results = [];
 
-        // representation should be an array of lines 
+        // representation should be an array of lines
         const lines = ir.getRepresentation();
 
         lines.forEach((line, i) => {

packages/ilib-lint/src/rules/ResourceDNTTerms.js

@@ -92,7 +92,7 @@ class ResourceDNTTerms extends ResourceRule {
      * @param {Object} props
      * @param {string} props.source the source string
      * @param {string} props.target the target string
-     * @param {Resource} props.resource the resource being checked 
+     * @param {Resource} props.resource the resource being checked
      * @param {string} props.file the file where the resource came from
      * @returns {Array.<Result>|undefined} the results
      */

packages/ilib-lint/src/rules/ResourceEdgeWhitespace.js

@@ -117,7 +117,7 @@ class ResourceEdgeWhitespace extends ResourceRule {
     _truncateFromEnd(/** @type {string} */ str) {
         const maxLength = 5;
         const truncationMark = "…";
-        
+
         if (str.length <= maxLength) {
             return str;
         }

packages/ilib-lint/src/rules/ResourceICUPluralTranslation.js

@@ -49,7 +49,7 @@ class ResourceICUPluralTranslation extends ResourceRule {
      * "x" + "y" vs. " x" + " y "
      * Without adding the spaces and then compressing them before comparison,
      * the two would not be the same, even though the actual translatable text
-     * in them is the same, which is what we were trying to get at. 
+     * in them is the same, which is what we were trying to get at.
      * @private
      */
     reconstruct(nodes) {

packages/ilib-lint/src/rules/ResourceRule.js

@@ -44,7 +44,7 @@ class ResourceRule extends Rule {
         /**
          * Ensure that the rule is only applied to resources that match one of
          * the lang-specs in the the set.
-         * 
+         *
          * These should be language specifiers (e.g. "it", not "it-IT").
          *
          * @type {Set<string> | undefined}
@@ -55,7 +55,7 @@ class ResourceRule extends Rule {
         /**
          * Ensure that the rule is only applied to resources that do not match
          * any of the lang-specs in the set.
-         * 
+         *
          * These should be language specifiers (e.g. "it", not "it-IT").
          *
          * @type {Set<string> | undefined}
@@ -137,12 +137,12 @@ class ResourceRule extends Rule {
                         });
                     }).filter(element => element);
                     return results && results.length ? results : undefined;
-    
+
                 case 'plural':
                     const srcPlural = resource.getSource() ?? {};
                     const tarPlural = resource.getTarget() ?? {};
                     const categorySet = new Set(Object.keys(srcPlural).concat(Object.keys(tarPlural)));
-    
+
                     results = Array.from(categorySet).flatMap(category => {
                         return this.matchString({
                             source: srcPlural[category] ?? srcPlural.other,

packages/ilib-lint/src/rules/ResourceSourceChecker.js

@@ -2,7 +2,7 @@
  * ResourceSourceChecker.js - implement a declarative rule to check
  * source strings for problems
  *
- * 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.
@@ -24,7 +24,7 @@ import { stripPlurals } from './utils.js';
 
 /**
  * @class Resource checker class that checks that any regular expressions
- * that matches in the source also appears in the translation.
+ * that matches in the source causes a result to be returned.
  */
 class ResourceSourceChecker extends DeclarativeResourceRule {
     /**

packages/ilib-lint/src/rules/ResourceTargetChecker.js

@@ -2,7 +2,7 @@
  * ResourceTargetChecker.js - implement a declarative rule to check
  * target strings for problems
  *
- * 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.
@@ -24,7 +24,7 @@ import { stripPlurals } from './utils.js';
 
 /**
  * @class Resource checker class that checks that any regular expressions
- * that matches in the source also appears in the translation.
+ * that matches in the target causes a Result to be created.
  */
 class ResourceTargetChecker extends DeclarativeResourceRule {
     /**