Merge pull request #78 from posthtml/milestone-0.10.0

Milestone 0.10.0

Author: Scrum

changelog.md

@@ -1,5 +1,14 @@
+## 0.10.0 (2021-07-28)
+
+* refactor: parse now export not default ([f8ae42d](https://github.com/posthtml/posthtml-parser/commit/f8ae42d))
+* perf: resolve types ([9ed9bd0](https://github.com/posthtml/posthtml-parser/commit/9ed9bd0))
+
+
+
 ## <small>0.9.1 (2021-07-26)</small>
 
+* 0.9.1 ([a03017e](https://github.com/posthtml/posthtml-parser/commit/a03017e))
+* Update readme.md ([7081062](https://github.com/posthtml/posthtml-parser/commit/7081062))
 * test: dom nest parsing issues #76 ([fdfe82e](https://github.com/posthtml/posthtml-parser/commit/fdfe82e)), closes [#76](https://github.com/posthtml/posthtml-parser/issues/76)
 * test: remove only ([78b7fc7](https://github.com/posthtml/posthtml-parser/commit/78b7fc7))
 * style: after prettier ([ccbfd69](https://github.com/posthtml/posthtml-parser/commit/ccbfd69))
@@ -10,7 +19,6 @@
 * build(deps): bump lodash from 4.17.20 to 4.17.21 ([e9b8d04](https://github.com/posthtml/posthtml-parser/commit/e9b8d04))
 * build(deps): bump normalize-url from 4.5.0 to 4.5.1 ([9e0d1f9](https://github.com/posthtml/posthtml-parser/commit/9e0d1f9))
 * perf: type for replace ([94ebb8d](https://github.com/posthtml/posthtml-parser/commit/94ebb8d))
-* Update readme.md ([7081062](https://github.com/posthtml/posthtml-parser/commit/7081062))
 
 
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "posthtml-parser",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Parse HTML/XML to PostHTMLTree",
   "license": "MIT",
   "repository": "posthtml/posthtml-parser",
@@ -25,7 +25,7 @@
   },
   "scripts": {
     "version": "conventional-changelog -i changelog.md -s -r 0 && git add changelog.md",
-    "build": "rm -rf dist && tsup src/*.ts --minify",
+    "build": "rm -rf dist && tsup src/*.ts --dts --minify",
     "dev": "npm run build -- --watch",
     "test": "xo && c8 ava",
     "pretest": "clinton",
@@ -62,5 +62,5 @@
     "typescript": "^4.0.5",
     "xo": "^0.37.1"
   },
-  "types": "types/index.d.ts"
+  "types": "dist/index.d.ts"
 }

package.json

@@ -22,7 +22,7 @@ $ npm install posthtml-parser
 </a>
 ```
 ```js
-import parser from 'posthtml-parser'
+import { parser } from 'posthtml-parser'
 import fs from 'fs'
 
 const html = fs.readFileSync('path/to/input.html', 'utf-8')

readme.md

@@ -1,6 +1,30 @@
 import { Parser, ParserOptions } from 'htmlparser2';
-import { Directive, Node, NodeTag, Options, Attributes } from '../types/index.d';
-import { LocationTracker } from './location-tracker';
+import { LocationTracker, SourceLocation } from './location-tracker';
+
+export type Directive = {
+  name: string | RegExp;
+  start: string;
+  end: string;
+};
+
+export type Options = {
+  directives?: Directive[];
+  sourceLocations?: boolean;
+} & ParserOptions;
+
+export type Tag = string | boolean;
+export type Attributes = Record<string, string | number | boolean>;
+export type Content = NodeText | Array<Node | Node[]>;
+
+export type NodeText = string | number;
+export type NodeTag = {
+  tag?: Tag;
+  attrs?: Attributes;
+  content?: Content;
+  location?: SourceLocation;
+};
+
+export type Node = NodeText | NodeTag;
 
 const defaultOptions: ParserOptions = {
   lowerCaseTags: false,
@@ -16,7 +40,7 @@ const defaultDirectives: Directive[] = [
   }
 ];
 
-const parser = (html: string, options: Options = {}): Node[] => {
+export const parser = (html: string, options: Options = {}): Node[] => {
   const locationTracker = new LocationTracker(html);
   const bufArray: Node[] = [];
   const results: Node[] = [];
@@ -53,7 +77,7 @@ const parser = (html: string, options: Options = {}): Node[] => {
 
   function onprocessinginstruction(name: string, data: string) {
     const directives = defaultDirectives.concat(options.directives ?? []);
-    const last: Node = bufferArrayLast();
+    const last = bufferArrayLast();
 
     for (const directive of directives) {
       const directiveText = directive.start + data + directive.end;
@@ -69,15 +93,17 @@ const parser = (html: string, options: Options = {}): Node[] => {
             last.content = [];
           }
 
-          last.content.push(directiveText);
+          if (Array.isArray(last.content)) {
+            last.content.push(directiveText);
+          }
         }
       }
     }
   }
 
   function oncomment(data: string) {
-    const comment = `<!--${data}-->`;
     const last = bufferArrayLast();
+    const comment = `<!--${data}-->`;
 
     if (last === undefined) {
       results.push(comment);
@@ -89,7 +115,9 @@ const parser = (html: string, options: Options = {}): Node[] => {
         last.content = [];
       }
 
-      last.content.push(comment);
+      if (Array.isArray(last.content)) {
+        last.content.push(comment);
+      }
     }
   }
 
@@ -131,7 +159,9 @@ const parser = (html: string, options: Options = {}): Node[] => {
           last.content = [];
         }
 
-        last.content.push(buf);
+        if (Array.isArray(last.content)) {
+          last.content.push(buf);
+        }
       }
     }
   }
@@ -145,7 +175,7 @@ const parser = (html: string, options: Options = {}): Node[] => {
     }
 
     if (typeof last === 'object') {
-      if (last.content && last.content.length > 0) {
+      if (last.content && Array.isArray(last.content) && last.content.length > 0) {
         const lastContentNode = last.content[last.content.length - 1];
         if (typeof lastContentNode === 'string' && !lastContentNode.startsWith('<!--')) {
           last.content[last.content.length - 1] = `${lastContentNode}${text}`;
@@ -157,7 +187,9 @@ const parser = (html: string, options: Options = {}): Node[] => {
         last.content = [];
       }
 
-      last.content.push(text);
+      if (Array.isArray(last.content)) {
+        last.content.push(text);
+      }
     }
   }
 
@@ -174,5 +206,3 @@ const parser = (html: string, options: Options = {}): Node[] => {
 
   return results;
 };
-
-export default parser;

src/index.ts

@@ -1,4 +1,12 @@
-import { Position } from '../types/index.d';
+export type SourceLocation = {
+  start: Position;
+  end: Position;
+};
+
+export type Position = {
+  line: number;
+  column: number;
+};
 
 export class LocationTracker {
   private readonly source: string;

src/location-tracker.ts

@@ -1,5 +1,5 @@
 import test from 'ava';
-import parser from '../src';
+import { parser } from '../src';
 
 test('should be parse doctype in uppercase', t => {
   const tree = parser('<!DOCTYPE html>');