parse5-plain-text-conversion-stream 5.1.1 → 7.0.0

package/README.md

@@ -15,9 +15,8 @@
 </div>
 <br>
 
-
 <p align="center">
-  📖 <a href="https://github.com/inikulin/parse5/tree/master/packages/parse5-plain-text-conversion-stream/docs/index.md"><b>Documentation</b></a> 📖
+  📖 <a href="https://parse5.js.org/modules/parse5_plain_text_conversion_stream.html"><b>Documentation</b></a> 📖
 </p>
 
 ---
@@ -31,5 +30,5 @@
 </p>
 
 <p align="center">
-    <a href="https://github.com/inikulin/parse5/tree/master/docs/version-history.md">Version history</a>
+    <a href="https://github.com/inikulin/parse5/releases">Changelog</a>
 </p>

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { type ParserOptions, type TreeAdapterTypeMap } from 'parse5';
+import { ParserStream } from 'parse5-parser-stream';
+/**
+ * Converts plain text files into HTML document as required by [HTML specification](https://html.spec.whatwg.org/#read-text).
+ * A [writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable).
+ *
+ * @example
+ *
+ * ```js
+ * const PlainTextConversionStream = require('parse5-plain-text-conversion-stream');
+ * const fs = require('fs');
+ * const { finished } = require('node:stream');
+ *
+ * const file = fs.createReadStream('war_and_peace.txt');
+ * const converter = new PlainTextConversionStream();
+ *
+ * finished(converter, () => {
+ *     console.log(converter.document.childNodes[1].childNodes[0].tagName); //> 'head'
+ * });
+ *
+ * file.pipe(converter);
+ * ```
+ */
+export declare class PlainTextConversionStream<T extends TreeAdapterTypeMap> extends ParserStream<T> {
+    constructor(options?: ParserOptions<T>);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,38 @@
+import { html } from 'parse5';
+import { ParserStream } from 'parse5-parser-stream';
+const { TAG_ID: $, TAG_NAMES: TN } = html;
+/**
+ * Converts plain text files into HTML document as required by [HTML specification](https://html.spec.whatwg.org/#read-text).
+ * A [writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable).
+ *
+ * @example
+ *
+ * ```js
+ * const PlainTextConversionStream = require('parse5-plain-text-conversion-stream');
+ * const fs = require('fs');
+ * const { finished } = require('node:stream');
+ *
+ * const file = fs.createReadStream('war_and_peace.txt');
+ * const converter = new PlainTextConversionStream();
+ *
+ * finished(converter, () => {
+ *     console.log(converter.document.childNodes[1].childNodes[0].tagName); //> 'head'
+ * });
+ *
+ * file.pipe(converter);
+ * ```
+ */
+export class PlainTextConversionStream extends ParserStream {
+    constructor(options) {
+        super(options);
+        // NOTE: see https://html.spec.whatwg.org/#read-text
+        this.parser._insertFakeElement(TN.HTML, $.HTML);
+        this.parser._insertFakeElement(TN.HEAD, $.HEAD);
+        this.parser.openElements.pop();
+        this.parser._insertFakeElement(TN.BODY, $.BODY);
+        this.parser._insertFakeElement(TN.PRE, $.PRE);
+        this.parser.treeAdapter.insertText(this.parser.openElements.current, '\n');
+        this.parser.switchToPlaintextParsing();
+    }
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,10 +1,12 @@
 {
     "name": "parse5-plain-text-conversion-stream",
+    "type": "module",
     "description": "Stream that converts plain text files into HTML document.",
-    "version": "5.1.1",
+    "version": "7.0.0",
     "author": "Ivan Nikulin <ifaaan@gmail.com> (https://github.com/inikulin)",
     "contributors": "https://github.com/inikulin/parse5/graphs/contributors",
     "homepage": "https://github.com/inikulin/parse5",
+    "funding": "https://github.com/inikulin/parse5?sponsor=1",
     "keywords": [
         "parse5",
         "parser",
@@ -15,17 +17,20 @@
         "plain text"
     ],
     "license": "MIT",
-    "main": "./lib/index.js",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": "./dist/index.js",
     "dependencies": {
-        "parse5": "^5.1.1",
-        "parse5-parser-stream": "^5.1.1"
+        "parse5": "^7.0.0",
+        "parse5-parser-stream": "^7.0.0"
     },
     "repository": {
         "type": "git",
         "url": "git://github.com/inikulin/parse5.git"
     },
     "files": [
-        "lib"
-    ],
-    "gitHead": "9c7556ed05e4ff4d884ab2447e27ce3817c42e79"
+        "dist",
+        "!*.map"
+    ]
 }

package/lib/index.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const ParserStream = require('parse5-parser-stream');
-const $ = require('parse5/lib/common/html').TAG_NAMES;
-
-class PlainTextConversionStream extends ParserStream {
-    constructor(options) {
-        super(options);
-
-        // NOTE: see https://html.spec.whatwg.org/#read-text
-        this.parser._insertFakeElement($.HTML);
-        this.parser._insertFakeElement($.HEAD);
-        this.parser.openElements.pop();
-        this.parser._insertFakeElement($.BODY);
-        this.parser._insertFakeElement($.PRE);
-        this.parser.treeAdapter.insertText(this.parser.openElements.current, '\n');
-        this.parser.switchToPlaintextParsing();
-    }
-}
-
-module.exports = PlainTextConversionStream;