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/styles/prettify.css ADDED Viewed

@@ -0,0 +1,79 @@
+.pln {
+  color: #ddd;
+}
+/* string content */
+.str {
+  color: #61ce3c;
+}
+/* a keyword */
+.kwd {
+  color: #fbde2d;
+}
+/* a comment */
+.com {
+  color: #aeaeae;
+}
+/* a type name */
+.typ {
+  color: #8da6ce;
+}
+/* a literal value */
+.lit {
+  color: #fbde2d;
+}
+/* punctuation */
+.pun {
+  color: #ddd;
+}
+/* lisp open bracket */
+.opn {
+  color: #000000;
+}
+/* lisp close bracket */
+.clo {
+  color: #000000;
+}
+/* a markup tag name */
+.tag {
+  color: #8da6ce;
+}
+/* a markup attribute name */
+.atn {
+  color: #fbde2d;
+}
+/* a markup attribute value */
+.atv {
+  color: #ddd;
+}
+/* a declaration */
+.dec {
+  color: #EF5050;
+}
+/* a variable name */
+.var {
+  color: #c82829;
+}
+/* a function name */
+.fun {
+  color: #4271ae;
+}
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0;
+}

package/docs/walk.js.html ADDED Viewed

@@ -0,0 +1,214 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>walk.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">walk.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*
+ * walk.js - walk a directory tree
+ *
+ * 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 fs from 'node:fs';
+import path from 'node:path';
+import log4js from 'log4js';
+import mm from 'micromatch';
+import SourceFile from './SourceFile.js';
+const logger = log4js.getLogger("ilib-lint.walk");
+/**
+ * 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:
+ *
+ * &lt;code>
+ * "*.json"
+ * &lt;/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.&lt;p>
+ * The options parameter may include any of the following optional properties:
+ *
+ * &lt;ul>
+ * &lt;li>&lt;i>quiet&lt;/i> (boolean) - whether or not to give output while walking
+ * the directory tree
+ * &lt;li>&lt;i>excludes&lt;/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.
+ * &lt;li>&lt;i>includes&lt;/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.
+ * &lt;/ul>
+ *
+ * @param {String} root Directory to walk
+ * @param {Object} options Options controlling how this walk happens. (See
+ * the description for more details.)
+ * @returns {Array.&lt;SourceFile>} an array of file names in the directory, filtered
+ * by the the excludes and includes list
+ */
+function walk(root, options) {
+    let results = [], projectRoot = false, newProject, list;
+    if (typeof(root) !== "string") {
+        return results;
+    }
+    const { config, quiet = false } = options || {};
+    const includes = config &amp;&amp; config.paths ? Object.keys(config.paths) : ["**"];
+    let excludes = config &amp;&amp; config.excludes;
+    let pathName, relPath, included, stat, glob;
+    try {
+        if (fs.existsSync(root)) {
+            stat = fs.statSync(root);
+            if (stat &amp;&amp; stat.isDirectory()) {
+                list = fs.readdirSync(root);
+                if (!quiet) logger.trace("Searching " + root);
+                if (list &amp;&amp; list.length !== 0) {
+                    list.sort().forEach((file) => {
+                        if (file === "." || file === "..") {
+                            return;
+                        }
+                        pathName = path.join(root, file);
+                        included = true;
+                        if (excludes) {
+                            if (!quiet) logger.trace(`There are excludes. Relpath is ${pathName}`);
+                            included = !mm.isMatch(pathName, excludes);
+                        }
+                        if (included) {
+                            results = results.concat(walk(pathName, options));
+                        }
+                    });
+                }
+            } else {
+                // file
+                included = false;
+                if (includes) {
+                    if (!quiet) logger.trace(`There are includes.`);
+                    mm.match(root, includes, {
+                        onMatch: (params) => {
+                            if (!glob &amp;&amp; params.isMatch) {
+                                glob = params.glob;
+                                excludes = config &amp;&amp; ((config.paths &amp;&amp; config.paths[glob] &amp;&amp; config.paths[glob].excludes) || excludes);
+                                included = excludes ? !mm.isMatch(root, excludes) : true;
+                            }
+                        }
+                    });
+                }
+                if (included) {
+                    if (!quiet) logger.trace(`${pathName} ... included`);
+                    glob = glob || "**";
+                    results.push(new SourceFile({
+                        filePath: root,
+                        settings: config.paths &amp;&amp; config.paths[glob]
+                    }));
+                } else {
+                    if (!quiet) logger.trace(`${pathName} ... excluded`);
+                }
+            }
+        } else {
+            if (!quiet) logger.warn(`File ${pathName} does not exist.`);
+        }
+    } catch (e) {
+        // if the readdirSync did not work, it's maybe a file?
+        if (fs.existsSync(root)) {
+            return [new SourceFile({
+                filePath: root
+            })];
+        }
+    }
+    return results;
+}
+export default walk;</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/log4js.json ADDED Viewed

@@ -0,0 +1,21 @@
+{
+    "appenders": {
+        "default": {
+            "type": "stdout",
+            "layout": {
+                "type": "pattern",
+                "pattern": "%[%p%]: %m"
+            }
+        }
+    },
+    "categories": {
+        "default": {
+            "appenders": [ "default" ],
+            "level": "info"
+        },
+        "ilib-lint.root": {
+            "appenders": [ "default" ],
+            "level": "info"
+        }
+    }
+}

package/package.json ADDED Viewed

@@ -0,0 +1,83 @@
+{
+    "name": "ilib-lint",
+    "version": "1.0.0",
+    "module": "./src/index.js",
+    "type": "module",
+    "bin": "./src/index.js",
+    "description": "A linter for i18n issues for any type of project",
+    "keywords": [
+        "internationalization",
+        "i18n",
+        "localization",
+        "l10n",
+        "globalization",
+        "g11n",
+        "lint",
+        "locale"
+    ],
+    "homepage": "https://github.com/iLib-js/ilib-common",
+    "bugs": "https://github.com/iLib-js/ilib-common/issues",
+    "email": "marketing@translationcircle.com",
+    "license": "Apache-2.0",
+    "author": {
+        "name": "Edwin Hoogerbeets",
+        "web": "http://www.translationcircle.com/",
+        "email": "edwin@translationcircle.com"
+    },
+    "contributors": [
+        {
+            "name": "Edwin Hoogerbeets",
+            "email": "ehoogerbeets@gmail.com"
+        },
+        {
+            "name": "Goun Lee",
+            "email": "goun.lee@lge.com"
+        }
+    ],
+    "files": [
+        "src",
+        "docs",
+        "log4js.json",
+        "i18nlint.js",
+        "README.md",
+        "LICENSE"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/iLib-js/i18nlint.git"
+    },
+    "engines": {
+        "node": ">=10.0.0"
+    },
+    "scripts": {
+        "build": "npm run build:prod",
+        "build:prod": "grunt babel --mode=prod",
+        "build:dev": "grunt babel --mode=dev",
+        "build:test": "webpack-cli --config webpack-test.config.js",
+        "dist": "npm-run-all doc build:prod build:pkg; npm pack",
+        "test": "LANG=en_US.UTF8 node test/testSuite.js",
+        "debug": "LANG=en_US.UTF8 node --inspect-brk test/testSuite.js",
+        "clean": "git clean -f -d src test",
+        "doc": "mkdir -p docs ; jsdoc2md -c jsdoc.json --separators --source src/* -m table > docs/ilibLint.md ; npm run doc:html",
+        "doc:html": "jsdoc -c jsdoc.json"
+    },
+    "devDependencies": {
+        "assertextras": "^1.1.0",
+        "docdash": "^1.2.0",
+        "jsdoc": "^3.6.11",
+        "jsdoc-to-markdown": "^7.1.1",
+        "nodeunit": "^0.11.3",
+        "npm-run-all": "^4.1.5"
+    },
+    "dependencies": {
+        "@formatjs/intl": "^2.5.1",
+        "ilib-common": "^1.1.3",
+        "ilib-locale": "^1.2.2",
+        "ilib-localeinfo": "^1.0.4",
+        "ilib-tools-common": "^1.2.0",
+        "json5": "^2.2.1",
+        "log4js": "^6.7.0",
+        "micromatch": "^4.0.5",
+        "options-parser": "^0.4.0"
+    }
+}

package/src/Formatter.js ADDED Viewed

@@ -0,0 +1,66 @@
+/*
+ * Formatter.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.
+ */
+/**
+ * @class Represent an output formatter
+ * @abstract
+ */
+class Formatter {
+    /**
+     * Construct an formatter instance. Formatters and formatter plugins
+     * should implement this abstract class.
+     */
+    constructor() {
+        if (this.constructor === Formatter) {
+            throw new Error("Cannot instantiate abstract class Formatter!");
+        }
+    }
+    /**
+     * Get the name of the formatter. This should be a unique string.
+     *
+     * @returns {String} the name of this formatter
+     */
+    getName() {
+        // make sure to define this.name in your implementation
+        return this.name;
+    }
+    /**
+     * Return a general description of the formatter for use in help output.
+     *
+     * @returns {String} a general description of the formatter
+     */
+    getDescription() {
+        return this.description;
+    }
+    /**
+     * 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) {
+    }
+}
+export default Formatter;

package/src/FormatterFactory.js ADDED Viewed

@@ -0,0 +1,41 @@
+/*
+ * FormatterFactory.js - Factory to create and return the right formatter
+ *
+ * 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 AnsiConsoleFormatter from './formatters/AnsiConsoleFormatter.js';
+const formatterCache = {};
+const cfmt = new AnsiConsoleFormatter();
+formatterCache[cfmt.getName()] = cfmt;
+/**
+ * @class Represent an output formatter
+ * @abstract
+ */
+function FormatterFactory(options) {
+    let fmt = formatterCache[cfmt.getName()];
+    if (options && options.formatter && formatterCache[options.formatter]) {
+        fmt = formatterCache[options.formatter];
+    }
+    return fmt;
+}
+export default FormatterFactory;

package/src/Parser.js ADDED Viewed

@@ -0,0 +1,53 @@
+/*
+ * Parser.js - common SPI for parser plugins
+ *
+ * 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 for parser plugins
+ * @abstract
+ */
+class Parser {
+    /**
+     * Construct a new plugin.
+     */
+    constructor(options) {
+    }
+    /**
+     * Initialize the current plugin,
+     * @abstract
+     */
+    init() {}
+    /**
+     * Parse the current file into an intermediate representation.
+     */
+    parse() {}
+    /**
+     * For a "resource" type of plugin, this returns a list of Resource instances
+     * that result from parsing the file.
+     *
+     * @returns {Array.<Resource>} list of Resource instances in this file
+     */
+    getResources() {
+        return [];
+    }
+};
+export default Parser;

package/src/ParserFactory.js ADDED Viewed

@@ -0,0 +1,41 @@
+/*
+ * ParserFactory.js - Factory to create and return the right parser for the file
+ *
+ * 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 XliffPlugin from './plugins/XliffPlugin.js';
+const parserCache = {};
+const xp = new XliffPlugin();
+const extensions = xp.getExtensions();
+const xpParsers = xp.getParsers();
+extensions.forEach(ext => {
+    parserCache[ext] = xpParsers;
+});
+/**
+ * Return a list of parsers for the given file name extension
+ */
+function ParserFactory(options) {
+    const { extension } = options;
+    let parserClasses = parserCache[extension];
+    return parserClasses || [];
+}
+export default ParserFactory;