npm - ilib-lint - Versions diffs - 1.0.0 - Mend

ilib-lint 1.0.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 (89) hide show

package/LICENSE +201 -0
package/README.md +231 -0
package/docs/AnsiConsoleFormatter.html +467 -0
package/docs/Formatter.html +577 -0
package/docs/Formatter.js.html +135 -0
package/docs/FormatterFactory.html +191 -0
package/docs/FormatterFactory.js.html +109 -0
package/docs/Parser.html +483 -0
package/docs/Parser.js.html +122 -0
package/docs/ParserFactory.js.html +109 -0
package/docs/Plugin.html +847 -0
package/docs/Plugin.js.html +168 -0
package/docs/PluginManager.html +541 -0
package/docs/PluginManager.js.html +125 -0
package/docs/ResourceICUPlurals.html +278 -0
package/docs/ResourceQuoteStyle.html +278 -0
package/docs/ResourceRegExpChecker.html +295 -0
package/docs/ResourceUniqueKeys.html +278 -0
package/docs/Result.html +263 -0
package/docs/Result.js.html +130 -0
package/docs/Rule.html +774 -0
package/docs/Rule.js.html +230 -0
package/docs/RuleSet.html +760 -0
package/docs/RuleSet.js.html +153 -0
package/docs/SourceFile.html +826 -0
package/docs/SourceFile.js.html +232 -0
package/docs/XliffParser.html +396 -0
package/docs/XliffPlugin.html +472 -0
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/formatters_AnsiConsoleFormatter.js.html +147 -0
package/docs/global.html +448 -0
package/docs/ilibLint.md +1013 -0
package/docs/index.html +81 -0
package/docs/plugins_XliffParser.js.html +129 -0
package/docs/plugins_XliffPlugin.js.html +129 -0
package/docs/rules_ResourceICUPlurals.js.html +297 -0
package/docs/rules_ResourceQuoteStyle.js.html +238 -0
package/docs/rules_ResourceRegExpChecker.js.html +248 -0
package/docs/rules_ResourceUniqueKeys.js.html +144 -0
package/docs/scripts/collapse.js +20 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/nav.js +12 -0
package/docs/scripts/polyfill.js +4 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/scripts/search.js +83 -0
package/docs/styles/jsdoc.css +765 -0
package/docs/styles/prettify.css +79 -0
package/docs/walk.js.html +214 -0
package/log4js.json +21 -0
package/package.json +83 -0
package/src/Formatter.js +66 -0
package/src/FormatterFactory.js +41 -0
package/src/Parser.js +53 -0
package/src/ParserFactory.js +41 -0
package/src/Plugin.js +99 -0
package/src/PluginManager.js +56 -0
package/src/Result.js +62 -0
package/src/Rule.js +162 -0
package/src/RuleSet.js +84 -0
package/src/SourceFile.js +163 -0
package/src/formatters/AnsiConsoleFormatter.js +78 -0
package/src/index.js +213 -0
package/src/plugins/XliffParser.js +60 -0
package/src/plugins/XliffPlugin.js +60 -0
package/src/rules/ResourceICUPlurals.js +229 -0
package/src/rules/ResourceQuoteStyle.js +170 -0
package/src/rules/ResourceRegExpChecker.js +179 -0
package/src/rules/ResourceUniqueKeys.js +76 -0
package/src/rules/utils.js +78 -0
package/src/walk.js +146 -0

package/docs/rules_ResourceICUPlurals.js.html ADDED Viewed

@@ -0,0 +1,297 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>rules/ResourceICUPlurals.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><li data-type='method'><a href="AnsiConsoleFormatter.html#getDescription">getDescription</a></li></ul></li><li><a href="Formatter.html">Formatter</a><ul class='methods'><li data-type='method'><a href="Formatter.html#format">format</a></li><li data-type='method'><a href="Formatter.html#getDescription">getDescription</a></li><li data-type='method'><a href="Formatter.html#getName">getName</a></li></ul></li><li><a href="FormatterFactory.html">FormatterFactory</a></li><li><a href="Parser.html">Parser</a><ul class='methods'><li data-type='method'><a href="Parser.html#getResources">getResources</a></li><li data-type='method'><a href="Parser.html#init">init</a></li><li data-type='method'><a href="Parser.html#parse">parse</a></li></ul></li><li><a href="Plugin.html">Plugin</a><ul class='methods'><li data-type='method'><a href="Plugin.html#getExtensions">getExtensions</a></li><li data-type='method'><a href="Plugin.html#getFormatters">getFormatters</a></li><li data-type='method'><a href="Plugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="Plugin.html#getRules">getRules</a></li><li data-type='method'><a href="Plugin.html#getType">getType</a></li><li data-type='method'><a href="Plugin.html#init">init</a></li></ul></li><li><a href="PluginManager.html">PluginManager</a><ul class='methods'><li data-type='method'><a href="PluginManager.html#getHandlers">getHandlers</a></li><li data-type='method'><a href="PluginManager.html#load">load</a></li></ul></li><li><a href="ResourceICUPlurals.html">ResourceICUPlurals</a><ul class='methods'><li data-type='method'><a href="ResourceICUPlurals.html#match">match</a></li></ul></li><li><a href="ResourceQuoteStyle.html">ResourceQuoteStyle</a><ul class='methods'><li data-type='method'><a href="ResourceQuoteStyle.html#match">match</a></li></ul></li><li><a href="ResourceRegExpChecker.html">ResourceRegExpChecker</a><ul class='methods'><li data-type='method'><a href="ResourceRegExpChecker.html#match">match</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="Result.html">Result</a></li><li><a href="Rule.html">Rule</a><ul class='methods'><li data-type='method'><a href="Rule.html#getDescription">getDescription</a></li><li data-type='method'><a href="Rule.html#getName">getName</a></li><li data-type='method'><a href="Rule.html#getRuleType">getRuleType</a></li><li data-type='method'><a href="Rule.html#match">match</a></li></ul></li><li><a href="RuleSet.html">RuleSet</a><ul class='methods'><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></ul></li><li><a href="SourceFile.html">SourceFile</a><ul class='methods'><li data-type='method'><a href="SourceFile.html#findIssues">findIssues</a></li><li data-type='method'><a href="SourceFile.html#getFilePath">getFilePath</a></li><li data-type='method'><a href="SourceFile.html#getLocaleFromPath">getLocaleFromPath</a></li><li data-type='method'><a href="SourceFile.html#getType">getType</a></li><li data-type='method'><a href="SourceFile.html#parse">parse</a></li></ul></li><li><a href="XliffParser.html">XliffParser</a><ul class='methods'><li data-type='method'><a href="XliffParser.html#getResources">getResources</a></li><li data-type='method'><a href="XliffParser.html#parse">parse</a></li></ul></li><li><a href="XliffPlugin.html">XliffPlugin</a><ul class='methods'><li data-type='method'><a href="XliffPlugin.html#getExtensions">getExtensions</a></li><li data-type='method'><a href="XliffPlugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="XliffPlugin.html#getType">getType</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#ParserFactory">ParserFactory</a></li><li><a href="global.html#walk">walk</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">rules/ResourceICUPlurals.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * ResourceICUPlurals.js - rule to check formatjs/ICU style plurals in the target string
+ *
+ * Copyright © 2022 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 { IntlMessageFormat } from 'intl-messageformat';
+import Locale from 'ilib-locale';
+import Rule from '../Rule.js';
+import Result from '../Result.js';
+// all the plural categories from CLDR
+const allCategories = ["zero", "one", "two", "few", "many", "other"];
+// Map the language to the set of plural categories that the language
+// uses. If the language is not listed below, it uses the default
+// list of plurals: "one" and "other"
+const categoriesForLang = {
+    "ja": [ "other" ],
+    "zh": [ "other" ],
+    "ko": [ "other" ],
+    "th": [ "other" ],
+    "lv": [ "zero", "one", "other" ],
+    "ga": [ "one", "two", "other" ],
+    "ro": [ "one", "few", "other" ],
+    "lt": [ "one", "few", "other" ],
+    "ru": [ "one", "few", "other" ],
+    "uk": [ "one", "few", "other" ],
+    "be": [ "one", "few", "other" ],
+    "sr": [ "one", "few", "other" ],
+    "hr": [ "one", "few", "other" ],
+    "cs": [ "one", "few", "other" ],
+    "sk": [ "one", "few", "other" ],
+    "pl": [ "one", "few", "other" ],
+    "sl": [ "one", "two", "few", "other" ],
+    "ar": [ "zero", "one", "two", "few", "many", "other" ]
+}
+/**
+ * @class Represent an ilib-lint rule.
+ */
+class ResourceICUPlurals extends Rule {
+    constructor(options) {
+        super(options);
+        this.name = "resource-icu-plurals";
+        this.description = "Ensure that plurals in translated resources have the correct syntax";
+        this.sourceLocale = (options &amp;&amp; options.sourceLocale) || "en-US";
+    }
+    getRuleType() {
+        return "resource";
+    }
+    /**
+     * @private
+     */
+    checkPluralCategories(ast, neededCategories, isSource, stringToCheck, key, pathName, source) {
+        let value = [];
+        for (let i = 0; i &lt; ast.length; i++) {
+            const opts = ast[i].options;
+            if (opts) {
+                // check if any of the needed categories are missing
+                const missing = neededCategories.filter(category => {
+                    return typeof(opts[category]) === 'undefined';
+                });
+                if ( missing &amp;&amp; missing.length ) {
+                    let opts = {
+                        severity: "error",
+                        rule: this,
+                        description: `Missing plural categories in ${isSource ? "source" : "target"} string: ${missing.join(", ")}. Expecting these: ${neededCategories.join(", ")}`,
+                        id: key,
+                        highlight: `${isSource ? "Source" : "Target"}: ${stringToCheck}&lt;e0>&lt;/e0>`,
+                        pathName,
+                        source
+                    };
+                    value.push(new Result(opts));
+                }
+                for (let category in opts) {
+                    if ( opts[category] &amp;&amp; Array.isArray(opts[category].value) ) {
+                        value = value.concat(this.checkPluralCategories(opts[category].value, neededCategories, isSource, stringToCheck, key, pathName, source));
+                    }
+                }
+                // now check the other way around. That is, if the categories that exist are not needed.
+                if (!isSource) {
+                    const extras = Object.keys(opts).filter(category => {
+                        return neededCategories.indexOf(category) &lt; 0;
+                    });
+                    if (extras &amp;&amp; extras.length) {
+                        let opts = {
+                            severity: "warning",
+                            rule: this,
+                            description: `Extra plural categories in ${isSource ? "source" : "target"} string: ${extras.join(", ")}. Expecting only these: ${neededCategories.join(", ")}`,
+                            id: key,
+                            highlight: `${isSource ? "Source" : "Target"}: ${stringToCheck}&lt;e0>&lt;/e0>`,
+                            pathName,
+                            source
+                        };
+                        value.push(new Result(opts));
+                    }
+                }
+            }
+        }
+        return value;
+    }
+    checkString(src, tar, file, resource, sourceLocale, targetLocale, lineNumber) {
+        const sLoc = new Locale(sourceLocale);
+        const tLoc = new Locale(targetLocale);
+        let results;
+        let problems = [];
+        let sourceCategories = [];
+        try {
+            const imf = new IntlMessageFormat(src, sourceLocale);
+            let categories = categoriesForLang[sLoc.getLanguage()] || [ "one", "other" ];
+            // look in the abstract syntax tree for the categories that were parsed out and make
+            // sure the required ones are there
+            const ast = imf.getAst();
+            problems = problems.concat(this.checkPluralCategories(ast, categories, true, src, resource.getKey(), file, resource.getSource()));
+            if ( ast[0] &amp;&amp; ast[0].options ) {
+                sourceCategories = Object.keys(ast[0].options).filter(category => {
+                    // if it is not one of the standard categories, it is a special one, so search for it
+                    // in the target too
+                    return allCategories.indexOf(category) &lt; 0;
+                });
+            }
+        } catch (e) {
+            let value = {
+                pathName: file,
+                severity: "error",
+                rule: this,
+                description: `Incorrect plural or select syntax in source string: ${e}`,
+                id: resource.getKey(),
+                highlight: `Source: ${src.substring(0, e.location.end.offset)}&lt;e0>${src.substring(e.location.end.offset)}&lt;/e0>`,
+                pathName: file
+            };
+            if (typeof(lineNumber) !== 'undefined') {
+                value.lineNumber = lineNumber + e.location.end.line - 1;
+            }
+            problems.push(new Result(value));
+        }
+        try {
+            const imf = new IntlMessageFormat(tar, targetLocale);
+            let categories = categoriesForLang[tLoc.getLanguage()] || [ "one", "other" ];
+            if (sourceCategories.length) {
+                categories = categories.concat(sourceCategories);
+            }
+            // look in the abstract syntax tree for the categories that were parsed out and make
+            // sure the required ones are there
+            const ast = imf.getAst();
+            problems = problems.concat(this.checkPluralCategories(ast, categories, false, tar, resource.getKey(), file, resource.getSource()));
+        } catch (e) {
+            let value = {
+                severity: "error",
+                description: `Incorrect plural or select syntax in target string: ${e}`,
+                rule: this,
+                id: resource.getKey(),
+                source: src,
+                highlight: `Target: ${tar.substring(0, e.location.end.offset)}&lt;e0>${tar.substring(e.location.end.offset)}&lt;/e0>`,
+                pathName: file
+            };
+            if (typeof(lineNumber) !== 'undefined') {
+                value.lineNumber = lineNumber + e.location.end.line - 1;
+            }
+            problems.push(new Result(value));
+        }
+        return problems.length &lt; 2 ? problems[0] : problems;
+    }
+    /**
+     * @override
+     */
+    match(options) {
+        const { resource, file } = options;
+        const sourceLocale = this.sourceLocale;
+        let problems = [];
+        switch (resource.getType()) {
+            case 'string':
+                const tarString = resource.getTarget();
+                if (tarString) {
+                    return this.checkString(resource.getSource(), tarString, file, resource, sourceLocale, options.locale, options.lineNumber);
+                }
+                break;
+            case 'array':
+                const srcArray = resource.getSource();
+                const tarArray = resource.getTarget();
+                if (tarArray) {
+                    return srcArray.map((item, i) => {
+                        if (i &lt; tarArray.length &amp;&amp; tarArray[i]) {
+                            return this.checkString(srcArray[i], tarArray[i], file, resource, sourceLocale, options.locale, options.lineNumber);
+                        }
+                    }).filter(element => {
+                        return element;
+                    });
+                }
+                break;
+            case 'plural':
+                const srcPlural = resource.getSource();
+                const tarPlural = resource.getTarget();
+                if (tarPlural) {
+                    return categories.map(category => {
+                        return this.checkString(srcPlural.other, tarPlural[category], file, resource, sourceLocale, options.locale, options.lineNumber);
+                    });
+                }
+                break;
+        }
+    }
+    // no match
+    return;
+}
+export default ResourceICUPlurals;</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Dec 19 2022 15:00:46 GMT-0800 (Pacific Standard 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>

package/docs/rules_ResourceQuoteStyle.js.html ADDED Viewed

@@ -0,0 +1,238 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>rules/ResourceQuoteStyle.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><li data-type='method'><a href="AnsiConsoleFormatter.html#getDescription">getDescription</a></li></ul></li><li><a href="Formatter.html">Formatter</a><ul class='methods'><li data-type='method'><a href="Formatter.html#format">format</a></li><li data-type='method'><a href="Formatter.html#getDescription">getDescription</a></li><li data-type='method'><a href="Formatter.html#getName">getName</a></li></ul></li><li><a href="FormatterFactory.html">FormatterFactory</a></li><li><a href="Parser.html">Parser</a><ul class='methods'><li data-type='method'><a href="Parser.html#getResources">getResources</a></li><li data-type='method'><a href="Parser.html#init">init</a></li><li data-type='method'><a href="Parser.html#parse">parse</a></li></ul></li><li><a href="Plugin.html">Plugin</a><ul class='methods'><li data-type='method'><a href="Plugin.html#getExtensions">getExtensions</a></li><li data-type='method'><a href="Plugin.html#getFormatters">getFormatters</a></li><li data-type='method'><a href="Plugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="Plugin.html#getRules">getRules</a></li><li data-type='method'><a href="Plugin.html#getType">getType</a></li><li data-type='method'><a href="Plugin.html#init">init</a></li></ul></li><li><a href="PluginManager.html">PluginManager</a><ul class='methods'><li data-type='method'><a href="PluginManager.html#getHandlers">getHandlers</a></li><li data-type='method'><a href="PluginManager.html#load">load</a></li></ul></li><li><a href="ResourceICUPlurals.html">ResourceICUPlurals</a><ul class='methods'><li data-type='method'><a href="ResourceICUPlurals.html#match">match</a></li></ul></li><li><a href="ResourceQuoteStyle.html">ResourceQuoteStyle</a><ul class='methods'><li data-type='method'><a href="ResourceQuoteStyle.html#match">match</a></li></ul></li><li><a href="ResourceRegExpChecker.html">ResourceRegExpChecker</a><ul class='methods'><li data-type='method'><a href="ResourceRegExpChecker.html#match">match</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="Result.html">Result</a></li><li><a href="Rule.html">Rule</a><ul class='methods'><li data-type='method'><a href="Rule.html#getDescription">getDescription</a></li><li data-type='method'><a href="Rule.html#getName">getName</a></li><li data-type='method'><a href="Rule.html#getRuleType">getRuleType</a></li><li data-type='method'><a href="Rule.html#match">match</a></li></ul></li><li><a href="RuleSet.html">RuleSet</a><ul class='methods'><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></ul></li><li><a href="SourceFile.html">SourceFile</a><ul class='methods'><li data-type='method'><a href="SourceFile.html#findIssues">findIssues</a></li><li data-type='method'><a href="SourceFile.html#getFilePath">getFilePath</a></li><li data-type='method'><a href="SourceFile.html#getLocaleFromPath">getLocaleFromPath</a></li><li data-type='method'><a href="SourceFile.html#getType">getType</a></li><li data-type='method'><a href="SourceFile.html#parse">parse</a></li></ul></li><li><a href="XliffParser.html">XliffParser</a><ul class='methods'><li data-type='method'><a href="XliffParser.html#getResources">getResources</a></li><li data-type='method'><a href="XliffParser.html#parse">parse</a></li></ul></li><li><a href="XliffPlugin.html">XliffPlugin</a><ul class='methods'><li data-type='method'><a href="XliffPlugin.html#getExtensions">getExtensions</a></li><li data-type='method'><a href="XliffPlugin.html#getParsers">getParsers</a></li><li data-type='method'><a href="XliffPlugin.html#getType">getType</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#ParserFactory">ParserFactory</a></li><li><a href="global.html#walk">walk</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">rules/ResourceQuoteStyle.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * ResourceQuoteStyle.js - rule to check quotes in the target string
+ *
+ * Copyright © 2022 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 LocaleInfo from 'ilib-localeinfo';
+import Rule from '../Rule.js';
+import Result from '../Result.js';
+let LICache = {};
+// superset of all the start and end chars used in CLDR
+const quoteChars = "«»‘“”„「」’‚‹›『』\"\'";
+/**
+ * @class Represent an ilib-lint rule.
+ */
+class ResourceQuoteStyle extends Rule {
+    constructor(options) {
+        super(options);
+        this.name = "resource-quote-style";
+        this.description = "Ensure that the proper quote characters are used in translated resources";
+        this.sourceLocale = (options &amp;&amp; options.sourceLocale) || "en-US";
+    }
+    getRuleType() {
+        return "resource";
+    }
+    /**
+     * @override
+     */
+    match(options) {
+        const { locale, resource, file } = options || {};
+        let li = LICache[locale];
+        const _this = this;
+        if (!li) {
+            li = new LocaleInfo(locale);
+            LICache[locale] = li;
+        }
+        let sourceLI = LICache[this.sourceLocale];
+        if (!sourceLI) {
+            sourceLI = new LocaleInfo(this.sourceLocale);
+            LICache[this.sourceLocale] = sourceLI;
+        }
+        const srcQuoteStart = sourceLI.getDelimiterQuotationStart();
+        const srcAltQuoteStart = sourceLI.info.delimiter.alternateQuotationStart;
+        const srcQuoteEnd = sourceLI.getDelimiterQuotationEnd();
+        const srcAltQuoteEnd = sourceLI.info.delimiter.alternateQuotationEnd;
+        const tarQuoteStart = li.getDelimiterQuotationStart();
+        const tarAltQuoteStart = li.info.delimiter.alternateQuotationStart;
+        const tarQuoteEnd = li.getDelimiterQuotationEnd();
+        const tarAltQuoteEnd = li.info.delimiter.alternateQuotationEnd;
+        // if the source uses ASCII quotes, then the target could have ASCII or native quotes
+        const srcQuotesAscii = new RegExp(`((^|\\W)['"]\\p{Letter}|\\p{Letter}['"](\\W|$))`, "gu");
+        const srcQuotesNative = new RegExp(`((^|\\W)[${srcQuoteStart}${srcAltQuoteStart}]\\p{Letter}|\\p{Letter}[${srcQuoteEnd}${srcAltQuoteEnd}](\\W|$))`, "gu");
+        // if the source contains native quotes, then the target should also have native quotes
+        const tarQuotesAll = new RegExp(`((^|\\W)[${tarQuoteStart}${tarAltQuoteStart}'"]\\p{Letter}|\\p{Letter}[${tarQuoteEnd}${tarAltQuoteEnd}'"](\\W|$))`, "gu");
+        const tarQuotesNative = new RegExp(`((^|\\W)[${tarQuoteStart}${tarAltQuoteStart}]\\p{Letter}|\\p{Letter}[${tarQuoteEnd}${tarAltQuoteEnd}](\\W|$))`, "gu");
+        const nonQuoteChars = `([${
+            quoteChars.
+                replace(srcQuoteStart, "").
+                replace(srcAltQuoteStart, "").
+                replace(tarQuoteStart, "").
+                replace(tarAltQuoteStart, "").
+                replace(srcQuoteEnd, "").
+                replace(srcAltQuoteEnd, "").
+                replace(tarQuoteEnd, "").
+                replace(tarAltQuoteEnd, "")}])`;
+        const re = new RegExp(nonQuoteChars, "g");
+        /**
+         * @private
+         */
+        function checkString(src, tar) {
+            srcQuotesAscii.lastIndex = 0;
+            tarQuotesAll.lastIndex = 0;
+            if ((src.match(srcQuotesAscii) &amp;&amp; !tar.match(tarQuotesAll)) ||
+                (src.match(srcQuotesNative) &amp;&amp; !tar.match(tarQuotesNative))) {
+                const matches = re.exec(tar);
+                let value = {
+                    severity: "warning",
+                    id: resource.getKey(),
+                    source: src,
+                    rule: _this,
+                    pathName: file
+                };
+                if (matches) {
+                    value.highlight = `Target: ${tar.replace(re, "&lt;e0>$1&lt;/e0>")}`;
+                    value.description = `Quote style for the the locale ${locale} should be ${tarQuoteStart}text${tarQuoteEnd}`;
+                } else {
+                    value.highlight = `Target: ${tar}&lt;e0>&lt;/e0>`;
+                    value.description = `Quotes are missing in the target. Quote style for the the locale ${locale} should be ${tarQuoteStart}text${tarQuoteEnd}`;
+                }
+                if (typeof(options.lineNumber) !== 'undefined') {
+                    value.lineNumber = options.lineNumber;
+                }
+                return new Result(value);
+            }
+        }
+        switch (resource.getType()) {
+            case 'string':
+                const tarString = resource.getTarget();
+                if (tarString) {
+                    return checkString(resource.getSource(), tarString);
+                }
+                break;
+            case 'array':
+                const srcArray = resource.getSource();
+                const tarArray = resource.getTarget();
+                if (tarArray) {
+                    return srcArray.map((item, i) => {
+                        if (i &lt; tarArray.length &amp;&amp; tarArray[i]) {
+                            return checkString(srcArray[i], tarArray[i]);
+                        }
+                    }).filter(element => {
+                        return element;
+                    });
+                }
+                break;
+            case 'plural':
+                const srcPlural = resource.getSource();
+                const tarPlural = resource.getTarget();
+                if (tarPlural) {
+                    const hasQuotes = categories.find(category => {
+                        return (srcPlural[category] &amp;&amp; srcPlural[category].contains(srcQuote));
+                    });
+                    if (hasQuotes) {
+                        return categories.map(category => {
+                            return checkString(srcPlural.other, tarPlural[category]);
+                        });
+                    }
+                }
+                break;
+        }
+    }
+    // no match
+    return;
+}
+export default ResourceQuoteStyle;</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Dec 19 2022 15:00:46 GMT-0800 (Pacific Standard 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>