iLib-js · ehoogerbeets · Jan 15, 2025 · Jan 17, 2025 · Jan 18, 2025 · Jan 18, 2025
diff --git a/.changeset/strange-tables-shop.md b/.changeset/strange-tables-shop.md
@@ -0,0 +1,22 @@
+---
+"ilib-lint": minor
+---
+
+- Added the ability to write files out again if they
+  are modified and a serializer is available
+  - added the --write flag to cause the write to happen
+  - added the --overwrite flag to cause it to overwrite
+    the original file (otherwise, it writes to another
+    parallel file)
+  - modified the ouput of --list to output the names
+    of known serializers that are built-in or loaded from
+    plugins
+  - file type definitions can now include a property that
+    names the serializer to use to write out files of
+    that type
+  - file type definitions can now only use plugins that
+    operate on the same type of intermediate representation
+    types. That is, you cannot specify a parser that produces
+    a "line" representation type, and then a serializer
+    that accepts a "resource" representation type. They all
+    have to be "line" or "resource".
diff --git a/.changeset/witty-icons-laugh.md b/.changeset/witty-icons-laugh.md
@@ -0,0 +1,12 @@
+---
+"ilib-lint-common": minor
+---
+
+- Updated Serializer API and clarified docs
+- Added the ability for SourceFile.write() to make the
+  directories along the path where it wants to write
+  the file if they don't exist already.
+- Added unit tests for SourceFile.write()
+- Updated Transformer API to add a results parameter
+  to the transform() function so that the transformer
+  can do things based on these results
diff --git a/packages/ilib-lint-common/docs/FileStats.html b/packages/ilib-lint-common/docs/FileStats.html
@@ -1636,7 +1636,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/FileStats.js.html b/packages/ilib-lint-common/docs/FileStats.js.html
@@ -219,7 +219,7 @@ <h1 class="page-title">FileStats.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Fix.html b/packages/ilib-lint-common/docs/Fix.html
@@ -420,7 +420,7 @@ <h5 class="h5-types">Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Fix.js.html b/packages/ilib-lint-common/docs/Fix.js.html
@@ -192,7 +192,7 @@ <h1 class="page-title">Fix.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Fixer.html b/packages/ilib-lint-common/docs/Fixer.html
@@ -548,7 +548,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Fixer.js.html b/packages/ilib-lint-common/docs/Fixer.js.html
@@ -163,7 +163,7 @@ <h1 class="page-title">Fixer.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Formatter.html b/packages/ilib-lint-common/docs/Formatter.html
@@ -1122,7 +1122,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Formatter.js.html b/packages/ilib-lint-common/docs/Formatter.js.html
@@ -154,7 +154,7 @@ <h1 class="page-title">Formatter.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/IntermediateRepresentation.html b/packages/ilib-lint-common/docs/IntermediateRepresentation.html
@@ -1041,7 +1041,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/IntermediateRepresentation.js.html b/packages/ilib-lint-common/docs/IntermediateRepresentation.js.html
@@ -165,7 +165,7 @@ <h1 class="page-title">IntermediateRepresentation.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/NotImplementedError.html b/packages/ilib-lint-common/docs/NotImplementedError.html
@@ -182,7 +182,7 @@ <h4 class="name" id="NotImplementedError"><span class="type-signature"></span>ne
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/NotImplementedError.js.html b/packages/ilib-lint-common/docs/NotImplementedError.js.html
@@ -87,7 +87,7 @@ <h1 class="page-title">NotImplementedError.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Parser.html b/packages/ilib-lint-common/docs/Parser.html
@@ -738,7 +738,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Parser.js.html b/packages/ilib-lint-common/docs/Parser.js.html
@@ -172,7 +172,7 @@ <h1 class="page-title">Parser.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/PipelineElement.html b/packages/ilib-lint-common/docs/PipelineElement.html
@@ -1148,7 +1148,7 @@ <h4 class="name" id="init"><span class="type-signature"></span>init<span class="
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/PipelineElement.js.html b/packages/ilib-lint-common/docs/PipelineElement.js.html
@@ -208,7 +208,7 @@ <h1 class="page-title">PipelineElement.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Plugin.html b/packages/ilib-lint-common/docs/Plugin.html
@@ -1215,7 +1215,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Plugin.js.html b/packages/ilib-lint-common/docs/Plugin.js.html
@@ -217,7 +217,7 @@ <h1 class="page-title">Plugin.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Result.html b/packages/ilib-lint-common/docs/Result.html
@@ -1819,7 +1819,7 @@ <h5 class="h5-types">Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Result.js.html b/packages/ilib-lint-common/docs/Result.js.html
@@ -265,7 +265,7 @@ <h1 class="page-title">Result.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Rule.html b/packages/ilib-lint-common/docs/Rule.html
@@ -1713,7 +1713,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Rule.js.html b/packages/ilib-lint-common/docs/Rule.js.html
@@ -277,7 +277,7 @@ <h1 class="page-title">Rule.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/packages/ilib-lint-common/docs/Serializer.html b/packages/ilib-lint-common/docs/Serializer.html
@@ -244,7 +244,8 @@ <h6>Properties</h6>
 
 
 
-            <td class="description last"><p>a callback function provided by</p></td>
+            <td class="description last"><p>a callback function provided by the linter
+to retrieve the log4js logger</p></td>
         </tr>
 
 
@@ -279,7 +280,7 @@ <h6>Properties</h6>
 
 
             <td class="description last"><p>additional settings that can be passed to the serializer
-the linter to retrieve the log4js logger</p></td>
+implementation</p></td>
         </tr>
 
 
@@ -337,7 +338,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id="serialize"><span class="type-signature type-signature-abstract">(abstract) </span>serialize<span class="signature">(representation)</span><span class="type-signature"> &rarr; {<a href="SourceFile.html">SourceFile</a>}</span></h4>
+    <h4 class="name" id="serialize"><span class="type-signature type-signature-abstract">(abstract) </span>serialize<span class="signature">(representations)</span><span class="type-signature"> &rarr; {<a href="SourceFile.html">SourceFile</a>}</span></h4>
 
 
 
@@ -353,13 +354,18 @@ <h4 class="name" id="serialize"><span class="type-signature type-signature-abstr
 that can be written back to disk. For example, an xliff serializer can take
 an intermediate representation that is an array of Resource instances and
 convert it into xliff file format and set that as the content of the SourceFile
-it produces.</p></li></ul></dd>
+it produces.</p>
+<p>The type of the intermediate representation that this serializer can handle
+is specified in the <code>type</code> property of this instance passed to the constructor.
+The linter will only allow this serializer to be used for intermediate
+representations of that type so they must match. The source file that is
+returned must have the same type as the intermediate representation.</p></li></ul></dd>
 
 
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Serializer.js.html">Serializer.js</a>, <a href="Serializer.js.html#line67">line 67</a>
+        <a href="Serializer.js.html">Serializer.js</a>, <a href="Serializer.js.html#line74">line 74</a>
     </li></ul></dd>
 
 
@@ -431,13 +437,13 @@ <h5 class="h5-parameters">Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>representation</code></td>
+                <td class="name"><code>representations</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type"><a href="IntermediateRepresentation.html">IntermediateRepresentation</a></span>
+<span class="param-type">Array.&lt;<a href="IntermediateRepresentation.html">IntermediateRepresentation</a>></span>
 
 
 
@@ -448,8 +454,8 @@ <h5 class="h5-parameters">Parameters:</h5>
 
 
 
-            <td class="description last"><p>the representation
-to serialize</p></td>
+            <td class="description last"><p>the array of intermediate
+representations to serialize</p></td>
         </tr>
 
 
@@ -518,7 +524,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Thu Dec 19 2024 16:53:40 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 17:04:17 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>