ilib-lint 2.7.0 → 2.7.2

package/README.md

@@ -219,7 +219,7 @@ or any of them at the same time.
 ## Common Code
 
 All plugins should import and use the classes in the
-[ilib-lint-common](https://github.com/ilib-js/ilib-lint-common) package.
+[ilib-lint-common](https://github.com/iLib-js/ilib-mono/tree/main/packages/ilib-lint-common) package.
 This defines the super classes for each plugin type, as well as a number
 of utility classes and functions.
 
@@ -259,7 +259,7 @@ representation so that the appropriate rules can parse that representation.
 The standard representations are:
 
 - resources - the file is converted into an array of
-  [Resource](https://github.com/iLib-js/ilib-tools-common/blob/main/src/Resource.js)
+  [Resource](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-tools-common/src/Resource.js)
   instances
 - lines - the file in converted into a simple array of lines
 - source - the file is not parsed. Instead, the entire text of the file is used to
@@ -269,7 +269,7 @@ The resources representation is intended to represent entries in resource files
 such as xliff files, gnu po files, or java properties files. Each entry in the
 resource file is represented as an instance of one of the standard resource
 classes all defined in the
-[ilib-tools-common](https://github.com/ilib-js/ilib-tools-common)
+[ilib-tools-common](https://github.com/iLib-js/ilib-mono/tree/main/packages/ilib-tools-common/src)
 project:
 
 - ResourceString - the resource is a single string
@@ -288,13 +288,13 @@ for your class should define the following properties:
 - `this.description` - a description of this type of parser to display to users
 
 It should also override the
-[parseData()](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Parser.js)
+[parseData()](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Parser.js)
 method which parses a string, and the
-[parse()](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Parser.js)
+[parse()](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Parser.js)
 method, which loads data from the file and then parses it.
 
 You can see an example of a parser plugin by looking at the gnu PO file parser at
-[ilib-lint-python-gnu](https://github.com/ilib-js/ilib-lint-python-gnu/blob/main/src/POParser.js).
+[ilib-lint-python-gnu](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-python-gnu/src/POParser.js).
 That parser interprets a .po file as a resource file and returns a set of
 Resource instances.
 
@@ -302,7 +302,7 @@ Resource instances.
 
 Rules interpret the intermediate representation of a file produced by a Parser
 and produce a single
-[Result](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Result.js)
+[Result](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Result.js)
 instance, an array of Result instances, one for each problem found, or undefined
 if there are no problems found.
 
@@ -370,8 +370,8 @@ locale first needs to look up what the correct quote style even is in
 order to apply the rule.
 
 In order to create a rule instance, create a class that extends the
-[Rule](https://github.com/ilib-js/ilib-lint-common/blob/main/src/Rule.js)
-class in the [ilib-lint-common](https://github.com/ilib-js/ilib-lint-common/) project.
+[Rule](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Rule.js)
+class in the [ilib-lint-common](https://github.com/iLib-js/ilib-mono/tree/main/packages/ilib-lint-common) package.
 The constructor of this class should define the following properties:
 
 - `this.name` - a unique name for this rule
@@ -389,13 +389,13 @@ part is that the name should uniquely identify your Rule so that you can use it
 in config files.
 
 The rule should also override and implement the getRuleType() method and the
-[match()](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Rule.js) method,
+[match()](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Rule.js) method,
 which takes an intermediate representation as a parameter and returns either
 a single Result, an array of Result, or undefined.
 
 If you would like to see an example rule plugin, see the definition of
 the built-in ICU plural matcher rule:
-[resource-icu-plurals](https://github.com/ilib-js/ilib-lint/blob/main/src/rules/ResourceICUPlurals.js)
+[resource-icu-plurals](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/src/rules/ResourceICUPlurals.js)
 which checks resources to make sure that plurals in source and target strings
 have the correct syntax for ICU and formatjs.
 
@@ -435,7 +435,7 @@ syntax. (Each rule defines for itself what parameters/initalizers it accepts.)
 
 ### Formatters
 
-Formatters transform a [Result object](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Result.js) into a format that the consumer can use. For the most part, the consumer
+Formatters transform a [Result object](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Result.js) into a format that the consumer can use. For the most part, the consumer
 is a human, so the result should be formatted in text so that the user can read
 it easily. Other times, the consumer is another program, so the result should be
 formatted for easy parsing. Formatters can formats the results in any way necessary.
@@ -468,8 +468,8 @@ sure that fields in a CSV file are escaped properly to conform to CSV syntax, an
 include escaping code in it.
 
 In order to create a formatter instance, create a class that extends the
-[Formatter](https://github.com/ilib-js/ilib-lint-common/blob/main/src/Formatter.js)
-class in the [ilib-lint-common](https://github.com/ilib-js/ilib-lint-common/) project.
+[Formatter](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Formatter.js)
+class in the [ilib-lint-common](https://github.com/iLib-js/ilib-mono/tree/main/packages/ilib-lint-common) project.
 The constructor of this class should define the following properties:
 
 - `this.name` - a unique name for this formatter
@@ -478,17 +478,17 @@ The constructor of this class should define the following properties:
   of the rule and how to resolve the problem it found
 
 The formatter should also override and implement the
-[format()](https://github.com/iLib-js/ilib-lint-common/blob/main/src/Formatter.js) method,
+[format()](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint-common/src/Formatter.js) method,
 which takes a Result instance as a parameter and returns a formatted string.
 
 If you would like to look at an example formatter plugin, see the definition of
 the built-in default formatter
-[ansi-console-formatter](https://github.com/ilib-js/ilib-lint/blob/main/src/formatters/AnsiConsoleFormatter.js)
+[ansi-console-formatter](https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/src/formatters/AnsiConsoleFormatter.js)
 which formats a Result for colorful output on an ANSI console.
 
 ## Example Plugin
 
-You can take a look at the [ilib-lint-python](https://github.com/ilib-js/ilib-lint-python)
+You can take a look at the [ilib-lint-python](https://github.com/iLib-js/ilib-mono/tree/main/packages/ilib-lint-python)
 plugin as a working example of ilib-lint plugin. It implements some rules that
 check the various types of substitution parameters that python/django and
 gnu gettext support.
@@ -583,4 +583,4 @@ 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.
+limitations under the License.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "ilib-lint",
-  "version": "2.7.0",
-  "module": "./src/index.js",
+  "version": "2.7.2",
   "type": "module",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
   "bin": "./src/index.js",
   "description": "A linter for i18n issues for any type of project",
   "keywords": [
@@ -15,7 +16,7 @@
     "lint",
     "locale"
   ],
-  "homepage": "https://github.com/iLib-js/ilib-mono/packages/ilib-lint",
+  "homepage": "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint",
   "bugs": "https://github.com/iLib-js/ilib-mono/issues",
   "email": "marketing@translationcircle.com",
   "license": "Apache-2.0",
@@ -42,7 +43,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/iLib-js/ilib-lint.git"
+    "url": "https://github.com/iLib-js/ilib-mono.git"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -61,27 +62,26 @@
   },
   "dependencies": {
     "@formatjs/intl": "^2.10.4",
-    "ilib-common": "^1.1.3",
-    "ilib-lint-common": "^3.1.0",
     "ilib-locale": "^1.2.2",
     "ilib-localeinfo": "^1.1.0",
-    "ilib-tools-common": "^1.11.0",
     "intl-messageformat": "^10.5",
     "json5": "^2.2.3",
     "log4js": "^6.9.1",
     "micromatch": "^4.0.7",
     "options-parser": "^0.4.0",
-    "xml-js": "^1.6.11"
+    "xml-js": "^1.6.11",
+    "ilib-common": "^1.1.6",
+    "ilib-tools-common": "^1.12.2",
+    "ilib-lint-common": "^3.1.2"
   },
   "scripts": {
-    "dist": "pnpm pack",
     "test": "pnpm test:jest",
-    "test:jest": "LANG=en_US.UTF8 NODE_OPTIONS=\"$NODE_OPTIONS --trace-warnings --experimental-vm-modules\" jest",
+    "test:jest": "LANG=en_US.UTF8 node --trace-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:watch": "pnpm test:jest --watch",
-    "debug": "LANG=en_US.UTF8 NODE_OPTIONS=\"$NODE_OPTIONS --trace-warnings --experimental-vm-modules --inspect-brk\" jest -i",
+    "debug": "LANG=en_US.UTF8 node --experimental-vm-modules --inspect-brk node_modules/jest/bin/jest.js -i",
     "lint": "node src/index.js",
     "clean": "git clean -f -d src test",
-    "doc": "mkdir -p docs; jsdoc2md -c jsdoc.json --separators --source src/* -m table > docs/ilibLint.md; pnpm doc:html",
+    "doc": "mkdir -p docs && jsdoc2md -c jsdoc.json --separators --source src/* -m table > docs/ilibLint.md && pnpm doc:html",
     "doc:html": "jsdoc -c jsdoc.json",
     "types": "tsc -p ./jsconfig.json"
   }

package/src/config/README.md

@@ -134,7 +134,7 @@ Here is an example of a configuration file:
             "description": "Ensure that named parameters that appear in the source string are also used in the translated string",
             "note": "The named parameter '{matchString}' from the source string does not appear in the target string",
             "regexps": ["\\{\\w+\\}"],
-            "link": "https://github.com/ilib-js/ilib-lint/blob/main/README.md"
+            "link": "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/README.md"
         }
     ],
     "formatters": [

package/src/formatters/ConfigBasedFormatter.js

@@ -18,7 +18,7 @@
  */
 import log4js from 'log4js';
 
-import { Formatter, Result } from 'ilib-lint-common';
+import {Formatter, Result} from 'ilib-lint-common';
 
 var logger = log4js.getLogger("ilib-lint.formatters.ConfigBasedFormatter");
 
@@ -50,13 +50,13 @@ export class ConfigBasedFormatter extends Formatter {
      */
     constructor(options) {
         super(options);
-        
+
         if (!options) {
             throw "Attempt to create a ConfigBasedFormatter without options";
         }
 
         for (let prop of requiredFields) {
-            if (typeof(options[prop]) === 'undefined') {
+            if (typeof (options[prop]) === 'undefined') {
                 throw `Missing ${prop} field for a ConfigBasedFormatter`;
             }
             this[prop] = options[prop];
@@ -73,7 +73,7 @@ export class ConfigBasedFormatter extends Formatter {
     format(result) {
         if (!result) return "";
         let output = this.template;
-        
+
         for (let prop of resultFields) {
             output = output.replace(new RegExp(`{${prop}}`, "g"), result[prop] || "");
         }
@@ -82,11 +82,12 @@ export class ConfigBasedFormatter extends Formatter {
         output = output.replace(new RegExp("{ruleDescription}", "g"), result.rule.getDescription());
 
         output = output.replace(/<e\d><\/e\d>/g, `${this.highlightStart}${this.highlightEnd}`);
+        output = output.replace(/<e\d\/>/g, `${this.highlightStart}${this.highlightEnd}`);
         output = output.replace(/<e\d>/g, this.highlightStart);
         output = output.replace(/<\/e\d>/g, this.highlightEnd);
 
         let link = "";
-        if (typeof(result.rule.getLink) === 'function') {
+        if (typeof (result.rule.getLink) === 'function') {
             link = result.rule.getLink() || "";
         }
         output = output.replace(new RegExp("{ruleLink}", "g"), link);

package/src/formatters/__tests__/ConfigBasedFormatter.test.js

@@ -0,0 +1,61 @@
+import {Result} from 'ilib-lint-common';
+import {ConfigBasedFormatter} from '../ConfigBasedFormatter.js';
+import ResourceMatcher from "../../rules/ResourceMatcher.js";
+
+describe('ConfigBasedFormatter', () => {
+    it.each([
+        {
+            name: "a pair of opening and closing tags <eX></eX>",
+            highlight: "This is just <e0>me</e0> testing.",
+            expected: "This is just >>me<< testing."
+        },
+        {
+            name: "a self-closing tag <eX/>",
+            highlight: "This is just me testing.<e0/>",
+            expected: "This is just me testing.>><<"
+        },
+        {
+            name: "an opening tag <eX>",
+            highlight: "This is just me testing.<e0>",
+            expected: "This is just me testing.>>"
+        },
+        {
+            name: "a closing tag </eX>",
+            highlight: "This is just me testing.</e0>",
+            expected: "This is just me testing.<<"
+        },
+    ])('replaces $name with highlight markers', ({highlight, expected}) => {
+        const formatter = new ConfigBasedFormatter({
+            "name": "test-formatter",
+            "description": "A formatter for testing purposes",
+            "template": "{highlight}",
+            "highlightStart": ">>",
+            "highlightEnd": "<<"
+        })
+
+        const result = formatter.format(new Result({
+            description: "A description for testing purposes",
+            highlight,
+            id: "test.id",
+            lineNumber: 123,
+            pathName: "test.txt",
+            rule: getTestRule(),
+            severity: "error",
+            source: "test"
+        }));
+
+
+        expect(result).toBe(expected);
+    });
+});
+
+function getTestRule() {
+    return new ResourceMatcher({
+        "name": "testRule",
+        "description": "Rule for testing purposes",
+        "regexps": ["test"],
+        "note": "test",
+        "sourceLocale": "en-US",
+        "link": ""
+    });
+}

package/src/plugins/BuiltinPlugin.js

@@ -51,7 +51,7 @@ export const regexRules = [
         description: "Ensure that URLs that appear in the source string are also used in the translated string",
         note: "URL '{matchString}' from the source string does not appear in the target string",
         regexps: [ "((https?|github|ftps?|mailto|file|data|irc):\\/\\/)([\\da-zA-Z\\.-]+)\\.([a-zA-Z\\.]{2,6})([\\/\w\\.-]*)*\\/?" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-url-match.md"
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-url-match.md"
     },
     {
         type: "resource-matcher",
@@ -59,7 +59,7 @@ export const regexRules = [
         description: "Ensure that named parameters that appear in the source string are also used in the translated string",
         note: "The named parameter '{matchString}' from the source string does not appear in the target string",
         regexps: [ "\\{\\w+\\}" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-named-params.md"
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-named-params.md"
     },
     {
         type: "resource-target",
@@ -67,7 +67,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-latin.md"
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-fullwidth-latin.md"
     },
     {
         type: "resource-target",
@@ -75,7 +75,7 @@ export const regexRules = [
         description: "Ensure that the target does not contain any full-width digits.",
         note: "The full-width characters '{matchString}' are not allowed in the target string. Use ASCII digits instead.",
         regexps: [ "[\\uFF10-\\uFF19]+" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-fullwidth-digits.md"
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-fullwidth-digits.md"
     },
     {
         type: "resource-target",
@@ -83,7 +83,7 @@ export const regexRules = [
         description: "Ensure that the target does not contain specific full-width punctuation: percent sign, question mark, or exclamation mark.",
         note: "The full-width characters '{matchString}' are not allowed in the target string. Use ASCII symbols instead.",
         regexps: [ "[\\uFF01\\uFF05\\uFF1F]+" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-fullwidth-punctuation-subset.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-fullwidth-punctuation-subset.md",
         locales: "ja"
     },
         {
@@ -92,7 +92,7 @@ export const regexRules = [
         description: "Ensure that the target does not contain a space character between a double-byte and single-byte character.",
         note: "The space character is not allowed in the target string between a double- and single-byte character. Remove the space character.",
         regexps: [ "[\\u3040-\\u309F\\u30A0-\\u30FF\\u4E00-\\u9FAF]\\s+[\\x00-\\x20\\x30-\\x39\\x41-\\x5A\\x61-\\x7A\\x8A\\x8C\\x8E\\x9A\\x9C\\x9E\\x9F\\xC0-\\xD6\\xD8-\\xF6\\xF8-\\xFF]|[\\x00-\\x20\\x30-\\x39\\x41-\\x5A\\x61-\\x7A\\x8A\\x8C\\x8E\\x9A\\x9C\\x9E\\x9F\\xC0-\\xD6\\xD8-\\xF6\\xF8-\\xFF]\\s+[\\u3040-\\u309F\\u30A0-\\u30FF\\u4E00-\\u9FAF]" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-space-between-double-and-single-byte-character.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-space-between-double-and-single-byte-character.md",
         severity: "warning",
         locales: "ja"
     },
@@ -102,7 +102,7 @@ export const regexRules = [
         description: "Ensure that the target does not contain half-width kana characters.",
         note: "The half-width kana characters are not allowed in the target string. Use full-width characters.",
         regexps: [ "[ｧ-ﾝﾞﾟ]+" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-halfwidth-kana-characters.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-halfwidth-kana-characters.md",
         severity: "warning"
     },
     {
@@ -112,7 +112,7 @@ export const regexRules = [
         note: "Double-byte space characters should not be used in the target string. Use ASCII symbols instead.",
         // per https://en.wikipedia.org/wiki/Whitespace_character
         regexps: [ "[\\u1680\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200A\\u2028\\u2029\\u202F\\u205F\\u3000]+" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-double-byte-space.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-double-byte-space.md",
         severity: "warning",
         locales: "ja"
     },
@@ -122,7 +122,7 @@ export const regexRules = [
         description: "Ensure that there is no whitespace adjacent to the fullwidth punctuation characters.",
         note: "There should be no space adjacent to fullwidth punctuation characters '{matchString}'. Remove it.",
         regexps: [ "(\\s+[\\u3001\\u3002\\u3008-\\u3011\\u3014-\\u301B]|[\\u3001\\u3002\\u3008-\\u3011\\u3014-\\u301B]\\s+)" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-space-with-fullwidth-punctuation.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-space-with-fullwidth-punctuation.md",
         severity: "warning",
         locales: "ja"
     },
@@ -132,7 +132,7 @@ export const regexRules = [
         description: "Ensure that there are no replacement variables surrounded by single quotes which escape them in the source strings.",
         note: "There should be no escaped replacement parameters. Use Unicode quotes ‘like this’ (U+2018 and U+2019) or double quotes instead.",
         regexps: [ "(?:^|[^'])(?<match>''?\\{.*?\\}''?)" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-escaped-curly-braces.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-escaped-curly-braces.md",
         severity: "error",
         useStripped: false
     },
@@ -142,7 +142,7 @@ export const regexRules = [
         description: "Ensure that there are no replacement variables surrounded by single quotes which escape them in the target strings.",
         note: "There should be no escaped replacement parameters in the translation. Use quotes that are native for the target language or use tripled single-quotes instead.",
         regexps: [ "(?:^|[^'])(?<match>''?\\{.*?\\}''?)" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-escaped-curly-braces.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-escaped-curly-braces.md",
         severity: "error",
         useStripped: false
     },
@@ -152,7 +152,7 @@ export const regexRules = [
         description: "Ensure that source strings do not contain dashes in the replacement parameters.",
         note: "Dashes are not allowed in replacement parameters. Use a different character such as underscore.",
         regexps: [ "(?:^|[^'])(?<match>\\{[^}]*?-[^}]*\\})" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-dashes-in-replacement-params.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-dashes-in-replacement-params.md",
         severity: "error"
     },
     {
@@ -161,7 +161,7 @@ export const regexRules = [
         description: "Ensure that source strings do not contain the (s) construct to indicate a possible plural. That is not translatable to many languages.",
         note: "The (s) construct is not allowed in source strings. Use real plural syntax instead.",
         regexps: [ "(?<match>\\w+\\(s\\))(?:\\s|\\p{P}|$)" ],  // \p{P} means punctuation
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-lazy-plurals.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-lazy-plurals.md",
         severity: "warning"
     },
     {
@@ -170,7 +170,7 @@ export const regexRules = [
         description: "Ensure that source strings do not contain percentage formatting. Percentages should be formatted using a locale-sensitive number formatter instead.",
         note: "Do not format percentages in English strings. Use a locale-sensitive number formatter and substitute the result of that into this string.",
         regexps: [ "(?<match>\\{[\\w_.$0-9]+\\}\\s*%)(\\s|$)" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-manual-percentage-formatting.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-manual-percentage-formatting.md",
         severity: "warning"
     },
     {
@@ -179,7 +179,7 @@ export const regexRules = [
         description: "Ensure that source strings do not contain replacement parameters that are nouns or adjectives.",
         note: "Do not substitute nouns into UI strings. Use separate strings for each noun instead.",
         regexps: [ "\\b(?<match>([Aa][Nn]?|[Tt][Hh][Ee])\\s+\\{.*?\\})" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-noun-replacement-params.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-noun-replacement-params.md",
         severity: "error",
         useStripped: false
     },
@@ -189,7 +189,7 @@ export const regexRules = [
         description: "Ensure that source strings do not contain currency formatting. Currencies should be formatted using a locale-sensitive number formatter instead.",
         note: "Do not format currencies in English strings. Use a locale-sensitive number formatter and substitute the result of that into this string.",
         regexps: [ "(?<match>\\$\\s*\\{[\\w_.$0-9]+\\})" ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-manual-currency-formatting.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-manual-currency-formatting.md",
         severity: "error"
     },
     {
@@ -230,7 +230,7 @@ export const regexRules = [
             "\\{[Hh][Hh]?\\}:\\{[Mm][Mm]?\\}:\\{[Ss][Ss]?\\}",
             "\\{[Hh][Hh]?\\}:\\{[Mm][Mm]?\\}"
         ],
-        link: "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-no-manual-date-formatting.md",
+        link: "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-no-manual-date-formatting.md",
         severity: "error"
     },
 ];

package/src/rules/DeclarativeResourceRule.js

@@ -19,9 +19,12 @@
  */
 
 import Locale from 'ilib-locale';
-
 import ResourceRule from './ResourceRule.js';
 
+// type imports
+/** @ignore @typedef {import("ilib-tools-common").Resource} Resource */
+/** @ignore @typedef {import("ilib-lint-common").Result} Result */
+
 // figure out which regex flags are supported on this version of node
 let regexFlags = "g";
 
@@ -43,6 +46,8 @@ function getLangSpec(spec) {
     return locale.getLangSpec();
 }
 
+/** @ignore @typedef {("error"|"warning"|"suggestion")} Severity */
+
 class DeclarativeResourceRule extends ResourceRule {
     /**
      * Construct a new regular expression-based declarative resource rule.
@@ -56,7 +61,7 @@ class DeclarativeResourceRule extends ResourceRule {
      *   screen when the check fails. Example: "The URL {matchString} did
      *   not appear in the target." (Currently, matchString is the only
      *   replacement param that is supported.)
-     * @param {String} options.regexps an array of strings that encode
+     * @param {String[]} options.regexps an array of strings that encode
      *   regular expressions to look for. Only one of these regexps needs to
      *   match in order to trigger a result from this rule. The first one that
      *   matches will be taken, so the order of regular expressions is
@@ -65,7 +70,7 @@ class DeclarativeResourceRule extends ResourceRule {
      * @param {String} [options.sourceLocale] the source locale of this rule
      * @param {String} [options.link] the URL to a web page that explains this
      *   rule in more detail
-     * @param {{"error"|"warning"|"suggestion"}} [options.severity] the severity
+     * @param {Severity} [options.severity] the severity
      *   of the Result if this rule matches
      * @param {Array.<String>} [options.locales] the target locales to which this
      *   rule applies. If specified, this rule will skip resources that have a

package/src/rules/ResourceCamelCase.js

@@ -20,7 +20,7 @@ class ResourceCamelCase extends ResourceRule {
 
         this.name = "resource-camel-case";
         this.description = "Ensure that when source strings contain only camel case and no whitespace, then the targets are the same";
-        this.link = "https://gihub.com/ilib-js/ilib-lint/blob/main/docs/resource-camel-case.md";
+        this.link = "https://gihub.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-camel-case.md";
         this.regexps = [
             "^\\s*[a-z\\d]+([A-Z][a-z\\d]+)+\\s*$",
             "^\\s*[A-Z][a-z\\d]+([A-Z][a-z\\d]+)+\\s*$",

package/src/rules/ResourceCompleteness.js

@@ -22,11 +22,14 @@ import Locale from "ilib-locale";
 
 import ResourceRule from './ResourceRule.js';
 
+// type imports
+/** @ignore @typedef {import("ilib-tools-common").Resource} Resource */
+
 /** Rule to check that a resource has both source and target elements */
 class ResourceCompleteness extends ResourceRule {
     /** @readonly */ name = "resource-completeness";
     /** @readonly */ description = "Ensure that resources are complete, i.e. have both source and target elements.";
-    /** @readonly */ link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-completeness.md";
+    /** @readonly */ link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-completeness.md";
 
     constructor(options) {
         super(options);
@@ -38,7 +41,7 @@ class ResourceCompleteness extends ResourceRule {
      * @param {Object} params a parameters object
      * @param {string} params.source the source string
      * @param {string} params.target the target string
-     * @param {import("ilib-tools-common").Resource} params.resource the resource being checked
+     * @param {Resource} params.resource the resource being checked
      * @param {string} params.file the file where the resource came from
      * @returns {Array.<Result>|undefined} the results
      */

package/src/rules/ResourceDNTTerms.js

@@ -23,12 +23,15 @@ import path from "node:path";
 
 import ResourceRule from './ResourceRule.js';
 
+// type imports
+/** @ignore @typedef {import("ilib-tools-common").Resource} Resource */
+
 /** Rule to ensure that Do Not Translate terms have not been translated;
  * i.e., if a DNT term appears in source, it has to appear in target as well */
 class ResourceDNTTerms extends ResourceRule {
     /** @readonly */ name = "resource-dnt-terms";
     /** @readonly */ description = "Ensure that Do Not Translate terms have not been translated.";
-    /** @readonly */ link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-dnt-terms.md";
+    /** @readonly */ link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-dnt-terms.md";
 
     /**
      * @protected
@@ -86,10 +89,11 @@ class ResourceDNTTerms extends ResourceRule {
      * Check that if a given resource has a DNT term in the source, then
      * it also exists in the target
      * @override
-     * @param {string} source the source string
-     * @param {string} target the target string
-     * @param {import("ilib-tools-common").Resource} resource the resource being checked 
-     * @param {string} file the file where the resource came from
+     * @param {Object} props
+     * @param {string} props.source the source string
+     * @param {string} props.target the target string
+     * @param {Resource} props.resource the resource being checked 
+     * @param {string} props.file the file where the resource came from
      * @returns {Array.<Result>|undefined} the results
      */
     matchString({ source, target, resource, file }) {
@@ -98,7 +102,7 @@ class ResourceDNTTerms extends ResourceRule {
             rule: this,
             pathName: file,
             locale: resource.getTargetLocale(),
-            severity: "error",
+            severity: /** @ignore @type {const} */ ("error"),
             description: "A DNT term is missing in target string.",
         };
 

package/src/rules/ResourceEdgeWhitespace.js

@@ -25,7 +25,7 @@ class ResourceEdgeWhitespace extends ResourceRule {
     /** @readonly */ name = "resource-edge-whitespace";
     /** @readonly */ description =
         "Ensure that if there are whitespaces on edges of source string, matching ones are there in target as well";
-    /** @readonly */ link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-edge-whitespace.md";
+    /** @readonly */ link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-edge-whitespace.md";
 
     constructor() {
         super({});

package/src/rules/ResourceICUPluralTranslation.js

@@ -37,7 +37,7 @@ class ResourceICUPluralTranslation extends ResourceRule {
         this.name = "resource-icu-plurals-translated";
         this.description = "Ensure that plurals in translated resources are also translated";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-        this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-icu-plurals-translated.md";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-icu-plurals-translated.md";
     }
 
     /**

package/src/rules/ResourceICUPlurals.js

@@ -63,7 +63,7 @@ class ResourceICUPlurals extends ResourceRule {
         this.name = "resource-icu-plurals";
         this.description = "Ensure that plurals in translated resources have the correct syntax";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-        this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-icu-plurals.md";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-icu-plurals.md";
     }
 
     matchCategories(sourceSelect, targetSelect, locale, resource) {

package/src/rules/ResourceNoTranslation.js

@@ -30,7 +30,7 @@ import ResourceRule from './ResourceRule.js';
 class ResourceNoTranslation extends ResourceRule {
     #name = "resource-no-translation";
     #description = "Ensure that each resource in a resource file has a proper translation";
-    #link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-no-translation.md";
+    #link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-no-translation.md";
 
     /**
      * Make a new rule instance.

package/src/rules/ResourceQuoteStyle.js

@@ -33,7 +33,9 @@ import ResourceRule from './ResourceRule.js';
  * @prop {string} quoteEndAlt
  * @prop {RegExp} quotesNative
  * @prop {RegExp} quotesNativeAlt
- *
+ */
+
+/**
  * @typedef {BaseRegExpCollection} SourceRegExpCollection
  */
 
@@ -44,8 +46,10 @@ import ResourceRule from './ResourceRule.js';
  * @prop {RegExp} quotesAllAlt
  * @prop {string} nonQuoteChars
  * @prop {string} nonQuoteCharsAlt
- *
- * @typedef {BaseRegExpCollection & ExtendedRegExpCollection} TargetRegExpCollection
+ */
+
+/**
+ * @ignore @typedef {BaseRegExpCollection & ExtendedRegExpCollection} TargetRegExpCollection
  */
 
 /**
@@ -99,7 +103,7 @@ class ResourceQuoteStyle extends ResourceRule {
         this.name = "resource-quote-style";
         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";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-quote-style.md";
 
         if (options?.param === "localeOnly") {
             // only localized quotes are allowed in the target string

package/src/rules/ResourceSnakeCase.js

@@ -20,7 +20,7 @@ class ResourceSnakeCase extends ResourceRule {
 
         this.name = "resource-snake-case";
         this.description = "Ensure that when source strings contain only snake case and no whitespace, then the targets are the same";
-        this.link = "https://gihub.com/ilib-js/ilib-lint/blob/main/docs/resource-snake-case.md",
+        this.link = "https://gihub.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-snake-case.md",
         this.regexps = [
             "^\\s*[a-zA-Z0-9]*(_[a-zA-Z0-9]+)+\\s*$",
             "^\\s*[a-zA-Z0-9]+(_[a-zA-Z0-9]+)*_\\s*$"

package/src/rules/ResourceSourceICUPluralCategories.js

@@ -38,7 +38,7 @@ export class ResourceSourceICUPluralCategories extends ResourceRule {
     /** @override */
     description = "Verify that categories of an ICU plural in the source of a Resource are valid";
     /** @override */
-    link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-icu-plurals.md";
+    link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-icu-plurals.md";
 
     /**
      * @param {any} [opts]

package/src/rules/ResourceSourceICUPluralParams.js

@@ -38,7 +38,7 @@ export class ResourceSourceICUPluralParams extends ResourceRule {
     /** @override */
     description = "Verify that the 'one' category of an ICU plural contains the same replacement parameters as the 'other' category.";
     /** @override */
-    link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-icu-plural-params.md";
+    link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-icu-plural-params.md";
 
     /**
      * @param {any} [opts]

package/src/rules/ResourceSourceICUPluralSyntax.js

@@ -32,7 +32,7 @@ export class ResourceSourceICUPluralSyntax extends ResourceRule {
     /** @override */
     description = "Verify that syntax of an ICU plural in the source of a Resource is valid";
     /** @override */
-    link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-icu-plurals.md";
+    link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-icu-plurals.md";
 
     /**
      * @param {any} [opts]

package/src/rules/ResourceSourceICUUnexplainedParams.js

@@ -47,7 +47,7 @@ export class ResourceSourceICUUnexplainedParams extends ResourceRule {
         "Check if replacement parameters used in the source string are explained in the comments for translators.";
     /** @override */
     link =
-        "https://github.com/ilib-js/ilib-lint/blob/main/docs/source-icu-unexplained-params.md";
+        "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/source-icu-unexplained-params.md";
 
     /** @param {any} [opts] */
     constructor(opts) {
@@ -142,7 +142,7 @@ export class ResourceSourceICUUnexplainedParams extends ResourceRule {
     }
 
     /**
-     * @typedef {{
+     * @ignore @typedef {{
      *     element: MessageFormatElement;
      *     parent: undefined | ICUAstNode;
      * }} ICUAstNode
@@ -156,7 +156,7 @@ export class ResourceSourceICUUnexplainedParams extends ResourceRule {
      */
     traverseIcuAst(
         /** @type {MessageFormatElement[]} */ message,
-        /** @type {(node: ICUAstNode) => void} */ callback,
+        /** @ignore @type {(node: ICUAstNode) => void} */ callback,
         /** @type {ICUAstNode | undefined} */ parent
     ) {
         for (const element of message) {

package/src/rules/ResourceStateChecker.js

@@ -49,7 +49,7 @@ class ResourceStateChecker extends Rule {
         this.name = "resource-state-checker";
         this.description = "Ensure that resources have a particular state.";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-        this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-state-checker.md";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-state-checker.md";
 
         if (options) {
             if (typeof(options.param) === "string") {

package/src/rules/ResourceUniqueKeys.js

@@ -38,7 +38,7 @@ class ResourceUniqueKeys extends Rule {
         this.name = "resource-unique-keys";
         this.description = "Ensure that the keys are unique within a locale across all resource files";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-        this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-unique-keys.md";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-unique-keys.md";
         this.ts = new TranslationSet();
     }
 
@@ -89,4 +89,4 @@ class ResourceUniqueKeys extends Rule {
     }
 }
 
-export default ResourceUniqueKeys;
+export default ResourceUniqueKeys;

package/src/rules/ResourceXML.js

@@ -41,7 +41,7 @@ class ResourceXML extends ResourceRule {
         this.name = "resource-xml";
         this.description = "Ensure that XML in translated resources match the source";
         this.sourceLocale = (options && options.sourceLocale) || "en-US";
-        this.link = "https://github.com/ilib-js/ilib-lint/blob/main/docs/resource-xml.md";
+        this.link = "https://github.com/iLib-js/ilib-mono/blob/main/packages/ilib-lint/docs/resource-xml.md";
     }
 
     /**
@@ -241,4 +241,4 @@ class ResourceXML extends ResourceRule {
     }
 }
 
-export default ResourceXML;
+export default ResourceXML;

package/src/rules/utils.js

@@ -19,8 +19,11 @@
 
 import { IntlMessageFormat } from 'intl-messageformat';
 
+// type imports
+/** @ignore @typedef {import("@formatjs/icu-messageformat-parser").MessageFormatElement} MessageFormatElement */
+
 /** @returns {string} */
-function concatIntlAstText(/** @type {import("@formatjs/icu-messageformat-parser").MessageFormatElement[]} */ astElements) {
+function concatIntlAstText(/** @type {MessageFormatElement[]} */ astElements) {
     return astElements
         .map((element) => {
             switch (element.type) {