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

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Plugin.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">Plugin.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * Plugin.js - common SPI that all plugins must implement
+ *
+ * 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.
+ */
+/**
+ * @class common SPI that all plugins must implement
+ * @abstract
+ */
+class Plugin {
+    /**
+     * Construct a new plugin.
+     */
+    constructor(options) {
+    }
+    /**
+     * Initialize the current plugin,
+     * @abstract
+     */
+    init() {}
+    /**
+     * Return the type of this plugin. This can be one of the
+     * following:
+     *
+     * &lt;ul>
+     * &lt;li>rule - this plugin implements a new rules
+     * &lt;li>parser - this plugin knows how to parse files more deeply
+     * than line-by-line
+     * &lt;li>formatter - this plugin formats results for a particular
+     * type of output
+     * &lt;/ul>
+     *
+     * @returns {String} tells what type of plugin this is
+     * @abstract
+     */
+    getType() {
+    }
+    /**
+     * Return the list of extensions of the files that this parser handles.
+     * The extensions are listed without the dot. eg. ["json", "jsn"]
+     *
+     * @returns {Array.&lt;String>} a list of file name extensions
+     */
+    getExtensions() {
+        return [];
+    }
+    /**
+     * For a "rule" type of plugin, this returns a list of Rule instances
+     * that this plugin implements.
+     *
+     * @returns {Array.&lt;Rule>} list of Rule instances implemented by this
+     * plugin
+     */
+    getRules() {
+        return [];
+    }
+    /**
+     * For a "parser" type of plugin, this returns a list of Parser classes
+     * that this plugin implements.
+     *
+     * @returns {Array.&lt;Parser>} list of Parser classes implemented by this
+     * plugin
+     */
+    getParsers() {
+        return [];
+    }
+    /**
+     * For a "formatter" type of plugin, this returns a list of Formatter
+     * instances that this plugin implements.
+     *
+     * @returns {Array.&lt;Formatter>} list of Formatter instances implemented by this
+     * plugin
+     */
+    getFormatters() {
+        return [];
+    }
+};
+export default Plugin;
+</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>