@markuplint/pug-parser 4.6.7 → 4.6.9

package/CHANGELOG.md

@@ -3,21 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.6.7](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.6...@markuplint/pug-parser@4.6.7) (2024-09-23)
+## [4.6.9](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.8...@markuplint/pug-parser@4.6.9) (2024-10-15)
 
-**Note:** Version bump only for package @markuplint/pug-parser
 
+### Bug Fixes
 
+* **pug-parser:** fix parsing outdent code ([dd50bb4](https://github.com/markuplint/markuplint/commit/dd50bb423bbd1c466fe10c59a1778b5572d60457))
 
 
 
-## [4.6.6](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.5...@markuplint/pug-parser@4.6.6) (2024-09-02)
 
-**Note:** Version bump only for package @markuplint/pug-parser
 
+## [4.6.8](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.7...@markuplint/pug-parser@4.6.8) (2024-10-14)
 
+### Bug Fixes
 
+- **pug-parser:** fix to support `BlockComment` node ([afa721c](https://github.com/markuplint/markuplint/commit/afa721cd29cab8a47fa27cefe808d3fb7066b42e))
 
+## [4.6.7](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.6...@markuplint/pug-parser@4.6.7) (2024-09-23)
+
+**Note:** Version bump only for package @markuplint/pug-parser
+
+## [4.6.6](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.5...@markuplint/pug-parser@4.6.6) (2024-09-02)
+
+**Note:** Version bump only for package @markuplint/pug-parser
 
 ## [4.6.5](https://github.com/markuplint/markuplint/compare/@markuplint/pug-parser@4.6.4...@markuplint/pug-parser@4.6.5) (2024-06-25)
 

package/lib/parser.js

@@ -95,6 +95,18 @@ class PugParser extends Parser {
                     isBogus: false,
                 });
             }
+            case 'BlockComment': {
+                const lastBlock = originNode.block.nodes.at(-1);
+                const endOffset = lastBlock ? lastBlock.endOffset : originNode.endOffset;
+                const token = this.sliceFragment(originNode.offset, endOffset);
+                return this.visitComment({
+                    ...token,
+                    depth,
+                    parentNode,
+                }, {
+                    isBogus: false,
+                });
+            }
             case 'Tag': {
                 const namespace = getNamespace(originNode.name, parentNamespace);
                 const attrs = originNode.attrs.map(attr => {
@@ -142,8 +154,15 @@ class PugParser extends Parser {
                 });
             }
             default: {
+                let tokenIncludesFile = token;
+                if ('file' in originNode) {
+                    const interval = originNode.file.column - originNode.endColumn;
+                    const fileOffset = originNode.endOffset + interval;
+                    const fileEndOffset = fileOffset + originNode.file.path.length;
+                    tokenIncludesFile = this.sliceFragment(originNode.offset, fileEndOffset);
+                }
                 return this.visitPsBlock({
-                    ...token,
+                    ...tokenIncludesFile,
                     depth,
                     parentNode,
                     nodeName: originNode.type,

package/lib/pug-parser/index.d.ts

@@ -1,13 +1,14 @@
 export declare function pugParse(pug: string, useOffset?: boolean): ASTBlock;
 export type ASTBlock = PugAST<ASTNode>;
-export type ASTNode = ASTTagNode | ASTTextNode | ASTEmptyPipeNode | ASTCodeNode | ASTComment | ASTDoctype | ASTIncludeNode | ASTMixinNode | ASTMixinSlotNode | ASTNamedBlockNode | ASTFilterNode | ASTEachNode | ASTConditionalNode | ASTCaseNode | ASTCaseWhenNode;
+export type ASTNode = ASTTagNode | ASTTextNode | ASTCodeNode | ASTComment | ASTBlockComment | ASTDoctype | ASTIncludeNode | ASTRawIncludeNode | ASTMixinNode | ASTMixinSlotNode | ASTNamedBlockNode | ASTFilterNode | ASTEachNode | ASTConditionalNode | ASTCaseNode | ASTCaseWhenNode;
 export type ASTTagNode = Omit<PugASTTagNode<ASTAttr, ASTBlock>, 'selfClosing' | 'isInline'> & AdditionalASTData;
 export type ASTTextNode = Omit<PugASTTextNode, 'val'> & AdditionalASTData;
-export type ASTEmptyPipeNode = PugASTEmptyPipeNode & AdditionalASTData;
 export type ASTCodeNode = PugASTCodeNode & AdditionalASTData;
 export type ASTComment = PugASTCommentNode & AdditionalASTData;
+export type ASTBlockComment = PugASTBlockCommentNode<ASTBlock> & AdditionalASTData;
 export type ASTDoctype = PugASTDoctypeNode & AdditionalASTData;
 export type ASTIncludeNode = PugASTIncludeNode<ASTBlock> & AdditionalASTData;
+export type ASTRawIncludeNode = PugASTRawIncludeNode & AdditionalASTData;
 export type ASTMixinNode = Omit<PugASTMixinNode<ASTAttr, ASTBlock>, 'attributeBlocks'> & AdditionalASTData;
 export type ASTMixinSlotNode = PugASTMixinSlotNode & AdditionalASTData;
 export type ASTNamedBlockNode = PugASTNamedBlockNode<ASTNode> & AdditionalASTData;
@@ -54,12 +55,6 @@ type PugASTTextNode = {
     line: number;
     column: number;
 };
-type PugASTEmptyPipeNode = {
-    type: 'EmptyPipe';
-    val: string;
-    line: number;
-    column: number;
-};
 type PugASTCodeNode = {
     type: 'Code';
     val: string;
@@ -76,6 +71,14 @@ type PugASTCommentNode = {
     line: number;
     column: number;
 };
+type PugASTBlockCommentNode<B> = {
+    type: 'BlockComment';
+    val: string;
+    block: B;
+    buffer: boolean;
+    line: number;
+    column: number;
+};
 type PugASTDoctypeNode = {
     type: 'Doctype';
     val: string;
@@ -84,16 +87,24 @@ type PugASTDoctypeNode = {
 };
 type PugASTIncludeNode<B> = {
     type: 'Include';
-    file: {
-        type: 'FileReference';
-        path: string;
-        line: number;
-        column: number;
-    };
+    file: RugASTIncludeFile;
     block: B;
     line: number;
     column: number;
 };
+type PugASTRawIncludeNode = {
+    type: 'RawInclude';
+    file: RugASTIncludeFile;
+    line: number;
+    column: number;
+    filters: unknown[];
+};
+type RugASTIncludeFile = {
+    type: 'FileReference';
+    path: string;
+    line: number;
+    column: number;
+};
 type PugASTEachNode<B> = {
     type: 'Each';
     obj: string;

package/lib/pug-parser/index.js

@@ -2,6 +2,7 @@ import lexer from 'pug-lexer';
 // @ts-ignore
 import parser from 'pug-parser';
 import { getOffsetFromLineAndCol } from '../utils/get-offset-from-line-and-col.js';
+import { getOffsetsFromCode } from '@markuplint/parser-utils/location';
 export function pugParse(pug, useOffset = false) {
     let lexOrigin = lexer(pug);
     /**
@@ -146,6 +147,22 @@ tokens, pug) {
                 nodes.push(includeNode);
                 continue;
             }
+            case 'RawInclude': {
+                const includeNode = {
+                    type: node.type,
+                    file: node.file,
+                    raw,
+                    offset,
+                    endOffset,
+                    line,
+                    endLine,
+                    column,
+                    endColumn,
+                    filters: node.filters,
+                };
+                nodes.push(includeNode);
+                continue;
+            }
             case 'Mixin': {
                 // TODO: Attributes when call mixin
                 // const attrs = getAttrs(node.attrs, tokens, offsets, pug);
@@ -222,6 +239,24 @@ tokens, pug) {
                 nodes.push(commentNode);
                 continue;
             }
+            case 'BlockComment': {
+                const block = optimizeAST(node.block, tokens, pug);
+                const commentNode = {
+                    type: node.type,
+                    val: node.val,
+                    buffer: node.buffer,
+                    block,
+                    raw,
+                    offset,
+                    endOffset,
+                    line,
+                    endLine,
+                    column,
+                    endColumn,
+                };
+                nodes.push(commentNode);
+                continue;
+            }
             case 'Code': {
                 const newNode = {
                     type: node.type,
@@ -250,41 +285,8 @@ tokens, pug) {
                     nodes.push(textNode);
                     break;
                 }
-                const { endOffset, endLine, endColumn } = getRawTextAndLocationEnd(node.val, offset, line, column, tokens, offsets, pug);
-                const raw = pug.slice(offset, endOffset);
-                // console.log({ v: node.val, r: raw });
-                /**
-                 *
-                 * Empty piped line
-                 *
-                 * @see https://pugjs.org/language/plain-text.html#recommended-solutions
-                 */
-                if (raw === '|') {
-                    const newNode = {
-                        type: 'EmptyPipe',
-                        raw,
-                        val: node.val,
-                        offset,
-                        endOffset,
-                        line,
-                        endLine,
-                        column,
-                        endColumn,
-                    };
-                    nodes.push(newNode);
-                    continue;
-                }
-                const textNode = {
-                    type: node.type,
-                    raw,
-                    offset,
-                    endOffset,
-                    line,
-                    endLine,
-                    column,
-                    endColumn,
-                };
-                nodes.push(textNode);
+                const textNodes = getRawTextAndLocationEnd(node.val, offset, line, column, tokens, pug);
+                nodes.push(...textNodes);
                 continue;
             }
             case 'Doctype': {
@@ -558,29 +560,65 @@ tokens) {
 }
 function getRawTextAndLocationEnd(val, offset, line, column, 
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-tokens, offsets, pug) {
-    let beforeNewlineToken = null;
+tokens, pug) {
+    if (val.trim() === '') {
+        return [];
+    }
+    let depth = 0;
+    let endLine = line;
+    let endColumn = column;
+    const result = [];
     for (const token of tokens) {
-        // Searching token after the text.
-        if (beforeNewlineToken &&
-            token.loc.start.line > line &&
-            token.type !== 'text' &&
-            token.type !== 'text-html' &&
-            token.type !== 'indent' &&
-            token.type !== 'outdent') {
-            const endAttrLineOffset = Math.max(offsets[beforeNewlineToken.loc.end.line - 2] ?? 0, 0);
-            const endAttrOffset = endAttrLineOffset + beforeNewlineToken.loc.end.column - 1;
-            return {
-                endOffset: endAttrOffset,
-                endLine: beforeNewlineToken.loc.end.line,
-                endColumn: beforeNewlineToken.loc.end.column,
-            };
+        if (token.loc.start.line < line || (token.loc.start.line === line && token.loc.start.column < column)) {
+            continue;
+        }
+        switch (token.type) {
+            case 'text':
+            case 'text-html': {
+                endLine = token.loc.end.line;
+                endColumn = token.loc.end.column;
+                break;
+            }
+            case 'indent': {
+                depth++;
+                break;
+            }
+            case 'outdent': {
+                depth--;
+                break;
+            }
+            case 'newline': {
+                break;
+            }
+            default: {
+                depth = -1;
+                break;
+            }
+        }
+        const rawLoc = getOffsetsFromCode(pug, line, column, endLine, endColumn);
+        const raw = pug.slice(offset, rawLoc.endOffset);
+        if (raw.trim().startsWith('|')) {
+            // It is a piped text
+            break;
+        }
+        if (raw !== '') {
+            result.push({
+                type: 'Text',
+                raw,
+                offset,
+                endOffset: rawLoc.endOffset,
+                line,
+                endLine,
+                column,
+                endColumn,
+            });
+        }
+        offset = rawLoc.endOffset;
+        line = endLine;
+        column = endColumn;
+        if (depth <= -1) {
+            break;
         }
-        beforeNewlineToken = token;
     }
-    return {
-        endOffset: offset + val.length,
-        endLine: line,
-        endColumn: column + val.length,
-    };
+    return result;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/pug-parser",
-	"version": "4.6.7",
+	"version": "4.6.9",
 	"description": "Pug parser for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -21,11 +21,11 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "4.6.7",
-		"@markuplint/ml-ast": "4.4.4",
-		"@markuplint/parser-utils": "4.6.7",
+		"@markuplint/html-parser": "4.6.9",
+		"@markuplint/ml-ast": "4.4.6",
+		"@markuplint/parser-utils": "4.7.0",
 		"pug-lexer": "5.0.1",
 		"pug-parser": "6.0.0"
 	},
-	"gitHead": "05d2eabfcc41b67847c24049f12dd2b9f5ca6485"
+	"gitHead": "c8c82d36c2e48d191091cbc22ca1b99ed0704b9f"
 }