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/Formatter.html ADDED Viewed

@@ -0,0 +1,577 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Formatter - 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">Formatter</h1>
+<section>
+<header>
+        <h2>
+        Formatter
+        </h2>
+            <div class="class-description usertext">Represent an output formatter</div>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="Formatter"><span class="type-signature">(abstract) </span>new Formatter<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="Formatter.js.html">Formatter.js</a>, <a href="Formatter.js.html#line24">line 24</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Construct an formatter instance. Formatters and formatter plugins
+should implement this abstract class.
+</div>
+        </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="format"><span class="type-signature">(abstract) </span>format<span class="signature">(result)</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Formatter.js.html">Formatter.js</a>, <a href="Formatter.js.html#line62">line 62</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Format the given result with the current formatter and return the
+formatted string.
+</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>result</code></td>
+            <td class="type">
+<span class="param-type"><a href="Result.html">Result</a></span>
+            </td>
+            <td class="description last">the result to format</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the formatted result
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getDescription"><span class="type-signature"></span>getDescription<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Formatter.js.html">Formatter.js</a>, <a href="Formatter.js.html#line50">line 50</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return a general description of the formatter for use in help output.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    a general description of the formatter
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Formatter.js.html">Formatter.js</a>, <a href="Formatter.js.html#line40">line 40</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Get the name of the formatter. This should be a unique string.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the name of this formatter
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</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>