Rename allowInElementComments option to allowStartTagComments, Move the attribute comment to the HTML AST angular@826017d

Author: fisker

packages/angular-html-parser/src/index.ts

@@ -17,11 +17,11 @@ export interface HtmlParseOptions {
    */
   allowHtmComponentClosingTags?: boolean;
   /**
-   * allow in-element comments
+   * allow comments in start tag
    *
    * defaults to false
    */
-  allowInElementComments?: boolean;
+  allowStartTagComments?: boolean;
   /**
    * do not lowercase tag names before querying their tag definitions
    *
@@ -62,7 +62,7 @@ export function parseHtml(
   const {
     canSelfClose = false,
     allowHtmComponentClosingTags = false,
-    allowInElementComments = false,
+    allowStartTagComments = false,
     isTagNameCaseSensitive = false,
     getTagContentType,
     tokenizeAngularBlocks = false,
@@ -78,7 +78,7 @@ export function parseHtml(
       tokenizeExpansionForms: tokenizeAngularBlocks,
       canSelfClose,
       allowHtmComponentClosingTags,
-      allowInElementComments,
+      allowStartTagComments,
       tokenizeBlocks: tokenizeAngularBlocks,
       tokenizeLet: tokenizeAngularLetDeclaration,
       selectorlessEnabled: enableAngularSelectorlessSyntax,

packages/angular-html-parser/test/index_spec.ts

@@ -243,25 +243,41 @@ describe("AST format", () => {
   });
 });
 
-it("in-element comments", () => {
+it("Start tag comments", () => {
   expect(parse("<div/* comment */></div>").errors[0]).toMatchInlineSnapshot(
     `[Error: Opening tag "div" not terminated.]`,
   );
   expect(
-    humanizeDom(
-      parse("<div/* block comment */></div>", { allowInElementComments: true }),
-    ),
+    parse("<div/* block comment */></div>", { allowStartTagComments: true })
+      .rootNodes,
   ).toEqual([
-    [ast.Comment, " block comment ", 0],
-    [ast.Element, "div", 0],
+    expect.objectContaining({
+      kind: "element",
+      name: "div",
+      comments: [
+        expect.objectContaining({
+          kind: "startTagComment",
+          type: "multi",
+          value: " block comment ",
+        }),
+      ],
+    }),
   ]);
   expect(
-    humanizeDom(
-      parse("<div// line comment\n></div>", { allowInElementComments: true }),
-    ),
+    parse("<div// line comment\n></div>", { allowStartTagComments: true })
+      .rootNodes,
   ).toEqual([
-    [ast.Comment, " line comment", 0],
-    [ast.Element, "div", 0],
+    expect.objectContaining({
+      kind: "element",
+      name: "div",
+      comments: [
+        expect.objectContaining({
+          kind: "startTagComment",
+          type: "single",
+          value: " line comment",
+        }),
+      ],
+    }),
   ]);
 });
 

packages/compiler/src/ml_parser/ast.ts

@@ -134,6 +134,7 @@ export class StartTagComment implements BaseNode {
   visit(visitor: Visitor, context: any): any {
     return visitor.visitAttributeComment ? visitor.visitAttributeComment(this, context) : undefined;
   }
+  readonly kind = 'startTagComment';
 }
 
 export class Element extends NodeWithI18n {
@@ -171,7 +172,10 @@ export class Comment implements BaseNode {
 }
 
 export class DocType implements BaseNode {
-  constructor(public value: string|null, public sourceSpan: ParseSourceSpan) {}
+  constructor(
+    public value: string | null,
+    public sourceSpan: ParseSourceSpan,
+  ) {}
   visit(visitor: Visitor, context: any): any {
     return visitor.visitDocType(this, context);
   }

packages/compiler/src/ml_parser/lexer.ts

@@ -107,7 +107,7 @@ export interface TokenizeOptions {
 
   canSelfClose?: boolean;
   allowHtmComponentClosingTags?: boolean;
-  allowInElementComments?: boolean,
+  allowStartTagComments?: boolean,
 }
 
 export function tokenize(
@@ -171,7 +171,7 @@ class _Tokenizer {
   private _leadingTriviaCodePoints: number[] | undefined;
   private _canSelfClose: boolean;
   private _allowHtmComponentClosingTags: boolean;
-  private _allowInElementComments: boolean;
+  private _allowStartTagComments: boolean;
   private _currentTokenStart: CharacterCursor | null = null;
   private _currentTokenType: TokenType | null = null;
   private _expansionCaseStack: TokenType[] = [];
@@ -205,7 +205,7 @@ class _Tokenizer {
       options.leadingTriviaChars && options.leadingTriviaChars.map((c) => c.codePointAt(0) || 0);
     this._canSelfClose = options.canSelfClose || false;
     this._allowHtmComponentClosingTags = options.allowHtmComponentClosingTags || false;
-    this._allowInElementComments = options.allowInElementComments ?? true;
+    this._allowStartTagComments = options.allowStartTagComments ?? true;
     const range = options.range || {
       endPos: _file.content.length,
       startPos: 0,
@@ -923,7 +923,7 @@ class _Tokenizer {
       }
 
       while (true) {
-        if (this._allowInElementComments) {
+        if (this._allowStartTagComments) {
           const commentStart = this._cursor.clone();
 
           if (this._attemptStr('//')) {