@markuplint/svelte-parser 4.7.0-alpha.1 → 4.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2024 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/parse-block.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="svelte" />
 import type { SvelteParser } from './parser.js';
 import type { ChildToken, Token } from '@markuplint/parser-utils';
-import type { Block } from 'svelte/compiler';
-export declare function parseBlock(parser: SvelteParser, token: ChildToken, originBlockNode: Block): {
+import type { SvelteBlock } from './svelte-parser/index.js';
+export declare function parseBlock(parser: SvelteParser, token: ChildToken, originBlockNode: SvelteBlock): {
     openToken: Token;
     closeToken: Token;
 };

package/lib/parser.d.ts

@@ -15,10 +15,11 @@ export declare class SvelteParser extends Parser<SvelteNode> {
     nodeize(originNode: SvelteNode, parentNode: MLASTParentNode | null, depth: number): readonly import("@markuplint/ml-ast").MLASTNodeTreeItem[];
     visitPsBlock(token: ChildToken & {
         readonly nodeName: string;
+        readonly isFragment: boolean;
     }, childNodes?: readonly SvelteNode[], conditionalType?: MLASTPreprocessorSpecificBlockConditionalType): readonly [MLASTPreprocessorSpecificBlock];
     visitChildren(children: readonly SvelteNode[], parentNode: MLASTParentNode | null): never[];
     visitAttr(token: Token): (import("@markuplint/ml-ast").MLASTSpreadAttr & {
-        __rightText?: string | undefined;
+        __rightText?: string;
     }) | {
         isDynamicValue: true | undefined;
         isDirective: true | undefined;
@@ -34,9 +35,9 @@ export declare class SvelteParser extends Parser<SvelteNode> {
         startQuote: import("@markuplint/ml-ast").MLASTToken;
         value: import("@markuplint/ml-ast").MLASTToken;
         endQuote: import("@markuplint/ml-ast").MLASTToken;
-        potentialValue?: string | undefined;
-        valueType?: "string" | "number" | "boolean" | "code" | undefined;
-        candidate?: string | undefined;
+        potentialValue?: string;
+        valueType?: "string" | "number" | "boolean" | "code";
+        candidate?: string;
         uuid: string;
         raw: string;
         startOffset: number;
@@ -45,7 +46,7 @@ export declare class SvelteParser extends Parser<SvelteNode> {
         endLine: number;
         startCol: number;
         endCol: number;
-        __rightText?: string | undefined;
+        __rightText?: string;
     };
     /**
      * > A lowercase tag, like `<div>`, denotes a regular HTML element.

package/lib/parser.js

@@ -7,7 +7,7 @@ var _SvelteParser_instances, _SvelteParser_parseAwaitBlock, _SvelteParser_parseE
 import { getNamespace } from '@markuplint/html-parser';
 import { ParserError, Parser, AttrState } from '@markuplint/parser-utils';
 import { parseBlock } from './parse-block.js';
-import { blockOrTags, svelteParse } from './svelte-parser/index.js';
+import { svelteParse } from './svelte-parser/index.js';
 export class SvelteParser extends Parser {
     constructor() {
         super({
@@ -53,21 +53,8 @@ export class SvelteParser extends Parser {
     nodeize(
     // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
     originNode, parentNode, depth) {
-        let token = this.sliceFragment(originNode.start, originNode.end);
+        const token = this.sliceFragment(originNode.start, originNode.end);
         const parentNamespace = parentNode && 'namespace' in parentNode ? parentNode.namespace : 'http://www.w3.org/1999/xhtml';
-        /**
-         * Temporarily correct location shift issue with the new parser.
-         */
-        if (blockOrTags.includes(originNode.type) && !token.raw.startsWith('{')) {
-            let start = token.startOffset;
-            while (this.rawCode[start] !== '{') {
-                start--;
-            }
-            token = {
-                ...token,
-                ...this.sliceFragment(start, originNode.end),
-            };
-        }
         switch (originNode.type) {
             case 'Text': {
                 return this.visitText({
@@ -89,6 +76,7 @@ export class SvelteParser extends Parser {
                     depth,
                     parentNode,
                     nodeName: 'ExpressionTag',
+                    isFragment: false,
                 });
             }
             case 'Component':
@@ -96,7 +84,7 @@ export class SvelteParser extends Parser {
                 const children = originNode.fragment.nodes ?? [];
                 const reEndTag = new RegExp(`</${originNode.name}\\s*>$`, 'i');
                 const startTagEndOffset = children.length > 0
-                    ? children[0]?.start ?? 0
+                    ? (children[0]?.start ?? 0)
                     : token.raw.replace(reEndTag, '').length + token.startOffset;
                 const startTagLocation = this.sliceFragment(token.startOffset, startTagEndOffset);
                 return this.visitElement({
@@ -135,6 +123,7 @@ export class SvelteParser extends Parser {
                         depth,
                         parentNode,
                         nodeName: ifElseBlock.type,
+                        isFragment: false,
                     }, ifElseBlock.children, {
                         if: 'if',
                         elseif: 'if:elseif',
@@ -171,12 +160,14 @@ export class SvelteParser extends Parser {
                         depth,
                         parentNode,
                         nodeName: 'key',
+                        isFragment: true,
                     }, originNode.fragment.nodes)[0],
                     this.visitPsBlock({
                         ...closeToken,
                         depth,
                         parentNode,
                         nodeName: '/key',
+                        isFragment: true,
                     })[0],
                 ];
             }
@@ -192,12 +183,14 @@ export class SvelteParser extends Parser {
                         depth,
                         parentNode,
                         nodeName: 'snippet',
+                        isFragment: false,
                     }, originNode.body.nodes)[0],
                     this.visitPsBlock({
                         ...closeToken,
                         depth,
                         parentNode,
                         nodeName: '/snippet',
+                        isFragment: false,
                     })[0],
                 ];
             }
@@ -208,6 +201,7 @@ export class SvelteParser extends Parser {
                     depth,
                     parentNode,
                     nodeName: originNode.type,
+                    isFragment: true,
                 }, childNodes);
             }
         }
@@ -356,8 +350,8 @@ originBlockNode) {
      *                 find___^
      */
     const catchExpStart = thenToken
-        ? thenEnd ?? thenToken.startOffset + thenToken.raw.length
-        : pendingEnd ?? awaitExpEnd;
+        ? (thenEnd ?? thenToken.startOffset + thenToken.raw.length)
+        : (pendingEnd ?? awaitExpEnd);
     /**
      * `{:catch name}...{/await}`
      */
@@ -385,6 +379,7 @@ originBlockNode) {
         depth: token.depth,
         parentNode: token.parentNode,
         nodeName: 'await',
+        isFragment: false,
     }, originBlockNode.pending?.nodes, 'await')[0]);
     if (thenToken) {
         expressions.push(this.visitPsBlock({
@@ -392,6 +387,7 @@ originBlockNode) {
             depth: token.depth,
             parentNode: token.parentNode,
             nodeName: 'await:then',
+            isFragment: false,
         }, originBlockNode.then?.nodes, 'await:then')[0]);
     }
     if (catchToken) {
@@ -400,6 +396,7 @@ originBlockNode) {
             depth: token.depth,
             parentNode: token.parentNode,
             nodeName: 'await:catch',
+            isFragment: false,
         }, originBlockNode.catch?.nodes, 'await:catch')[0]);
     }
     expressions.push(this.visitPsBlock({
@@ -407,6 +404,7 @@ originBlockNode) {
         depth: token.depth,
         parentNode: token.parentNode,
         nodeName: '/await',
+        isFragment: false,
     }, undefined, 'end')[0]);
     return expressions;
 }, _SvelteParser_parseEachBlock = function _SvelteParser_parseEachBlock(token, 
@@ -447,6 +445,7 @@ originBlockNode) {
         depth: token.depth,
         parentNode: token.parentNode,
         nodeName: 'each',
+        isFragment: false,
     }, originBlockNode.body.nodes, 'each')[0]);
     if (elseToken) {
         expressions.push(this.visitPsBlock({
@@ -454,6 +453,7 @@ originBlockNode) {
             depth: token.depth,
             parentNode: token.parentNode,
             nodeName: 'each:empty',
+            isFragment: false,
         }, originBlockNode.fallback?.nodes, 'each:empty')[0]);
     }
     expressions.push(this.visitPsBlock({
@@ -461,6 +461,7 @@ originBlockNode) {
         depth: token.depth,
         parentNode: token.parentNode,
         nodeName: '/each',
+        isFragment: false,
     }, undefined, 'end')[0]);
     return expressions;
 }, _SvelteParser_traverseIfBlock = function _SvelteParser_traverseIfBlock(

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

@@ -1,9 +1,12 @@
-/// <reference types="svelte" />
-import type { Attribute, AwaitBlock, Block, Comment, Directive, EachBlock, ElementLike, IfBlock, SpreadAttribute, Tag, Text } from 'svelte/compiler';
-export type SvelteNode = Text | Tag | ElementLike | Comment | Block;
-export type SvelteIfBlock = IfBlock;
-export type SvelteEachBlock = EachBlock;
-export type SvelteAwaitBlock = AwaitBlock;
+import type { AST } from 'svelte/compiler';
+export type SvelteNode = AST.Text | Tag | ElementLike | AST.Comment | SvelteBlock;
+export type SvelteIfBlock = AST.IfBlock;
+export type SvelteEachBlock = AST.EachBlock;
+export type SvelteAwaitBlock = AST.AwaitBlock;
 export declare function svelteParse(template: string): SvelteNode[];
-export type SvelteDirective = Directive | Attribute | SpreadAttribute;
-export declare const blockOrTags: string[];
+export type SvelteDirective = Directive | AST.Attribute | AST.SpreadAttribute;
+export type SvelteBlock = AST.EachBlock | AST.IfBlock | AST.AwaitBlock | AST.KeyBlock | AST.SnippetBlock;
+type Tag = AST.ExpressionTag | AST.HtmlTag | AST.ConstTag | AST.DebugTag | AST.RenderTag;
+type Directive = AST.AnimateDirective | AST.BindDirective | AST.ClassDirective | AST.LetDirective | AST.OnDirective | AST.StyleDirective | AST.TransitionDirective | AST.UseDirective;
+type ElementLike = AST.Component | AST.TitleElement | AST.SlotElement | AST.RegularElement | AST.SvelteBody | AST.SvelteComponent | AST.SvelteDocument | AST.SvelteElement | AST.SvelteFragment | AST.SvelteHead | AST.SvelteOptionsRaw | AST.SvelteSelf | AST.SvelteWindow;
+export {};

package/lib/svelte-parser/index.js

@@ -3,14 +3,3 @@ export function svelteParse(template) {
     const ast = parse(template, { modern: true });
     return ast.fragment.nodes ?? [];
 }
-export const blockOrTags = [
-    'IfBlock',
-    'EachBlock',
-    'AwaitBlock',
-    'KeyBlock',
-    'SnippetBlock',
-    'HtmlTag',
-    'DebugTag',
-    'ConstTag',
-    'RenderTag',
-];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/svelte-parser",
-	"version": "4.7.0-alpha.1",
+	"version": "4.7.0",
 	"description": "Svelte parser for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -9,10 +9,12 @@
 	"type": "module",
 	"exports": {
 		".": {
-			"import": "./lib/index.js"
+			"import": "./lib/index.js",
+			"types": "./lib/index.d.ts"
 		},
 		"./kit": {
-			"import": "./lib/sveltekit-parser.js"
+			"import": "./lib/sveltekit-parser.js",
+			"types": "./lib/sveltekit-parser.d.ts"
 		}
 	},
 	"types": "lib/index.d.ts",
@@ -27,9 +29,10 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "4.6.2",
-		"@markuplint/ml-ast": "4.3.1",
-		"@markuplint/parser-utils": "4.6.2",
-		"svelte": "5.0.0-next.141"
-	}
+		"@markuplint/html-parser": "4.6.10",
+		"@markuplint/ml-ast": "4.4.7",
+		"@markuplint/parser-utils": "4.7.1",
+		"svelte": "5.1.3"
+	},
+	"gitHead": "fab5b494f0bdc491aa83cb2c8722738d557fbefd"
 }

package/lib/parse-blokc.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import type { SvelteParser } from './parser.js';
-import type { ChildToken, Token } from '@markuplint/parser-utils';
-import type { Block } from 'svelte/compiler';
-export declare function parseBlock(parser: SvelteParser, token: ChildToken, originBlockNode: Block): {
-    openToken: Token;
-    closeToken: Token;
-};

package/lib/parse-blokc.js

@@ -1,47 +0,0 @@
-export function parseBlock(
-// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-parser, token, 
-// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-originBlockNode) {
-    const range = token.raw;
-    /**
-     * `{#xxx}...{:xxx}...{/xxx}`
-     *             find___^
-     */
-    // eslint-disable-next-line regexp/strict
-    const eachCloseStartIndex = range.match(/{\s*\/[a-z]+\s*}$/)?.index;
-    if (eachCloseStartIndex == null) {
-        throw new SyntaxError('Block close tag not found');
-    }
-    /**
-     * `{/xxx}`
-     */
-    const closeToken = parser.sliceFragment(token.startOffset + eachCloseStartIndex, originBlockNode.end);
-    const fragment = originBlockNode.type === 'IfBlock'
-        ? originBlockNode.consequent.nodes
-        : originBlockNode.type === 'AwaitBlock'
-            ? originBlockNode.pending?.nodes
-            : originBlockNode.type === 'KeyBlock'
-                ? originBlockNode.fragment.nodes
-                : originBlockNode.body.nodes;
-    const fragStart = fragment?.at(0)?.start;
-    const fragEnd = fragment?.at(-1)?.end;
-    /**
-     * This token does not guarantee an open tag.
-     * For example, it might include `:then` or `:else`.
-     * Therefore, this variable is not used in
-     * `EachBlock` or `AwaitBlock`.
-     * It is only used in `KeyBlock` and `SnippetBlock`.
-     */
-    let openToken;
-    if (fragStart != null && fragEnd != null) {
-        openToken = parser.sliceFragment(token.startOffset, fragStart);
-    }
-    else {
-        openToken = parser.sliceFragment(token.startOffset, eachCloseStartIndex);
-    }
-    return {
-        openToken,
-        closeToken,
-    };
-}