ilib-lint 2.0.1 → 2.1.0

package/docs/ReleaseNotes.md

@@ -1,5 +1,13 @@
 Release Notes
-============================
+### v2.1.0
+- fixed a bug where the quote style checker was not converting the highlight quotes properly
+- added an option `output` to write the output to a file.
+- added an option `name` to give the project name. It is useful when the config file is shared in multiple projects.
+- updated to use `formatOutput()` if it is defined in the plugin formatter.
+- fixed quote checker rule to make a special case for Japanese. In Japanese, square brackets
+  are now allowed as a quote style, and only the main hockey-stick-style of quotes are
+  accepted even if the source has an alternate quote style. The double-hockey sticks are no
+  longer accepted.
 
 ### v2.0.1
 - fixed loading of plugins

package/docs/resource-no-fullwidth-punctuation-subset.md

@@ -1,8 +1,8 @@
-# resource-no-fullwidth-digits
+# resource-no-fullwidth-punctuation-subset
 
 Ensure that translations do not contain fullwidth punctuation characters. These should be represented as ASCII symbols instead.
 
 Examples:
 
 Good translation: "本当? はい! 100%"<br>
-Bad translation: "本当？ はい！ 100％"
+Bad translation: "本当？ はい！ 100％"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ilib-lint",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "module": "./src/index.js",
     "type": "module",
     "bin": "./src/index.js",

package/src/Project.js

@@ -578,46 +578,79 @@ class Project extends DirItem {
         // source file in order to make it easier for the engineer to fix all the
         // problems in the source file sequentially.
         results.sort(ResultComparator);
-
+        let resultAll;
         if (results) {
+            results.forEach(result => {
+                if (result.severity === "error") {
+                    this.resultStats.errors++;
+                } else if (result.severity === "warning") {
+                    this.resultStats.warnings++;
+                } else {
+                    this.resultStats.suggestions++;
+                }
+            });
+        }
+        const fmt = new Intl.NumberFormat("en-US", {
+            maxFractionDigits: 2
+        });
+        const score = this.getScore();
+        if (typeof (this.formatter.formatOutput) === "function") {
+            resultAll = this.formatter.formatOutput({
+                name: this.options.opt.name || this.project.name,
+                fileStats: this.fileStats,
+                resultStats: this.resultStats,
+                results: results,
+                score: score,
+                time: totalTime,
+                errorsOnly : this.options.opt.errorsOnly || false
+            });
+        } else {
             results.forEach(result => {
                 const str = this.formatter.format(result);
                 if (str) {
                     if (result.severity === "error") {
                         logger.error(str);
-                        this.resultStats.errors++;
                     } else if (result.severity === "warning") {
-                        this.resultStats.warnings++;
                         if (!this.options.errorsOnly) {
                             logger.warn(str);
                         }
                     } else {
-                        this.resultStats.suggestions++;
                         if (!this.options.errorsOnly) {
                             logger.info(str);
                         }
                     }
                 }
             });
-        }
 
-        const fmt = new Intl.NumberFormat("en-US", {
-            maxFractionDigits: 2
-        });
-        logger.info(`Total Elapse Time: ${String(totalTime)} seconds`);
-        logger.info(`                             ${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}`);
-        logger.info(`                   Total     ${`${String(this.fileStats.files)} Files`.padEnd(15, ' ')}${`${String(this.fileStats.modules)} Modules`.padEnd(15, ' ')}${`${String(this.fileStats.lines)} Lines`.padEnd(15, ' ')}`);
-        if (results.length) {
-            logger.info(
-                    `Errors:            ${String(this.resultStats.errors).padEnd(10, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.lines).padEnd(15, ' ')}`);
-            if (!this.options.errorsOnly) {
+            logger.info(`Total Elapse Time: ${String(totalTime)} seconds`);
+            logger.info(`                             ${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}${`Average over`.padEnd(15, ' ')}`);
+            logger.info(`                   Total     ${`${String(this.fileStats.files)} Files`.padEnd(15, ' ')}${`${String(this.fileStats.modules)} Modules`.padEnd(15, ' ')}${`${String(this.fileStats.lines)} Lines`.padEnd(15, ' ')}`);
+            if (results.length) {
                 logger.info(
-                    `Warnings:          ${String(this.resultStats.warnings).padEnd(10, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.lines).padEnd(15, ' ')}`);
-                logger.info(
-                    `Suggestions:       ${String(this.resultStats.suggestions).padEnd(10, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.lines).padEnd(15, ' ')}`);
+                        `Errors:            ${String(this.resultStats.errors).padEnd(10, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.errors/this.fileStats.lines).padEnd(15, ' ')}`);
+                if (!this.options.errorsOnly) {
+                    logger.info(
+                        `Warnings:          ${String(this.resultStats.warnings).padEnd(10, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.warnings/this.fileStats.lines).padEnd(15, ' ')}`);
+                    logger.info(
+                        `Suggestions:       ${String(this.resultStats.suggestions).padEnd(10, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.files).padEnd(15, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.modules).padEnd(15, ' ')}${fmt.format(this.resultStats.suggestions/this.fileStats.lines).padEnd(15, ' ')}`);
+                }
             }
         }
-        const score = this.getScore();
+
+        if (this.options.opt.output) {
+            let file = this.options.opt.output;
+            let fileDir = path.dirname(file);
+            if (!fs.existsSync(fileDir)) {
+                fs.mkdirSync(fileDir);
+            }
+            fs.writeFileSync(file, resultAll, "utf8");
+            if (!this.options.opt.quiet && this.options.opt.progressInfo) {
+                logger.info("Wrote the results to file " + file);
+            }
+        } else {
+            logger.info(resultAll);
+        }
+
         logger.info(`I18N Score (0-100) ${fmt.format(score)}`);
 
         if (this.options.opt["max-errors"]) {
@@ -633,6 +666,7 @@ class Project extends DirItem {
         } else {
             exitValue = this.resultStats.errors > 0 ? 2 : ((this.resultStats.warnings > 0) ? 1 : 0);
         }
+
         return exitValue;
     }
 

package/src/index.js

@@ -130,6 +130,16 @@ const optionConfig = {
         varName: "NUMBER",
         help: "Give the minimum acceptable I18N score allowed in this run. Valid values are 0-100. Default: no minimum",
         type: validateInt.bind(null, "min-score")
+    },
+    output: {
+        short: "o",
+        varName: "fileName",
+        help: "Allows you to write the output into a file."
+    },
+    name: {
+        short: "n",
+        varName: "projectName",
+        help: "Give the project name. It is useful when the config file is shared in multiple projects."
     }
 };
 
@@ -254,4 +264,4 @@ try {
     process.exit(exitValue);
 } catch (e) {
     logger.error(e);
-}
+}

package/src/plugins/BuiltinPlugin.js

@@ -61,7 +61,7 @@ export const regexRules = [
         description: "Ensure that the target does not contain any full-width Latin characters.",
         note: "The full-width characters '{matchString}' are not allowed in the target string. Use ASCII letters instead.",
         regexps: [ "[\\uFF21-\\uFF3A\\uFF41-\\uFF5A]+" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-fullwidth.md"
+        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-fullwidth-latin.md"
     },
     {
         type: "resource-target",

package/src/rules/ResourceQuoteStyle.js

@@ -24,7 +24,7 @@ import ResourceRule from './ResourceRule.js';
 
 /** @ignore @typedef {import("ilib-tools-common").Resource} Resource */
 
-/** 
+/**
  * @typedef BaseRegExpCollection
  * @type {object}
  * @prop {string} quoteStart
@@ -33,7 +33,7 @@ import ResourceRule from './ResourceRule.js';
  * @prop {string} quoteEndAlt
  * @prop {RegExp} quotesNative
  * @prop {RegExp} quotesNativeAlt
- * 
+ *
  * @typedef {BaseRegExpCollection} SourceRegExpCollection
  */
 
@@ -44,7 +44,7 @@ import ResourceRule from './ResourceRule.js';
  * @prop {RegExp} quotesAllAlt
  * @prop {string} nonQuoteChars
  * @prop {string} nonQuoteCharsAlt
- * 
+ *
  * @typedef {BaseRegExpCollection & ExtendedRegExpCollection} TargetRegExpCollection
  */
 
@@ -77,7 +77,7 @@ let /** @type {{[locale: string]: LocaleInfo}} */ LICache = {};
  * One-param rule configuration.
  */
 
-/** 
+/**
  * @typedef Configuration
  * @type {Modes}
  * Parameters that can be set through rule configuration file.
@@ -89,8 +89,8 @@ let /** @type {{[locale: string]: LocaleInfo}} */ LICache = {};
 class ResourceQuoteStyle extends ResourceRule {
     /**
      * Make a new rule instance.
-     * 
-     * @param {object} [options] 
+     *
+     * @param {object} [options]
      * @param {string} [options.sourceLocale]
      * @param {Configuration} [options.param]
      */
@@ -100,20 +100,20 @@ class ResourceQuoteStyle extends ResourceRule {
         this.description = "Ensure that the proper quote characters are used in translated resources";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
         this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-quote-style.md";
-        
+
         if (options?.param === "localeOnly") {
             // only localized quotes are allowed in the target string
             this.localeOnly = true;
         }
-        
+
         if (!this.skipLocales) {
             this.skipLocales = new Set();
         }
-        
+
         [
             "sv", // According to the MS Style guidelines, quotes are usually not required in Swedish when the source English text contains quotes
             "it", // Based on feedback from linguists quotes in Italian are not required to be the guillemets, even though CLDR says so
-        ].forEach(locale => this.skipLocales.add(locale));   
+        ].forEach(locale => this.skipLocales.add(locale));
     }
 
     /**
@@ -136,10 +136,10 @@ class ResourceQuoteStyle extends ResourceRule {
 
         // used in results to show what the expected quote style is
         const targetQuoteStyleExample = (sourceStyle.ascii || sourceStyle.native) ?
-            `${regExps.target.quoteStart}text${regExps.target.quoteEnd}` :
-            `${regExps.target.quoteStartAlt}text${regExps.target.quoteEndAlt}`;
-        
-        // verify that corresponding quote style is present in target 
+            `${regExps.target.quoteStart[0]}text${regExps.target.quoteEnd[0]}` :
+            `${regExps.target.quoteStartAlt[0]}text${regExps.target.quoteEndAlt[0]}`;
+
+        // verify that corresponding quote style is present in target
         // otherwise, construct regexps to pinpoint violation positions
         // (for highlighting purposes)
         let startQuote, endQuote;
@@ -149,7 +149,7 @@ class ResourceQuoteStyle extends ResourceRule {
             endQuote = new RegExp(`([\\p{Letter}\\}])([${regExps.target.nonQuoteChars}'])(\\W|$)`, "gu");
         } else if (sourceStyle.asciiAlt) {
             if (regExps.target.quotesAllAlt.test(tar)) return;
-            startQuote = new RegExp(`(^|\\W)[${regExps.target.nonQuoteCharsAlt}"]([\\p{Letter}\\{])`, "gu");
+            startQuote = new RegExp(`(^|\\W)([${regExps.target.nonQuoteCharsAlt}"])([\\p{Letter}\\{])`, "gu");
             endQuote = new RegExp(`([\\p{Letter}\\}])([${regExps.target.nonQuoteCharsAlt}"])(\\W|$)`, "gu");
         } else if (sourceStyle.native) {
             if (regExps.target.quotesNative.test(tar)) return;
@@ -202,12 +202,12 @@ class ResourceQuoteStyle extends ResourceRule {
     getRegExps(locale) {
         // superset of all the non-ASCII start and end chars used in CLDR
         const quoteChars = "«»‘“”„「」’‚‹›『』";
-        
+
         // shared between all locales since there is nothing locale-specific in here
         const quotesAscii = new RegExp(`((^|\\W)"\\s?[\\p{Letter}\\{]|[\\p{Letter}\\}]\\s?"(\\W|$))`, "gu");
         // leave out the "s" before the final quote to take care of plural possessives (eg. my colleagues' files.)
         const quotesAsciiAlt = new RegExp(`((^|\\W)'\\s?[\\p{Letter}\\{]|[a-rt-zA-RT-Z\\}]\\s?'(\\W|$))`, "gu");
-    
+
         // locale info object will tell us the quote chars for the locale
         let li = LICache[locale];
         if (!li) {
@@ -216,7 +216,7 @@ class ResourceQuoteStyle extends ResourceRule {
             li = new LocaleInfo(locale);
             LICache[locale] = li;
         }
-    
+
         let sourceLI = LICache[this.sourceLocale];
         if (!sourceLI) {
             // @ts-ignore: An argument for 'options' was not provided
@@ -224,25 +224,35 @@ class ResourceQuoteStyle extends ResourceRule {
             sourceLI = new LocaleInfo(this.sourceLocale);
             LICache[this.sourceLocale] = sourceLI;
         }
-    
+
         // what are all the quote chars that this locale uses?
         const sourceQuoteStart = sourceLI.getDelimiterQuotationStart();
         const sourceQuoteStartAlt = /** @type {string} */ (sourceLI.info.delimiter.alternateQuotationStart);
-    
+
         const sourceQuoteEnd = sourceLI.getDelimiterQuotationEnd();
         const sourceQuoteEndAlt = /** @type {string} */ (sourceLI.info.delimiter.alternateQuotationEnd);
-    
-        const targetQuoteStart = li.getDelimiterQuotationStart();
-        const targetQuoteStartAlt = /** @type {string} */ (li.info.delimiter.alternateQuotationStart);
-    
-        const targetQuoteEnd = li.getDelimiterQuotationEnd();
-        const targetQuoteEndAlt = /** @type {string} */ (li.info.delimiter.alternateQuotationEnd);
-    
+
+        /** special case for Japanese: accept the main quote style only and also square brackets */
+        const targetQuoteStartChars = (locale === "ja-JP") ? ["「", "\\["] : [li.getDelimiterQuotationStart()];
+        // used in regular expressions:
+        const targetQuoteStart = targetQuoteStartChars.join("");
+        const targetQuoteStartAltChars = (locale === "ja-JP") ? ["「", "\\["] : [li.info.delimiter.alternateQuotationStart];
+        // used in regular expressions:
+        const targetQuoteStartAlt = /** @type {string} */ targetQuoteStartAltChars.join("");
+
+        /** special case for Japanese: accept the main quote style only and also square brackets */
+        const targetQuoteEndChars = (locale === "ja-JP") ? ["」", "\\]"] : [li.getDelimiterQuotationEnd()];
+        // used in regular expressions:
+        const targetQuoteEnd = targetQuoteEndChars.join("");
+        const targetQuoteEndAltChars = (locale === "ja-JP") ? ["」", "\\]"] : [li.info.delimiter.alternateQuotationEnd];
+        // used in regular expressions:
+        const targetQuoteEndAlt = /** @type {string} */ targetQuoteEndAltChars.join("");
+
         // now calculate regular expressions for the source string that use those quotes
         // if the source uses ASCII quotes, then the target could have ASCII or native quotes
         const sourceQuotesNative = new RegExp(`((^|\\W)${sourceQuoteStart}\\s?[\\p{Letter}\\{]|[\\p{Letter}\\}]\\s?${sourceQuoteEnd}(\\W|$))`, "gu");
         const sourceQuotesNativeAlt = new RegExp(`((^|\\W)${sourceQuoteStartAlt}\\s?[\\p{Letter}\\{]|[\\p{Letter}\\}]\\s?${sourceQuoteEndAlt}(\\W|$))`, "gu");
-    
+
         // now calculate the regular expressions for the target string that use quotes
         // if the source contains native quotes, then the target should also have native quotes
         const targetQuotesNative = new RegExp(`((^|\\W)${targetQuoteStart}\\s?[\\p{Letter}\\{]|[\\p{Letter}\\}]\\s?${targetQuoteEnd}(\\W|$))`, "gu");
@@ -253,18 +263,20 @@ class ResourceQuoteStyle extends ResourceRule {
         const targetQuotesAllAlt = this.localeOnly ?
             targetQuotesNativeAlt :
             new RegExp(`((^|\\W)[${targetQuoteStartAlt}']\\s?[\\p{Letter}\\{]|[\\p{Letter}\\}]\\s?[${targetQuoteEndAlt}'](\\W|$))`, "gu");
-    
-        // the non quote chars are used to highlight errors in the target string
+
+        // the non quote chars are used to highlight errors in the target string where they are using quotes, but
+        // they are the wrong type. Start with the superset of all quotes and then remove the valid ones so that
+        // you are left with the wrong ones for this locale.
         const targetNonQuoteChars = quoteChars.
                 replace(sourceQuoteStart, "").
                 replace(targetQuoteStart, "").
                 replace(sourceQuoteEnd, "").
                 replace(targetQuoteEnd, "");
         const targetNonQuoteCharsAlt = quoteChars.
-                replace(sourceQuoteStartAlt, "").
-                replace(targetQuoteStartAlt, "").
-                replace(sourceQuoteEndAlt, "").
-                replace(targetQuoteEndAlt, "");
+                replace(new RegExp(`[${sourceQuoteStartAlt}]`, "gu"), "").
+                replace(new RegExp(`[${targetQuoteStartAlt}]`, "gu"), "").
+                replace(new RegExp(`[${sourceQuoteEndAlt}]`, "gu"), "").
+                replace(new RegExp(`[${targetQuoteEndAlt}]`, "gu"), "");
 
         return {
             quotesAscii,
@@ -294,11 +306,11 @@ class ResourceQuoteStyle extends ResourceRule {
 
     /**
      * @override
-     * @param {Object} params 
-     * @param {string | undefined} params.source 
-     * @param {string | undefined} params.target 
-     * @param {Resource} params.resource 
-     * @param {string} params.file 
+     * @param {Object} params
+     * @param {string | undefined} params.source
+     * @param {string | undefined} params.target
+     * @param {Resource} params.resource
+     * @param {string} params.file
      */
     matchString({source, target, resource, file}) {
         if (!source || !target) return; // cannot match in strings that don't exist!
@@ -308,4 +320,4 @@ class ResourceQuoteStyle extends ResourceRule {
     }
 }
 
-export default ResourceQuoteStyle;
+export default ResourceQuoteStyle;