ilib-lint 2.7.2 → 2.8.0

package/src/index.js

@@ -2,7 +2,7 @@
 /*
  * index.js - main program of ilib-lint
  *
- * 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.
@@ -74,7 +74,7 @@ const optionConfig = {
     },
     list: {
         flag: true,
-        help: "Load all plugins, and then list out all available parsers, rules, rulesets, and formatters, then exit."
+        help: "Load all plugins, and then list out all available parsers, rules, rulesets, formatters, transformers, and serializers then exit."
     },
     locales: {
         short: "l",
@@ -103,10 +103,20 @@ const optionConfig = {
         flag: true,
         help: "Produce lots of progress output during the run."
     },
+    write: {
+        flag: true,
+        default: false,
+        help: "If a file is changed by a fix or transformer, write the file to disk again."
+    },
     fix: {
         flag: true,
         "default": false,
-        help: "If auto-fixes are available for some of the errors, apply them (overwriting the original file)."
+        help: "If auto-fixes are available for some of the errors, apply them and write the file back to disk again. Implies --write."
+    },
+    overwrite: {
+        flag: true,
+        "default": false,
+        help: "When writing a modified file to disk, overwrite the original file instead of writing to a new file."
     },
     "max-errors": {
         short: "me",
@@ -169,7 +179,7 @@ if (options.opt.quiet) {
     logger.level = "debug";
 }
 
-logger.info("ilib-lint - Copyright (c) 2022-2024 JEDLsoft, All rights reserved.");
+logger.info("ilib-lint - Copyright (c) 2022-2025 JEDLsoft, All rights reserved.");
 
 let paths = options.args;
 if (paths.length === 0) {
@@ -188,6 +198,12 @@ options.opt.locales = options.opt.locales.map(spec => {
     return loc.getSpec();
 });
 
+if (options.opt["auto-fix"] || options.opt.overwrite) {
+    // The write option indicates that modified files should be written back to disk.
+    // The write option is implicit if either auto-fix or overwrite is set.
+    options.opt.write = true;
+}
+
 // Load configuration
 let config;
 const cwdConfigProvider = new FolderConfigurationProvider(".");
@@ -226,6 +242,10 @@ try {
         const ruleSetDefinitions = ruleMgr.getRuleSetDefinitions();
         const parserMgr = pluginMgr.getParserManager();
         const parserDescriptions = parserMgr.getDescriptions();
+        const transformerMgr = pluginMgr.getTransformerManager();
+        const transformerDescriptions = transformerMgr.getDescriptions();
+        const serializerMgr = pluginMgr.getSerializerManager();
+        const serializerDescriptions = serializerMgr.getDescriptions();
         const formatterMgr = pluginMgr.getFormatterManager();
         const formatterDescriptions = formatterMgr.getDescriptions();
 
@@ -251,11 +271,32 @@ try {
         for (name in ruleSetDefinitions) {
             output = output.concat(indent(wrap(`${name} - ${ruleSetDefinitions[name].join(", ")}`, 76, "  "), 2));
         }
-        output.push("");
 
-        output.push("Formatters:");
-        for (name in formatterDescriptions) {
-            output = output.concat(indent(wrap(`${name} - ${formatterDescriptions[name]}`, 76, "  "), 2));
+        if (Object.keys(formatterDescriptions).length > 0) {
+            output.push("");
+
+            output.push("Formatters:");
+            for (name in formatterDescriptions) {
+                output = output.concat(indent(wrap(`${name} - ${formatterDescriptions[name]}`, 76, "  "), 2));
+            }
+        }
+
+        if (Object.keys(transformerDescriptions).length > 0) {
+            output.push("");
+
+            output.push("Transformers:");
+            for (name in transformerDescriptions) {
+                output = output.concat(indent(wrap(`${name} - ${transformerDescriptions[name]}`, 76, "  "), 2));
+            }
+        }
+
+        if (Object.keys(serializerDescriptions).length > 0) {
+            output.push("");
+
+            output.push("Serializers:");
+            for (name in serializerDescriptions) {
+                output = output.concat(indent(wrap(`${name} - ${serializerDescriptions[name]}`, 76, "  "), 2));
+            }
         }
 
         console.log(output.join('\n'));

package/src/plugins/BuiltinPlugin.js

@@ -24,6 +24,7 @@ import XliffSerializer from './XliffSerializer.js';
 import LineParser from './LineParser.js';
 import LineSerializer from './LineSerializer.js';
 import StringParser from './string/StringParser.js';
+import ErrorFilterTransformer from './ErrorFilterTransformer.js';
 import StringSerializer from './string/StringSerializer.js';
 import AnsiConsoleFormatter from '../formatters/AnsiConsoleFormatter.js';
 import ResourceICUPlurals from '../rules/ResourceICUPlurals.js';
@@ -301,11 +302,22 @@ class BuiltinPlugin extends Plugin {
         return [XliffParser, LineParser, StringParser];
     }
 
+    /**
+     * For a "transformer" type of plugin, this returns a list of Transformer classes
+     * that this plugin implements.
+     *
+     * @returns {Array.<Transformer>} list of Transformer classes implemented by this
+     * plugin
+     */
+    getTransformers() {
+        return [ErrorFilterTransformer];
+    }
+
     /**
      * For a "serializer" type of plugin, this returns a list of Serializer classes
      * that this plugin implements.
      *
-     * @returns {Array.<Parser>} list of Serializer classes implemented by this
+     * @returns {Array.<Serializer>} list of Serializer classes implemented by this
      * plugin
      */
     getSerializers() {

package/src/plugins/ErrorFilterTransformer.js

@@ -0,0 +1,59 @@
+/*
+ * ErrorFilterTransformer - transform an intermediate representation
+ * by filtering out errors
+ *
+ * Copyright © 2025 JEDLSoft
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { IntermediateRepresentation, Transformer, Result } from 'ilib-lint-common';
+
+/**
+ * Filter out errors from the intermediate representation.
+ */
+class ErrorFilterTransformer extends Transformer {
+    /**
+     * Create a new transformer instance.
+     */
+    constructor(options) {
+        super(options);
+        this.name = "errorfilter";
+        this.description = "Filter out translation units that have errors from the resources representation.";
+        this.type = "resource";
+    }
+
+    /**
+     * Filter out errors from the intermediate representation.
+     *
+     * @param {IntermediateRepresentation} ir the intermediate representation to filter
+     * @param {Result[]|undefined} results the results of the linting process
+     * @returns {IntermediateRepresentation} the filtered intermediate representation
+     */
+    transform(ir, results) {
+        if (ir.getType() !== 'resource' || !results) {
+            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()));
+        return new IntermediateRepresentation({
+            type: ir.getType(),
+            ir: filteredResources,
+            sourceFile: ir.getSourceFile()
+        });
+    }
+};
+
+export default ErrorFilterTransformer;

package/src/plugins/LineSerializer.js

@@ -1,7 +1,7 @@
 /*
  * LineSerializer.js - Serializer for plain text files
  *
- * Copyright © 2024 JEDLSoft
+ * Copyright © 2024-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,7 +30,7 @@ class LineSerializer extends Serializer {
     constructor(options) {
         super(options);
         this.name = "line";
-        this.description = "A serializer for plain text files that splits them into lines.";
+        this.description = "A serializer for plain text files that joins an array of lines into a file with newlines.";
         this.type = "line";
     }
 
@@ -38,11 +38,13 @@ class LineSerializer extends Serializer {
      * Convert the intermediate representation back into a source file.
      *
      * @override
-     * @param {IntermediateRepresentation} ir the intermediate representation to convert
+     * @param {IntermediateRepresentation[]} irs the intermediate representations to convert
      * @returns {SourceFile} the source file with the contents of the intermediate
      * representation
      */
-    serialize(ir) {
+    serialize(irs) {
+        // should only be one ir in this array
+        const ir = irs[0];
         const lines = ir.getRepresentation();
         const data = lines.join("\n");
         return new SourceFile(ir.sourceFile.getPath(), {

package/src/plugins/XliffParser.js

@@ -33,10 +33,6 @@ class XliffParser extends Parser {
         this.extensions = [ "xliff", "xlif", "xlf" ];
         this.name = "xliff";
         this.description = "A parser for xliff files. This can handle xliff v1.2 and v2.0 format files.";
-
-        // indicate that this parser can write out the intermediate representation if it has been modified
-        // by the linter through a Fixer or by a transformer
-        this.canWrite = true;
     }
 
     /**

package/src/plugins/XliffSerializer.js

@@ -39,11 +39,13 @@ class XliffSerializer extends Serializer {
      * Convert the intermediate representation back into a source file.
      *
      * @override
-     * @param {IntermediateRepresentation} ir the intermediate representation to convert
+     * @param {IntermediateRepresentation[]} irs the intermediate representations to convert
      * @returns {SourceFile} the source file with the contents of the intermediate
      * representation
      */
-    serialize(ir) {
+    serialize(irs) {
+        // should only be one ir in this array
+        const ir = irs[0];
         const resources = ir.getRepresentation();
         const xliff = new ResourceXliff({
             path: ir.sourceFile.getPath()

package/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

package/src/plugins/string/StringParser.js

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

package/src/plugins/string/StringSerializer.js

@@ -1,7 +1,7 @@
 /*
  * StringSerializer.js - Serializer for plain text files
  *
- * Copyright © 2024 JEDLSoft
+ * Copyright © 2024-2025 JEDLSoft
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ class StringSerializer extends Serializer {
         super(options);
 
         this.name = "string";
-        this.description = "A serializer for plain text files treats the whole file as a simple string.";
+        this.description = "A serializer for plain text file representations that writes the whole file as a simple string.";
         this.type = "string";
     }
 
@@ -40,11 +40,14 @@ class StringSerializer extends Serializer {
      * Convert the intermediate representation back into a source file.
      *
      * @override
-     * @param {IntermediateRepresentation} ir the intermediate representation to convert
+     * @param {IntermediateRepresentation[]} irs the intermediate representations to convert
      * @returns {SourceFile} the source file with the contents of the intermediate
      * representation
      */
-    serialize(ir) {
+    serialize(irs) {
+        // should only have 1 intermediate representation in the array because the StringParser
+        // only creates one
+        const ir = irs[0];
         const data = ir.getRepresentation();
         return new SourceFile(ir.sourceFile.getPath(), {
             file: ir.sourceFile,

package/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

package/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) => {

package/src/rules/ResourceCamelCase.js

@@ -6,7 +6,6 @@ import {Result} from 'ilib-lint-common';
 /**
  * @classdesc Class representing an ilib-lint programmatic rule for linting camel cased strings.
  * @class
- * @augments ResourceRule
  */
 class ResourceCamelCase extends ResourceRule {
     /**
@@ -30,8 +29,7 @@ class ResourceCamelCase extends ResourceRule {
 
     /**
      * Check if a source string is in camel case and if the target string is the same as the source.
-     * @public
-     * @override ResourceRule.matchString
+     * @override
      * @param {{source: (String|undefined), target: (String|undefined), file: String, resource: Resource}} params
      * @returns {Result|undefined} A Result with severity 'error' if the source string is in camel case and target string is not the same as the source string, otherwise undefined.
      */

package/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
      */

package/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;
         }

package/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) {

package/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,

package/src/rules/ResourceSnakeCase.js

@@ -6,7 +6,6 @@ import {Result} from 'ilib-lint-common';
 /**
  * @classdesc Class representing an ilib-lint programmatic rule for linting snake cased strings.
  * @class
- * @augments ResourceRule
  */
 class ResourceSnakeCase extends ResourceRule {
     /**
@@ -30,8 +29,7 @@ class ResourceSnakeCase extends ResourceRule {
 
     /**
      * Check if a source string is in snake case and if the target string is the same as the source.
-     * @public
-     * @override ResourceRule.matchString
+     * @override
      * @param {{source: (String|undefined), target: (String|undefined), file: String, resource: Resource}} params
      * @returns {Result|undefined} A Result with severity 'error' if the source string is in snake case and target string is not the same as the source string, otherwise undefined.
      */

package/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 {
     /**

package/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 {
     /**

package/src/formatters/__tests__/ConfigBasedFormatter.test.js

@@ -1,61 +0,0 @@
-import {Result} from 'ilib-lint-common';
-import {ConfigBasedFormatter} from '../ConfigBasedFormatter.js';
-import ResourceMatcher from "../../rules/ResourceMatcher.js";
-
-describe('ConfigBasedFormatter', () => {
-    it.each([
-        {
-            name: "a pair of opening and closing tags <eX></eX>",
-            highlight: "This is just <e0>me</e0> testing.",
-            expected: "This is just >>me<< testing."
-        },
-        {
-            name: "a self-closing tag <eX/>",
-            highlight: "This is just me testing.<e0/>",
-            expected: "This is just me testing.>><<"
-        },
-        {
-            name: "an opening tag <eX>",
-            highlight: "This is just me testing.<e0>",
-            expected: "This is just me testing.>>"
-        },
-        {
-            name: "a closing tag </eX>",
-            highlight: "This is just me testing.</e0>",
-            expected: "This is just me testing.<<"
-        },
-    ])('replaces $name with highlight markers', ({highlight, expected}) => {
-        const formatter = new ConfigBasedFormatter({
-            "name": "test-formatter",
-            "description": "A formatter for testing purposes",
-            "template": "{highlight}",
-            "highlightStart": ">>",
-            "highlightEnd": "<<"
-        })
-
-        const result = formatter.format(new Result({
-            description: "A description for testing purposes",
-            highlight,
-            id: "test.id",
-            lineNumber: 123,
-            pathName: "test.txt",
-            rule: getTestRule(),
-            severity: "error",
-            source: "test"
-        }));
-
-
-        expect(result).toBe(expected);
-    });
-});
-
-function getTestRule() {
-    return new ResourceMatcher({
-        "name": "testRule",
-        "description": "Rule for testing purposes",
-        "regexps": ["test"],
-        "note": "test",
-        "sourceLocale": "en-US",
-        "link": ""
-    });
-}