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/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf ADDED Viewed

Binary file

package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff ADDED Viewed

Binary file

package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 ADDED Viewed

Binary file

package/docs/formatters_AnsiConsoleFormatter.js.html ADDED Viewed

@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>formatters/AnsiConsoleFormatter.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">formatters/AnsiConsoleFormatter.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * AnsiConsoleFormatter.js - Formats result output
+ *
+ * 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 log4js from 'log4js';
+import Formatter from '../Formatter.js';
+var logger = log4js.getLogger("ilib-lint.formatters.AnsiConsoleFormatter");
+/**
+ * @class Represent an output formatter for an ANSI console/terminal
+ * @abstract
+ */
+class AnsiConsoleFormatter extends Formatter {
+    /**
+     * Construct an formatter instance.
+     */
+    constructor() {
+        super();
+        this.name = "ansi-console-formatter";
+    }
+    /**
+     * Return a general description of the formatter for use in help output.
+     *
+     * @returns {String} a general description of the formatter
+     */
+    getDescription() {
+        return "Formats results for an ANSI terminal/console with colors.";
+    }
+    /**
+     * Format the given result with the current formatter and return the
+     * formatted string.
+     *
+     * @abstract
+     * @param {Result} result the result to format
+     * @returns {String} the formatted result
+     */
+    format(result) {
+        if (!result) return;
+        let output = "";
+        const startColor = (result.severity === "error" ? "\u001B[91m" : "\u001B[33m");
+        output += `${result.pathName}${typeof(result.lineNumber) === "number" ? ('(' + result.lineNumber + ')') : ""}:
+  ${startColor}${result.description}\u001B[0m\n`;
+        if (result.id) {
+            output += `  Key: ${result.id}\n`;
+        }
+        if (result.source) {
+            output += `  Source: ${result.source}\n`;
+        }
+        output += `  ${result.highlight}
+  Rule (${result.rule.getName()}): ${result.rule.getDescription()}
+`;
+        // output ascii terminal escape sequences
+        output = output.replace(/&lt;e\d>&lt;\/e\d>/g, "\u001B[91m \u001B[0m");
+        output = output.replace(/&lt;e\d>/g, "\u001B[91m");
+        output = output.replace(/&lt;\/e\d>/g, "\u001B[0m");
+        return output;
+    }
+}
+export default AnsiConsoleFormatter;
+</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/global.html ADDED Viewed

@@ -0,0 +1,448 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Global - 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">Global</h1>
+<section>
+<header>
+        <h2>
+        </h2>
+</header>
+<article>
+        <div class="container-overview">
+<dl class="details">
+</dl>
+        </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="ParserFactory"><span class="type-signature"></span>ParserFactory<span class="signature">()</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="ParserFactory.js.html">ParserFactory.js</a>, <a href="ParserFactory.js.html#line34">line 34</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return a list of parsers for the given file name extension
+</div>
+    <h4 class="name" id="walk"><span class="type-signature"></span>walk<span class="signature">(root, options)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="SourceFile.html">SourceFile</a>>}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="walk.js.html">walk.js</a>, <a href="walk.js.html#line65">line 65</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Recursively walk a directory and return a list of files and directories
+within that directory. The walk is controlled via a list of exclude and
+include patterns. Each pattern should be a micromatch pattern like this:
+<code>
+"*.json"
+</code>
+The full path to every file and directory in the top-level directory will
+be included, unless it matches an exclude pattern, it which case, it will be
+excluded from the output. However, if the path
+also matches an include pattern, it will still be included nonetheless. The
+idea is that you can exclude a whole category of files (like all json files),
+but include specific ones. For example, you may exclude all json files, but
+still want to include the "config.json" file.<p>
+The options parameter may include any of the following optional properties:
+<ul>
+<li><i>quiet</i> (boolean) - whether or not to give output while walking
+the directory tree
+<li><i>excludes</i> (Array of strings) - A list of micromatch patterns to
+exclude from the output. If a pattern matches a directory, that directory
+will not be recursively searched.
+<li><i>includes</i> (Array of strings) - A list of micromatch patterns to
+include in the walk. If a pattern matches both an exclude and an include, the
+include will override the exclude.
+</ul>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>root</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Directory to walk</td>
+        </tr>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">Options controlling how this walk happens. (See
+the description for more details.)</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    an array of file names in the directory, filtered
+by the the excludes and includes list
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Array.&lt;<a href="SourceFile.html">SourceFile</a>></span>
+    </dd>
+</dl>
+</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>