npm - ilib-lint - Versions diffs - 2.2.0 → 2.3.0 - Mend

ilib-lint 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (97) hide show

package/docs/AnsiConsoleFormatter.html +2 -2
package/docs/BuiltinPlugin.html +2 -2
package/docs/ConfigBasedFormatter.html +2 -2
package/docs/ConfigurationProvider.html +3 -3
package/docs/ConfigurationProvider_loadConfiguration.html +3 -3
package/docs/DeclarativeResourceRule.html +2 -2
package/docs/DirItem.html +2 -2
package/docs/DirItem.js.html +2 -2
package/docs/FileConfigurationProvider.html +5 -5
package/docs/FileConfigurationProvider_loadConfiguration.html +3 -3
package/docs/FileType.html +181 -5
package/docs/FileType.js.html +48 -5
package/docs/FixerManager.html +2 -2
package/docs/FixerManager.js.html +4 -4
package/docs/FolderConfigurationProvider.html +4 -4
package/docs/FolderConfigurationProvider_loadConfiguration.html +3 -3
package/docs/FormatterManager.html +2 -2
package/docs/FormatterManager.js.html +5 -5
package/docs/LineParser.html +78 -4
package/docs/LineRegexpChecker.html +2 -2
package/docs/LintableFile.html +1099 -0
package/docs/LintableFile.js.html +330 -0
package/docs/ParserManager.html +167 -5
package/docs/ParserManager.js.html +17 -5
package/docs/PluginManager.html +10 -10
package/docs/PluginManager.js.html +120 -92
package/docs/Project.html +24 -24
package/docs/Project.js.html +125 -88
package/docs/ReleaseNotes.md +17 -0
package/docs/ResourceCompleteness.html +2 -2
package/docs/ResourceDNTTerms.html +10 -10
package/docs/ResourceEdgeWhitespace.html +2 -2
package/docs/ResourceICUPluralTranslation.html +2 -2
package/docs/ResourceICUPlurals.html +2 -2
package/docs/ResourceMatcher.html +2 -2
package/docs/ResourceNoTranslation.html +2 -2
package/docs/ResourceQuoteStyle.html +342 -6
package/docs/ResourceRule.html +2 -2
package/docs/ResourceSourceChecker.html +2 -2
package/docs/ResourceSourceICUPluralCategories.html +2 -2
package/docs/ResourceSourceICUPluralParams.html +2 -2
package/docs/ResourceSourceICUPluralSyntax.html +2 -2
package/docs/ResourceSourceICUUnexplainedParams.html +2 -2
package/docs/ResourceStateChecker.html +2 -2
package/docs/ResourceTargetChecker.html +2 -2
package/docs/ResourceUniqueKeys.html +4 -4
package/docs/ResultComparator.js.html +2 -2
package/docs/RuleManager.html +2 -2
package/docs/RuleManager.js.html +4 -4
package/docs/RuleSet.html +142 -5
package/docs/RuleSet.js.html +13 -2
package/docs/SourceRegexpChecker.html +2 -2
package/docs/StringFixCommand_StringFixCommand.html +2 -2
package/docs/StringParser.html +4 -4
package/docs/XliffParser.html +79 -5
package/docs/config_Configuration.js.html +21 -3
package/docs/config_ConfigurationProvider.js.html +21 -3
package/docs/config_default.js.html +21 -3
package/docs/formatters_AnsiConsoleFormatter.js.html +4 -4
package/docs/formatters_ConfigBasedFormatter.js.html +4 -4
package/docs/global.html +1090 -143
package/docs/ilibLint.md +0 -0
package/docs/index.html +2 -2
package/docs/plugins_BuiltinPlugin.js.html +5 -5
package/docs/plugins_LineParser.js.html +10 -10
package/docs/plugins_XliffParser.js.html +18 -17
package/docs/plugins_string_StringFix.js.html +4 -4
package/docs/plugins_string_StringFixCommand.js.html +2 -2
package/docs/plugins_string_StringFixer.js.html +4 -4
package/docs/plugins_string_StringParser.js.html +8 -9
package/docs/resource-xml.md +58 -0
package/docs/rules_DeclarativeResourceRule.js.html +2 -2
package/docs/rules_LineRegexpChecker.js.html +5 -5
package/docs/rules_ResourceCompleteness.js.html +4 -4
package/docs/rules_ResourceDNTTerms.js.html +4 -5
package/docs/rules_ResourceEdgeWhitespace.js.html +4 -4
package/docs/rules_ResourceICUPluralTranslation.js.html +4 -4
package/docs/rules_ResourceICUPlurals.js.html +3 -3
package/docs/rules_ResourceMatcher.js.html +3 -3
package/docs/rules_ResourceNoTranslation.js.html +4 -4
package/docs/rules_ResourceQuoteStyle.js.html +227 -122
package/docs/rules_ResourceRule.js.html +4 -4
package/docs/rules_ResourceSourceChecker.js.html +4 -4
package/docs/rules_ResourceSourceICUPluralCategories.js.html +4 -4
package/docs/rules_ResourceSourceICUPluralParams.js.html +4 -4
package/docs/rules_ResourceSourceICUPluralSyntax.js.html +4 -4
package/docs/rules_ResourceSourceICUUnexplainedParams.js.html +4 -4
package/docs/rules_ResourceStateChecker.js.html +4 -4
package/docs/rules_ResourceTargetChecker.js.html +4 -4
package/docs/rules_ResourceUniqueKeys.js.html +4 -5
package/docs/rules_SourceRegexpChecker.js.html +5 -5
package/docs/rules_utils.js.html +2 -2
package/package.json +13 -12
package/src/LintableFile.js +7 -1
package/src/formatters/AnsiConsoleFormatter.js +2 -1
package/src/plugins/BuiltinPlugin.js +4 -1
package/src/rules/ResourceXML.js +244 -0

package/docs/LintableFile.js.html ADDED Viewed

@@ -0,0 +1,330 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>LintableFile.js - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav >
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnsiConsoleFormatter.html">AnsiConsoleFormatter</a><ul class='methods'><li data-type='method'><a href="AnsiConsoleFormatter.html#format">format</a></li></ul></li><li><a href="BuiltinPlugin.html">BuiltinPlugin</a><ul class='methods'><li data-type='method'><a href="BuiltinPlugin.html#getFormatters">getFormatters</a></li><li data-type='method'><a href="BuiltinPlugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="BuiltinPlugin.html#getRuleSets">getRuleSets</a></li><li data-type='method'><a href="BuiltinPlugin.html#getRules">getRules</a></li></ul></li><li><a href="ConfigBasedFormatter.html">ConfigBasedFormatter</a><ul class='methods'><li data-type='method'><a href="ConfigBasedFormatter.html#format">format</a></li></ul></li><li><a href="DeclarativeResourceRule.html">DeclarativeResourceRule</a><ul class='methods'><li data-type='method'><a href="DeclarativeResourceRule.html#checkString">checkString</a></li><li data-type='method'><a href="DeclarativeResourceRule.html#matchString">matchString</a></li></ul></li><li><a href="DirItem.html">DirItem</a><ul class='methods'><li data-type='method'><a href="DirItem.html#findIssues">findIssues</a></li><li data-type='method'><a href="DirItem.html#getFilePath">getFilePath</a></li><li data-type='method'><a href="DirItem.html#parse">parse</a></li></ul></li><li><a href="FileConfigurationProvider.html">FileConfigurationProvider</a><ul class='methods'><li data-type='method'><a href="FileConfigurationProvider.html#loadJsConfiguration">loadJsConfiguration</a></li><li data-type='method'><a href="FileConfigurationProvider.html#loadJsonConfiguration">loadJsonConfiguration</a></li></ul></li><li><a href="FileType.html">FileType</a><ul class='methods'><li data-type='method'><a href="FileType.html#getParserClasses">getParserClasses</a></li><li data-type='method'><a href="FileType.html#getRuleSetNames">getRuleSetNames</a></li><li data-type='method'><a href="FileType.html#getRules">getRules</a></li></ul></li><li><a href="FixerManager.html">FixerManager</a><ul class='methods'><li data-type='method'><a href="FixerManager.html#add">add</a></li><li data-type='method'><a href="FixerManager.html#get">get</a></li><li data-type='method'><a href="FixerManager.html#size">size</a></li></ul></li><li><a href="FolderConfigurationProvider.html">FolderConfigurationProvider</a><ul class='methods'><li data-type='method'><a href="FolderConfigurationProvider.html#hasConfigurationFile">hasConfigurationFile</a></li></ul></li><li><a href="FormatterManager.html">FormatterManager</a><ul class='methods'><li data-type='method'><a href="FormatterManager.html#add">add</a></li><li data-type='method'><a href="FormatterManager.html#get">get</a></li><li data-type='method'><a href="FormatterManager.html#getDescriptions">getDescriptions</a></li><li data-type='method'><a href="FormatterManager.html#size">size</a></li></ul></li><li><a href="LineParser.html">LineParser</a><ul class='methods'><li data-type='method'><a href="LineParser.html#parse">parse</a></li></ul></li><li><a href="LineRegexpChecker.html">LineRegexpChecker</a><ul class='methods'><li data-type='method'><a href="LineRegexpChecker.html#match">match</a></li></ul></li><li><a href="LintableFile.html">LintableFile</a><ul class='methods'><li data-type='method'><a href="LintableFile.html#findIssues">findIssues</a></li><li data-type='method'><a href="LintableFile.html#getIRs">getIRs</a></li><li data-type='method'><a href="LintableFile.html#getLocaleFromPath">getLocaleFromPath</a></li><li data-type='method'><a href="LintableFile.html#getStats">getStats</a></li><li data-type='method'><a href="LintableFile.html#parse">parse</a></li></ul></li><li><a href="ParserManager.html">ParserManager</a><ul class='methods'><li data-type='method'><a href="ParserManager.html#add">add</a></li><li data-type='method'><a href="ParserManager.html#get">get</a></li><li data-type='method'><a href="ParserManager.html#getByName">getByName</a></li><li data-type='method'><a href="ParserManager.html#getDescriptions">getDescriptions</a></li></ul></li><li><a href="PluginManager.html">PluginManager</a><ul class='methods'><li data-type='method'><a href="PluginManager.html#add">add</a></li><li data-type='method'><a href="PluginManager.html#getFixerManager">getFixerManager</a></li><li data-type='method'><a href="PluginManager.html#getFormatterManager">getFormatterManager</a></li><li data-type='method'><a href="PluginManager.html#getParserManager">getParserManager</a></li><li data-type='method'><a href="PluginManager.html#getRuleManager">getRuleManager</a></li><li data-type='method'><a href="PluginManager.html#getRuleSet">getRuleSet</a></li><li data-type='method'><a href="PluginManager.html#load">load</a></li></ul></li><li><a href="Project.html">Project</a><ul class='methods'><li data-type='method'><a href="Project.html#add">add</a></li><li data-type='method'><a href="Project.html#findIssues">findIssues</a></li><li data-type='method'><a href="Project.html#get">get</a></li><li data-type='method'><a href="Project.html#getExcludes">getExcludes</a></li><li data-type='method'><a href="Project.html#getFileType">getFileType</a></li><li data-type='method'><a href="Project.html#getFileTypeForPath">getFileTypeForPath</a></li><li data-type='method'><a href="Project.html#getFixerManager">getFixerManager</a></li><li data-type='method'><a href="Project.html#getIncludes">getIncludes</a></li><li data-type='method'><a href="Project.html#getLocales">getLocales</a></li><li data-type='method'><a href="Project.html#getName">getName</a></li><li data-type='method'><a href="Project.html#getOptions">getOptions</a></li><li data-type='method'><a href="Project.html#getParserManager">getParserManager</a></li><li data-type='method'><a href="Project.html#getPluginManager">getPluginManager</a></li><li data-type='method'><a href="Project.html#getRoot">getRoot</a></li><li data-type='method'><a href="Project.html#getRuleManager">getRuleManager</a></li><li data-type='method'><a href="Project.html#getScore">getScore</a></li><li data-type='method'><a href="Project.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Project.html#init">init</a></li><li data-type='method'><a href="Project.html#run">run</a></li><li data-type='method'><a href="Project.html#scan">scan</a></li></ul></li><li><a href="ResourceCompleteness.html">ResourceCompleteness</a><ul class='methods'><li data-type='method'><a href="ResourceCompleteness.html#matchString">matchString</a></li></ul></li><li><a href="ResourceDNTTerms.html">ResourceDNTTerms</a><ul class='methods'><li data-type='method'><a href="ResourceDNTTerms.html#matchString">matchString</a></li><li data-type='method'><a href="ResourceDNTTerms.html#.parseTermsFromJsonFile">parseTermsFromJsonFile</a></li><li data-type='method'><a href="ResourceDNTTerms.html#.parseTermsFromTxtFile">parseTermsFromTxtFile</a></li></ul></li><li><a href="ResourceEdgeWhitespace.html">ResourceEdgeWhitespace</a><ul class='methods'><li data-type='method'><a href="ResourceEdgeWhitespace.html#matchString">matchString</a></li></ul></li><li><a href="ResourceICUPluralTranslation.html">ResourceICUPluralTranslation</a><ul class='methods'><li data-type='method'><a href="ResourceICUPluralTranslation.html#matchString">matchString</a></li></ul></li><li><a href="ResourceICUPlurals.html">ResourceICUPlurals</a></li><li><a href="ResourceMatcher.html">ResourceMatcher</a><ul class='methods'><li data-type='method'><a href="ResourceMatcher.html#checkString">checkString</a></li></ul></li><li><a href="ResourceNoTranslation.html">ResourceNoTranslation</a><ul class='methods'><li data-type='method'><a href="ResourceNoTranslation.html#matchString">matchString</a></li></ul></li><li><a href="ResourceQuoteStyle.html">ResourceQuoteStyle</a><ul class='methods'><li data-type='method'><a href="ResourceQuoteStyle.html#matchString">matchString</a></li></ul></li><li><a href="ResourceRule.html">ResourceRule</a><ul class='methods'><li data-type='method'><a href="ResourceRule.html#getRuleType">getRuleType</a></li><li data-type='method'><a href="ResourceRule.html#match">match</a></li><li data-type='method'><a href="ResourceRule.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceChecker.html">ResourceSourceChecker</a><ul class='methods'><li data-type='method'><a href="ResourceSourceChecker.html#checkString">checkString</a></li></ul></li><li><a href="ResourceSourceICUPluralCategories.html">ResourceSourceICUPluralCategories</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralCategories.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUPluralParams.html">ResourceSourceICUPluralParams</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralParams.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUPluralSyntax.html">ResourceSourceICUPluralSyntax</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUPluralSyntax.html#matchString">matchString</a></li></ul></li><li><a href="ResourceSourceICUUnexplainedParams.html">ResourceSourceICUUnexplainedParams</a><ul class='methods'><li data-type='method'><a href="ResourceSourceICUUnexplainedParams.html#matchString">matchString</a></li></ul></li><li><a href="ResourceStateChecker.html">ResourceStateChecker</a><ul class='methods'><li data-type='method'><a href="ResourceStateChecker.html#match">match</a></li></ul></li><li><a href="ResourceTargetChecker.html">ResourceTargetChecker</a><ul class='methods'><li data-type='method'><a href="ResourceTargetChecker.html#checkString">checkString</a></li></ul></li><li><a href="ResourceUniqueKeys.html">ResourceUniqueKeys</a><ul class='methods'><li data-type='method'><a href="ResourceUniqueKeys.html#match">match</a></li></ul></li><li><a href="RuleManager.html">RuleManager</a><ul class='methods'><li data-type='method'><a href="RuleManager.html#add">add</a></li><li data-type='method'><a href="RuleManager.html#addRuleSetDefinition">addRuleSetDefinition</a></li><li data-type='method'><a href="RuleManager.html#addRuleSetDefinitions">addRuleSetDefinitions</a></li><li data-type='method'><a href="RuleManager.html#get">get</a></li><li data-type='method'><a href="RuleManager.html#getDescriptions">getDescriptions</a></li><li data-type='method'><a href="RuleManager.html#getRuleSetDefinition">getRuleSetDefinition</a></li><li data-type='method'><a href="RuleManager.html#getRuleSetDefinitions">getRuleSetDefinitions</a></li><li data-type='method'><a href="RuleManager.html#getRules">getRules</a></li><li data-type='method'><a href="RuleManager.html#size">size</a></li><li data-type='method'><a href="RuleManager.html#sizeRuleSetDefinitions">sizeRuleSetDefinitions</a></li></ul></li><li><a href="RuleSet.html">RuleSet</a><ul class='methods'><li data-type='method'><a href="RuleSet.html#add">add</a></li><li data-type='method'><a href="RuleSet.html#addRule">addRule</a></li><li data-type='method'><a href="RuleSet.html#getRule">getRule</a></li><li data-type='method'><a href="RuleSet.html#getRules">getRules</a></li><li data-type='method'><a href="RuleSet.html#getSize">getSize</a></li><li data-type='method'><a href="RuleSet.html#removeRule">removeRule</a></li></ul></li><li><a href="SourceRegexpChecker.html">SourceRegexpChecker</a><ul class='methods'><li data-type='method'><a href="SourceRegexpChecker.html#match">match</a></li></ul></li><li><a href="StringFixCommand_StringFixCommand.html">StringFixCommand</a></li><li><a href="StringParser.html">StringParser</a><ul class='methods'><li data-type='method'><a href="StringParser.html#parse">parse</a></li><li data-type='method'><a href="StringParser.html#write">write</a></li></ul></li><li><a href="XliffParser.html">XliffParser</a><ul class='methods'><li data-type='method'><a href="XliffParser.html#parse">parse</a></li></ul></li></ul><h3>Interfaces</h3><ul><li><a href="ConfigurationProvider.html">ConfigurationProvider</a></li><li><a href="ConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li><li><a href="FileConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li><li><a href="FolderConfigurationProvider_loadConfiguration.html">loadConfiguration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DeclarativeRuleTypes">DeclarativeRuleTypes</a></li><li><a href="global.html#ResultComparator">ResultComparator</a></li><li><a href="global.html#concatIntlAstText">concatIntlAstText</a></li><li><a href="global.html#defaultConfiguration">defaultConfiguration</a></li><li><a href="global.html#severity">severity</a></li><li><a href="global.html#typeMap">typeMap</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">LintableFile.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * LintableFile.js - Represent a lintable source file
+ *
+ * Copyright © 2022-2024 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 path from "node:path";
+import log4js from "log4js";
+import { getLocaleFromPath } from "ilib-tools-common";
+import { Fix, IntermediateRepresentation, Parser, Result, SourceFile, FileStats } from "ilib-lint-common";
+import DirItem from "./DirItem.js";
+import Project from "./Project.js";
+import FileType from "./FileType.js";
+const logger = log4js.getLogger("ilib-lint.root.LintableFile");
+/**
+ * @class Represent a source file
+ */
+class LintableFile extends DirItem {
+    /**
+     * Construct a source file instance
+     * The options parameter can contain any of the following properties:
+     *
+     *
+     * @constructor
+     * @param {String} filePath path to the source file
+     * @param {Object} options options for constructing this source file
+     * @param {FileType} options.filetype file type of this source file
+     * @param {String} options.filePath path to the file
+     * @param {object} [options.settings] additional settings from the ilib-lint config that apply to this file
+     * @param {Project} project the project where this file is located
+     */
+    constructor(filePath, options, project) {
+        super(filePath, options, project);
+        if (!options || !filePath || !options.filetype) {
+            throw "Incorrect options given to LintableFile constructor";
+        }
+        this.sourceFile = new SourceFile(filePath, {
+            sourceLocale: options.locale,
+            getLogger: log4js.getLogger.bind(log4js),
+            type: options.filetype.getName()
+        });
+        this.filetype = options.filetype;
+        if (this.project.options.opt?.verbose) {
+            logger.level = "debug";
+        }
+        this.parsers = [];
+        let extension = path.extname(filePath);
+        if (extension) {
+            // remove the dot
+            extension = extension.substring(1);
+            this.parsers = this.filetype.getParserClasses(extension);
+        }
+    }
+    /**
+     * Return the locale gleaned from the file path using the template in
+     * the settings, or undefined if no locale could be found.
+     *
+     * @returns {String} the locale gleaned from the path, or the empty
+     * string if no locale could be found.
+     */
+    getLocaleFromPath() {
+        if (this.settings?.template) {
+            return getLocaleFromPath(this.settings.template, this.sourceFile.getPath());
+        }
+        return "";
+    }
+    /**
+     * Parse the current source file into a list of Intermediate Representaitons
+     * @returns {Array.&lt;IntermediateRepresentation>} the parsed representations
+     * of this file
+     */
+    parse() {
+        if (!this.filePath) return [];
+        const irs = this.parsers.flatMap(parser => {
+            try {
+                return parser.parse(this.sourceFile);
+            } catch (e) {
+                logger.trace(`Parser ${parser.getName()} could not parse file ${this.sourceFile.getPath()}`);
+                logger.trace(e);
+            }
+        });
+        if (!irs || irs.length === 0) {
+            throw new Error(`All available parsers failed to parse file ${file.sourceFile.getPath()}. Try configuring another parser or excluding this file from the lint project.`);
+        }
+        return irs;
+    }
+    /**
+     * Check the current file and return a list of issues found in this file.
+     * This method parses the source file and applies each rule in turn
+     * using the given locales. Optionally, it also applies the available auto-fixes
+     * and overwrites the underlying file depending if it's enabled in the project config options.
+     *
+     * @param {Array.&lt;string>} locales a set of locales to apply
+     * @returns {Array.&lt;Result>} a list of natch results
+     */
+    findIssues(locales) {
+        const detectedLocale = this.getLocaleFromPath();
+        if (detectedLocale &amp;&amp; !locales.includes(detectedLocale)) {
+            // not one of the locales we need to check
+            return [];
+        }
+        if (!this.filePath) return [];
+        /**
+         * @type {IntermediateRepresentation[]}
+         */
+        this.irs = [];
+        const results = this.parsers.flatMap((parser) => {
+            const /** @type {Result[]} */ fixedResults = [];
+            let /** @type {Result[]} */ currentParseResults = [];
+            try {
+                let didWrite = false;
+                let irs;
+                do {
+                    irs = parser.parse(this.sourceFile);
+                    // indicate that for current intermediate representations, parser did not write out modified representations yet
+                    didWrite = false;
+                    // clear the results of the current parse, because the file had been overwritten
+                    // (so the results don't match the file anymore)
+                    currentParseResults = [];
+                    for (const ir of irs) {
+                        // find the rules that are appropriate for this intermediate representation and then apply them
+                        const rules = this.filetype.getRules().filter((rule) => rule.getRuleType() === ir.getType());
+                        rules.forEach(ru => {
+                            logger.debug('Checking rule  : ' + ru.name);
+                        });
+                        logger.debug('');
+                        // apply rules
+                        const results = rules.flatMap(
+                            (rule) =>
+                                rule.match({
+                                    ir,
+                                    locale: detectedLocale || this.project.getSourceLocale(),
+                                    file: this.filePath,
+                                }) ?? []
+                        ).filter(result => result);
+                        const fixable = results.filter((result) => result?.fix !== undefined);
+                        let fixer;
+                        if (
+                            // ensure that autofixing is enabled
+                            true === this.project.getConfig().autofix &amp;&amp;
+                            // and that any fixable results were produced
+                            fixable.length > 0 &amp;&amp;
+                            // and that the current parser is able to write
+                            parser.canWrite &amp;&amp;
+                            // and that the fixer for this type of IR is avaliable
+                            (fixer = this.project.getFixerManager().get(ir.getType()))
+                        ) {
+                            // attempt to apply fixes to the current IR
+                            const fixes = /** @type {Fix[]} */ (fixable.map((result) => result.fix));
+                            fixer.applyFixes(ir, fixes);
+                            // check if anything had been applied
+                            if (fixes.some((fix) => fix.applied)) {
+                                // fixer should modify the provided IR
+                                // so tell current parser to write out the modified representation
+                                parser.write(ir);
+                                // after writing out the fixed content, we want to reparse to see if any new issues appeared,
+                                // while preserving the results that have been fixed so far;
+                                // fixer should have set the `applied` flag of each applied Fix
+                                // so accumulate the corresponding results
+                                fixedResults.push(...results.filter((result) => result.fix?.applied));
+                                // indicate that the content has been modified and the re-parsing should occur
+                                didWrite = true;
+                                // don't process subsequent representations after modifying the file
+                                // because they don't match the new file
+                                break;
+                            }
+                        }
+                        // otherwise, just accumulate the results of the current parse for each IRs
+                        currentParseResults.push(...results);
+                    }
+                    // if a write had occurred for a given parser, reparse
+                } while (didWrite);
+                this.irs = this.irs.concat(irs);
+            } catch (e) {
+                if (this.parsers.length === 1) {
+                    // if this is the only parser for this file, throw an exception right away so the user
+                    // can see what the specific parse error was from the parser
+                    throw new Error(`Could not parse file ${this.sourceFile.getPath()}. Try configuring another parser or excluding this file from the lint project.`, {
+                        cause: e
+                    });
+                }
+                logger.trace(`Parser ${parser.getName()} could not parse file ${this.sourceFile.getPath()}`);
+                logger.trace(e);
+            }
+            // once all intermediate representations have been processed for the given parser
+            // without any writes, finally return all of the results accumulated during auto-fixing
+            // and the remaining ones that were produced
+            return [...fixedResults, ...currentParseResults];
+        });
+        if (this.irs.length === 0) {
+            throw new Error(`All available parsers failed to parse file ${this.sourceFile.getPath()}. Try configuring another parser or excluding this file from the lint project.`);
+        }
+        return results;
+    }
+    /**
+     * Get the intermediate representations of this file.
+     * @returns {Array.&lt;IntermediateRepresentation>} the intermediate representations
+     * of this file
+     */
+    getIRs() {
+        return this.irs;
+    }
+    /**
+     * Return the stats for the file after issues were found.
+     * @returns {FileStats} the stats for the current file
+     */
+    getStats() {
+        const fileStats = new FileStats();
+        if (this.irs) {
+            this.irs.forEach(ir => {
+                if (ir.stats) {
+                    fileStats.addStats(ir.stats);
+                }
+            });
+        }
+        return fileStats;
+    }
+}
+export default LintableFile;
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Jul 09 2024 11:26:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>