@markuplint/vue-parser 4.0.0-alpha.3 → 4.0.0-alpha.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2019 Yusuke Hirao
+Copyright (c) 2017-2023 Yusuke Hirao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/attr.js

@@ -1,10 +1,10 @@
-const duplicatableAttrs = ['class', 'style'];
+const duplicatableAttrs = new Set(['class', 'style']);
 export function attr(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 attr) {
     if (attr.type !== 'html-attr') {
         const name = attr.potentialName;
-        if (duplicatableAttrs.includes(name)) {
+        if (duplicatableAttrs.has(name)) {
             attr.isDuplicatable = true;
         }
         return attr;
@@ -30,7 +30,7 @@ attr) {
          */
         const [, directive, potentialName, modifier] = attr.name.raw.match(/^(v-bind:|:)([^.]+)(?:\.([^.]+))?$/i) ?? [];
         if (directive && potentialName) {
-            if (duplicatableAttrs.includes(potentialName.toLowerCase())) {
+            if (duplicatableAttrs.has(potentialName.toLowerCase())) {
                 attr.isDuplicatable = true;
             }
             if (!modifier) {
@@ -50,6 +50,7 @@ attr) {
                         _modifier: modifier,
                     };
                 }
+                /* eslint-disable unicorn/no-useless-switch-case */
                 // TODO: Supporting for `prop` and `camel` https://github.com/markuplint/markuplint/pull/681
                 case '.prop':
                 case '.camel':
@@ -57,12 +58,13 @@ attr) {
                     const name = `v-bind:${potentialName}${modifier ?? ''}`;
                     return {
                         ...attr,
-                        potentialName: attr.name.raw !== name ? name : undefined,
+                        potentialName: attr.name.raw === name ? undefined : name,
                         isDirective: true,
                         // @ts-ignore
                         _modifier: modifier,
                     };
                 }
+                /* eslint-enable unicorn/no-useless-switch-case */
             }
         }
     }
@@ -85,12 +87,12 @@ attr) {
         /**
          * `v-slot`
          */
-        const [, , slotName] = attr.name.raw.match(/^(v-slot:|#)(.+)$/i) ?? [];
+        const slotName = (attr.name.raw.match(/^(v-slot:|#)(.+)$/i) ?? [])[2];
         const name = `v-slot:${slotName}`;
         if (slotName) {
             return {
                 ...attr,
-                potentialName: attr.name.raw !== name ? name : undefined,
+                potentialName: attr.name.raw === name ? undefined : name,
                 isDirective: true,
             };
         }
@@ -98,7 +100,7 @@ attr) {
     /**
      * If directives
      */
-    if (/^v-/.test(attr.name.raw)) {
+    if (attr.name.raw.startsWith('v-')) {
         return {
             ...attr,
             isDirective: true,

package/lib/parse.js

@@ -1,32 +1,31 @@
-import { parseRawTag } from '@markuplint/html-parser';
-import { flattenNodes, getEndCol, getEndLine, uuid, ParserError, detectElementType } from '@markuplint/parser-utils';
+import { flattenNodes, getEndCol, getEndLine, uuid, ParserError, detectElementType, tagParser, } from '@markuplint/parser-utils';
 import { attr } from './attr.js';
-import vueParse from './vue-parser/index.js';
+import { vueParse } from './vue-parser/index.js';
 export const parse = (rawCode, options) => {
     let ast;
     try {
         ast = vueParse(rawCode);
     }
-    catch (err) {
-        if (err instanceof SyntaxError && 'lineNumber' in err && 'column' in err) {
+    catch (error) {
+        if (error instanceof SyntaxError && 'lineNumber' in error && 'column' in error) {
             throw new ParserError(
             // @ts-ignore
-            err.message, {
+            error.message, {
                 // @ts-ignore
-                line: err.lineNumber,
+                line: error.lineNumber,
                 // @ts-ignore
-                col: err.column,
+                col: error.column,
                 raw: '',
             });
         }
         return {
             nodeList: [],
             isFragment: true,
-            parseError: err instanceof Error ? err.message : new Error(`${err}`).message,
+            parseError: error instanceof Error ? error.message : new Error(`${error}`).message,
         };
     }
     const nodeList = ast.templateBody
-        ? flattenNodes(traverse(ast.templateBody, null, rawCode, options), rawCode)
+        ? flattenNodes(traverse(ast.templateBody, null, rawCode, ast.templateBody.comments, options), rawCode)
         : [];
     // Remove `</template>`
     const templateEndTagIndex = nodeList.findIndex(node => /\s*<\/\s*template\s*>\s*/i.test(node.raw));
@@ -46,17 +45,50 @@ export const parse = (rawCode, options) => {
 };
 function traverse(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-rootNode, parentNode = null, rawHtml, options) {
+rootNode, parentNode = null, rawHtml, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+comments, options) {
     const nodeList = [];
     if (rootNode.type !== 'VElement') {
         return [];
     }
     let prevNode = null;
     for (const vNode of rootNode.children) {
-        const node = nodeize(vNode, prevNode, parentNode, rawHtml, options);
+        const node = nodeize(vNode, prevNode, parentNode, rawHtml, comments, options);
         if (!node) {
             continue;
         }
+        const lastOffset = prevNode?.endOffset ?? parentNode?.endOffset ?? 0;
+        const betweenComment = comments.find(comment => {
+            return lastOffset <= comment.range[0] && comment.range[1] <= node.startOffset;
+        });
+        if (betweenComment) {
+            const comment = {
+                uuid: uuid(),
+                raw: `<!--${betweenComment.value}-->`,
+                startOffset: betweenComment.range[0],
+                endOffset: betweenComment.range[1],
+                startLine: betweenComment.loc.start.line,
+                endLine: betweenComment.loc.end.line,
+                startCol: betweenComment.loc.start.column + 1,
+                endCol: betweenComment.loc.end.column + 1,
+                nodeName: '#comment',
+                type: 'comment',
+                parentNode,
+                prevNode,
+                nextNode: node,
+                isFragment: false,
+                isGhost: false,
+            };
+            comment.parentNode = parentNode;
+            comment.prevNode = prevNode;
+            comment.nextNode = node;
+            if (prevNode) {
+                prevNode.nextNode = comment;
+            }
+            nodeList.push(comment);
+            prevNode = comment;
+        }
         if (prevNode) {
             if (node.type !== 'endtag') {
                 prevNode.nextNode = node;
@@ -74,7 +106,9 @@ originNode,
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 prevNode, 
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-parentNode, rawHtml, options) {
+parentNode, rawHtml, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+comments, options) {
     const nextNode = null;
     const startOffset = originNode.range[0];
     const endOffset = originNode.range[1];
@@ -126,13 +160,13 @@ parentNode, rawHtml, options) {
         default: {
             const tagLoc = originNode.startTag;
             const startTagRaw = rawHtml.slice(tagLoc.range[0], tagLoc.range[1]);
-            const tagTokens = parseRawTag(startTagRaw, startLine, startCol, startOffset);
+            const tagTokens = tagParser(startTagRaw, startLine, startCol, startOffset);
             const tagName = tagTokens.tagName;
             let endTag = null;
             const endTagLoc = originNode.endTag;
             if (endTagLoc) {
                 const endTagRaw = rawHtml.slice(endTagLoc.range[0], endTagLoc.range[1]);
-                const endTagTokens = parseRawTag(endTagRaw, endTagLoc.loc.start.line, endTagLoc.loc.start.column, endTagLoc.range[0]);
+                const endTagTokens = tagParser(endTagRaw, endTagLoc.loc.start.line, endTagLoc.loc.start.column, endTagLoc.range[0]);
                 const endTagName = endTagTokens.tagName;
                 endTag = {
                     uuid: uuid(),
@@ -192,7 +226,7 @@ parentNode, rawHtml, options) {
                 nextNode,
                 pearNode: endTag,
                 selfClosingSolidus: tagTokens.selfClosingSolidus,
-                endSpace: tagTokens.endSpace,
+                endSpace: tagTokens.afterAttrSpaces,
                 isFragment: false,
                 isGhost: false,
                 tagOpenChar: '<',
@@ -201,7 +235,7 @@ parentNode, rawHtml, options) {
             if (endTag) {
                 endTag.pearNode = startTag;
             }
-            startTag.childNodes = traverse(originNode, startTag, rawHtml, options);
+            startTag.childNodes = traverse(originNode, startTag, rawHtml, comments, options);
             return startTag;
         }
     }

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

@@ -1,4 +1,5 @@
 import * as VueESLintParser from 'vue-eslint-parser';
 export type VueTokens = VueESLintParser.AST.ESLintProgram;
-export default function vueParse(vueTemplate: string): VueTokens;
+export declare function vueParse(vueTemplate: string): VueTokens;
 export type ASTNode = VueESLintParser.AST.VElement | VueESLintParser.AST.VText | VueESLintParser.AST.VExpressionContainer;
+export type ASTComment = VueESLintParser.AST.Token & VueESLintParser.AST.HasLocation;

package/lib/vue-parser/index.js

@@ -1,5 +1,5 @@
 import * as VueESLintParser from 'vue-eslint-parser';
-export default function vueParse(vueTemplate) {
+export function vueParse(vueTemplate) {
     const ast = VueESLintParser.parse(vueTemplate, { parser: false });
     return ast;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/vue-parser",
-	"version": "4.0.0-alpha.3",
+	"version": "4.0.0-alpha.5",
 	"description": "Vue parser for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -21,11 +21,10 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "4.0.0-alpha.3",
-		"@markuplint/ml-ast": "4.0.0-alpha.3",
-		"@markuplint/parser-utils": "4.0.0-alpha.3",
-		"tslib": "^2.6.2",
+		"@markuplint/html-parser": "4.0.0-alpha.5",
+		"@markuplint/ml-ast": "4.0.0-alpha.5",
+		"@markuplint/parser-utils": "4.0.0-alpha.5",
 		"vue-eslint-parser": "^9.3.1"
 	},
-	"gitHead": "380836f7adc1ff7e8eaf9d869e68d29eee8f3b7e"
+	"gitHead": "0c3e4690662edf1765bcc4b6411ec5507c1e2ea3"
 }