Merge branch 'master' into fix-tokenizer-onattribend

.github/workflows/dependabot-automerge.yml

@@ -13,7 +13,7 @@ jobs:
         steps:
             - name: Dependabot metadata
               id: metadata
-              uses: dependabot/fetch-metadata@v1.5.1
+              uses: dependabot/fetch-metadata@v1.6.0
               with:
                   github-token: "${{ secrets.GITHUB_TOKEN }}"
             - name: Enable auto-merge for Dependabot PRs

.github/workflows/nodejs-test.yml

@@ -62,7 +62,7 @@ jobs:
               if: matrix.node == env.NODE_COV
 
             - name: Run Coveralls
-              uses: coverallsapp/github-action@v2.1.2
+              uses: coverallsapp/github-action@v2.2.0
               if: matrix.node == env.NODE_COV
               continue-on-error: true
               with:

README.md

@@ -69,7 +69,7 @@ const parser = new htmlparser2.Parser({
     },
 });
 parser.write(
-    "Xyz <script type='text/javascript'>const foo = '<<bar>>';</script>"
+    "Xyz <script type='text/javascript'>const foo = '<<bar>>';</script>",
 );
 parser.end();
 ```

package.json

@@ -67,18 +67,18 @@
         "entities": "^4.5.0"
     },
     "devDependencies": {
-        "@types/jest": "^29.5.2",
-        "@types/node": "^20.2.5",
-        "@typescript-eslint/eslint-plugin": "^5.59.9",
-        "@typescript-eslint/parser": "^5.59.9",
-        "eslint": "^8.42.0",
+        "@types/jest": "^29.5.3",
+        "@types/node": "^20.4.1",
+        "@typescript-eslint/eslint-plugin": "^5.61.0",
+        "@typescript-eslint/parser": "^5.62.0",
+        "eslint": "^8.44.0",
         "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-n": "^16.0.0",
+        "eslint-plugin-n": "^16.0.1",
         "eslint-plugin-unicorn": "^47.0.0",
-        "jest": "^29.5.0",
-        "prettier": "^2.8.8",
-        "ts-jest": "^29.1.0",
-        "typescript": "^5.1.3"
+        "jest": "^29.6.1",
+        "prettier": "^3.0.0",
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.1.6"
     },
     "jest": {
         "preset": "ts-jest",

src/FeedHandler.spec.ts

@@ -12,28 +12,28 @@ describe("parseFeed", () => {
             parseFeed(
                 await fs.readFile(
                     path.join(documents, "RSS_Example.xml"),
-                    "utf8"
-                )
-            )
+                    "utf8",
+                ),
+            ),
         ).toMatchSnapshot());
 
     it("(atomFeed)", async () =>
         expect(
             parseFeed(
                 await fs.readFile(
                     path.join(documents, "Atom_Example.xml"),
-                    "utf8"
-                )
-            )
+                    "utf8",
+                ),
+            ),
         ).toMatchSnapshot());
 
     it("(rdfFeed)", async () =>
         expect(
             parseFeed(
                 await fs.readFile(
                     path.join(documents, "RDF_Example.xml"),
-                    "utf8"
-                )
-            )
+                    "utf8",
+                ),
+            ),
         ).toMatchSnapshot());
 });

src/Parser.spec.ts

@@ -16,11 +16,11 @@ describe("API", () => {
         p.end();
         p.write("foo");
         expect(cbs.onerror).toHaveBeenLastCalledWith(
-            new Error(".write() after done!")
+            new Error(".write() after done!"),
         );
         p.end();
         expect(cbs.onerror).toHaveBeenLastCalledWith(
-            new Error(".end() after done!")
+            new Error(".end() after done!"),
         );
 
         // Should ignore the error if there is no callback
@@ -156,7 +156,7 @@ describe("API", () => {
                     expect(parser.tokenizer).toBeInstanceOf(CustomTokenizer);
                 },
             },
-            { Tokenizer: CustomTokenizer }
+            { Tokenizer: CustomTokenizer },
         );
         p.done();
     });

src/Parser.ts

@@ -179,12 +179,12 @@ export interface Handler {
     onattribute(
         name: string,
         value: string,
-        quote?: string | undefined | null
+        quote?: string | undefined | null,
     ): void;
     onopentag(
         name: string,
         attribs: { [s: string]: string },
-        isImplied: boolean
+        isImplied: boolean,
     ): void;
     ontext(data: string): void;
     oncomment(data: string): void;
@@ -230,7 +230,7 @@ export class Parser implements Callbacks {
 
     constructor(
         cbs?: Partial<Handler> | null,
-        private readonly options: ParserOptions = {}
+        private readonly options: ParserOptions = {},
     ) {
         this.cbs = cbs ?? {};
         this.htmlMode = !this.options.xmlMode;
@@ -239,7 +239,7 @@ export class Parser implements Callbacks {
             options.lowerCaseAttributeNames ?? this.htmlMode;
         this.tokenizer = new (options.Tokenizer ?? Tokenizer)(
             this.options,
-            this
+            this,
         );
         this.foreignContext = [!this.htmlMode];
         this.cbs.onparserinit?.(this);
@@ -434,7 +434,7 @@ export class Parser implements Callbacks {
                 ? "'"
                 : quote === QuoteType.NoValue
                 ? undefined
-                : null
+                : null,
         );
 
         if (
@@ -565,7 +565,7 @@ export class Parser implements Callbacks {
 
         let slice = this.buffers[0].slice(
             start - this.bufferOffset,
-            end - this.bufferOffset
+            end - this.bufferOffset,
         );
 
         while (end - this.bufferOffset > this.buffers[0].length) {

src/Tokenizer.spec.ts

@@ -12,8 +12,8 @@ function tokenize(data: string, options = {}) {
                     return (...values: unknown[]) =>
                         log.push([property, ...values]);
                 },
-            }
-        ) as Callbacks
+            },
+        ) as Callbacks,
     );
 
     tokenizer.write(data);
@@ -76,14 +76,14 @@ describe("Tokenizer", () => {
             expect(
                 tokenize("&>&amp<üa&#x62c&#100&#101", {
                     xmlMode: true,
-                })
+                }),
             ).toMatchSnapshot());
 
         it("for entities in attributes (#276)", () =>
             expect(
                 tokenize(
-                    '<img src="?&image_uri=1&&image;=2&image=3"/>?&image_uri=1&&image;=2&image=3'
-                )
+                    '<img src="?&image_uri=1&&image;=2&image=3"/>?&image_uri=1&&image;=2&image=3',
+                ),
             ).toMatchSnapshot());
 
         it("for trailing legacy entity", () =>
@@ -108,8 +108,8 @@ describe("Tokenizer", () => {
                             log.push([property, ...values]);
                         };
                     },
-                }
-            ) as Callbacks
+                },
+            ) as Callbacks,
         );
 
         tokenizer.write("&am");

src/Tokenizer.ts

@@ -165,13 +165,13 @@ export default class Tokenizer {
             xmlMode = false,
             decodeEntities = true,
         }: { xmlMode?: boolean; decodeEntities?: boolean },
-        private readonly cbs: Callbacks
+        private readonly cbs: Callbacks,
     ) {
         this.xmlMode = xmlMode;
         this.decodeEntities = decodeEntities;
         this.entityDecoder = new EntityDecoder(
             xmlMode ? xmlDecodeTree : htmlDecodeTree,
-            (cp, consumed) => this.emitCodePoint(cp, consumed)
+            (cp, consumed) => this.emitCodePoint(cp, consumed),
         );
     }
 
@@ -507,7 +507,7 @@ export default class Tokenizer {
                 quote === CharCodes.DoubleQuote
                     ? QuoteType.Double
                     : QuoteType.Single,
-                this.index + 1
+                this.index + 1,
             );
             this.state = State.BeforeAttributeName;
         } else if (this.decodeEntities && c === CharCodes.Amp) {
@@ -596,14 +596,14 @@ export default class Tokenizer {
                 : this.baseState === State.Text ||
                   this.baseState === State.InSpecialTag
                 ? DecodingMode.Legacy
-                : DecodingMode.Attribute
+                : DecodingMode.Attribute,
         );
     }
 
     private stateInEntity(): void {
         const length = this.entityDecoder.write(
             this.buffer,
-            this.index - this.offset
+            this.index - this.offset,
         );
 
         // If `length` is positive, we are done with the entity.

src/WritableStream.spec.ts

@@ -29,7 +29,7 @@ describe("WritableStream", () => {
 
 function getPromiseEventCollector(): [
     handler: Partial<Handler>,
-    promise: Promise<unknown>
+    promise: Promise<unknown>,
 ] {
     let handler: Partial<Handler> | undefined;
     const promise = new Promise<unknown>((resolve, reject) => {
@@ -54,14 +54,14 @@ function finished(input: Parameters<typeof stream.finished>[0]): Promise<void> {
 
 async function testStream(
     file: string,
-    options?: ParserOptions
+    options?: ParserOptions,
 ): Promise<void> {
     const filePath = path.join(__dirname, "__fixtures__", "Documents", file);
 
     const [streamHandler, eventsPromise] = getPromiseEventCollector();
 
     const fsStream = createReadStream(filePath).pipe(
-        new WritableStream(streamHandler, options)
+        new WritableStream(streamHandler, options),
     );
 
     await finished(fsStream);
@@ -73,7 +73,7 @@ async function testStream(
     const [singlePassHandler, singlePassPromise] = getPromiseEventCollector();
 
     const singlePassStream = new WritableStream(singlePassHandler, options).end(
-        await fs.readFile(filePath)
+        await fs.readFile(filePath),
     );
 
     await finished(singlePassStream);

src/WritableStream.ts

@@ -28,10 +28,10 @@ export class WritableStream extends Writable {
     override _write(
         chunk: string | Buffer,
         encoding: string,
-        callback: () => void
+        callback: () => void,
     ): void {
         this._parser.write(
-            isBuffer(chunk, encoding) ? this._decoder.write(chunk) : chunk
+            isBuffer(chunk, encoding) ? this._decoder.write(chunk) : chunk,
         );
         callback();
     }

src/__fixtures__/test-helper.ts

@@ -15,7 +15,7 @@ interface Event {
  * @param callback Function to call with all events.
  */
 export function getEventCollector(
-    callback: (error: Error | null, events?: Event[]) => void
+    callback: (error: Error | null, events?: Event[]) => void,
 ): Partial<Handler> {
     const events: Event[] = [];
     let parser: Parser;
@@ -63,7 +63,7 @@ export function getEventCollector(
 
                 if (!(parser.startIndex <= parser.endIndex)) {
                     throw new Error(
-                        `Invalid start/end index ${parser.startIndex} > ${parser.endIndex}`
+                        `Invalid start/end index ${parser.startIndex} > ${parser.endIndex}`,
                     );
                 }
 
@@ -86,6 +86,6 @@ export function getEventCollector(
                 (_, event: string) =>
                 (...data: unknown[]) =>
                     handle(event, data),
-        }
+        },
     );
 }