ilib-tools-common: add common escaping and unescaping routines (#72)

- these have been extracted from the various loctool plugins, then fact-checked against the documentation for each programming language, generalized, and fit into a common API - escaperFactory generates the correct escaper instance for the given programming language - intended to be used by any of the loctool and ilib-lint plugins eventually
iLib-js · Mar 5, 2025 · c5ee237 · c5ee237
1 parent 5e58323
commit c5ee237
Show file tree

Hide file tree

Showing 65 changed files with 14,485 additions and 244 deletions.
diff --git a/.changeset/soft-apricots-pull.md b/.changeset/soft-apricots-pull.md
@@ -0,0 +1,15 @@
+---
+"ilib-tools-common": minor
+---
+
+- Added Escaper class to the tools library
+  - escaperFactory() generates the appropriate escaper instance
+    for the given programming language/syntax
+  - Escaper.unescape() takes a string as it would be encoded in
+    a source file, and transforms it into how it would be
+    represented in memory while the program is running
+  - Escaper.escape() does the converse
+  - original code was extracted from various loctool plugins
+  - this library is intended to be used with any loctool or ilib-lint
+    plugin so that we do escaping/unescaping the same way no
+    matter which plugin we are using
diff --git a/packages/ilib-tools-common/docs/CSharpEscaper.html b/packages/ilib-tools-common/docs/CSharpEscaper.html
diff --git a/packages/ilib-tools-common/docs/DirectoryWalk.js.html b/packages/ilib-tools-common/docs/DirectoryWalk.js.html
diff --git a/packages/ilib-tools-common/docs/Escaper.html b/packages/ilib-tools-common/docs/Escaper.html
diff --git a/packages/ilib-tools-common/docs/EscaperFactory.js.html b/packages/ilib-tools-common/docs/EscaperFactory.js.html
diff --git a/packages/ilib-tools-common/docs/JavaEscaper.html b/packages/ilib-tools-common/docs/JavaEscaper.html
diff --git a/packages/ilib-tools-common/docs/JavascriptEscaper.html b/packages/ilib-tools-common/docs/JavascriptEscaper.html
diff --git a/packages/ilib-tools-common/docs/JsonEscaper.html b/packages/ilib-tools-common/docs/JsonEscaper.html
diff --git a/packages/ilib-tools-common/docs/Location.html b/packages/ilib-tools-common/docs/Location.html
diff --git a/packages/ilib-tools-common/docs/Location.js.html b/packages/ilib-tools-common/docs/Location.js.html
diff --git a/packages/ilib-tools-common/docs/PHPEscaper.html b/packages/ilib-tools-common/docs/PHPEscaper.html
diff --git a/packages/ilib-tools-common/docs/PythonEscaper.html b/packages/ilib-tools-common/docs/PythonEscaper.html
diff --git a/packages/ilib-tools-common/docs/RegexBasedEscaper.html b/packages/ilib-tools-common/docs/RegexBasedEscaper.html
diff --git a/packages/ilib-tools-common/docs/Resource.html b/packages/ilib-tools-common/docs/Resource.html
diff --git a/packages/ilib-tools-common/docs/Resource.js.html b/packages/ilib-tools-common/docs/Resource.js.html
diff --git a/packages/ilib-tools-common/docs/ResourceArray.html b/packages/ilib-tools-common/docs/ResourceArray.html
diff --git a/packages/ilib-tools-common/docs/ResourceArray.js.html b/packages/ilib-tools-common/docs/ResourceArray.js.html
diff --git a/packages/ilib-tools-common/docs/ResourceConvert.js.html b/packages/ilib-tools-common/docs/ResourceConvert.js.html
diff --git a/packages/ilib-tools-common/docs/ResourcePlural.html b/packages/ilib-tools-common/docs/ResourcePlural.html
diff --git a/packages/ilib-tools-common/docs/ResourcePlural.js.html b/packages/ilib-tools-common/docs/ResourcePlural.js.html
diff --git a/packages/ilib-tools-common/docs/ResourceString.html b/packages/ilib-tools-common/docs/ResourceString.html
diff --git a/packages/ilib-tools-common/docs/ResourceString.js.html b/packages/ilib-tools-common/docs/ResourceString.js.html
diff --git a/packages/ilib-tools-common/docs/ResourceXliff.html b/packages/ilib-tools-common/docs/ResourceXliff.html
diff --git a/packages/ilib-tools-common/docs/ResourceXliff.js.html b/packages/ilib-tools-common/docs/ResourceXliff.js.html
diff --git a/packages/ilib-tools-common/docs/SmartyEscaper.html b/packages/ilib-tools-common/docs/SmartyEscaper.html
diff --git a/packages/ilib-tools-common/docs/SwiftEscaper.html b/packages/ilib-tools-common/docs/SwiftEscaper.html
diff --git a/packages/ilib-tools-common/docs/TranslationSet.html b/packages/ilib-tools-common/docs/TranslationSet.html
diff --git a/packages/ilib-tools-common/docs/TranslationSet.js.html b/packages/ilib-tools-common/docs/TranslationSet.js.html
diff --git a/packages/ilib-tools-common/docs/TranslationUnit.html b/packages/ilib-tools-common/docs/TranslationUnit.html
diff --git a/packages/ilib-tools-common/docs/TranslationUnit.js.html b/packages/ilib-tools-common/docs/TranslationUnit.js.html
diff --git a/packages/ilib-tools-common/docs/TranslationVariant.html b/packages/ilib-tools-common/docs/TranslationVariant.html
diff --git a/packages/ilib-tools-common/docs/TranslationVariant.js.html b/packages/ilib-tools-common/docs/TranslationVariant.js.html
diff --git a/packages/ilib-tools-common/docs/URIEscaper.html b/packages/ilib-tools-common/docs/URIEscaper.html
diff --git a/packages/ilib-tools-common/docs/escapes_CSharpEscaper.js.html b/packages/ilib-tools-common/docs/escapes_CSharpEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_EscapeCommon.js.html b/packages/ilib-tools-common/docs/escapes_EscapeCommon.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_Escaper.js.html b/packages/ilib-tools-common/docs/escapes_Escaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_JavaEscaper.js.html b/packages/ilib-tools-common/docs/escapes_JavaEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_JavascriptEscaper.js.html b/packages/ilib-tools-common/docs/escapes_JavascriptEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_JsonEscaper.js.html b/packages/ilib-tools-common/docs/escapes_JsonEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_PHPEscaper.js.html b/packages/ilib-tools-common/docs/escapes_PHPEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_PythonEscaper.js.html b/packages/ilib-tools-common/docs/escapes_PythonEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_RegexBasedEscaper.js.html b/packages/ilib-tools-common/docs/escapes_RegexBasedEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_SmartyEscaper.js.html b/packages/ilib-tools-common/docs/escapes_SmartyEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_SwiftEscaper.js.html b/packages/ilib-tools-common/docs/escapes_SwiftEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/escapes_URIEscaper.js.html b/packages/ilib-tools-common/docs/escapes_URIEscaper.js.html
diff --git a/packages/ilib-tools-common/docs/global.html b/packages/ilib-tools-common/docs/global.html