Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for {@snippet} and {@render} in mustache-spacing rule #624

Merged
merged 3 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/yellow-icons-explode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"eslint-plugin-svelte": minor
---

feat: add support for `{@snippet}` and `{@render}` in mustache-spacing rule
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
/tests/fixtures/rules/prefer-style-directive
/tests/fixtures/rules/@typescript-eslint
/tests/fixtures/rules/valid-compile/valid/svelte3-options-custom-element-input.svelte
/tests/fixtures/rules/mustache-spacing/valid/always/snippet-render01-input.svelte
/tests/fixtures/rules/mustache-spacing/invalid/snippet-render01-input.svelte
/.svelte-kit
/svelte.config-dist.js
/build
Expand Down
38 changes: 37 additions & 1 deletion src/rules/mustache-spacing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,16 @@ export default createRule('mustache-spacing', {
true
);
},
SvelteRenderTag(node) {
const mustacheTokens = getMustacheTokens(node, sourceCode);
verifyBraces(
mustacheTokens.openToken,
mustacheTokens.closeToken,
options.tags.openingBrace,
options.tags.closingBrace,
true
);
},
SvelteIfBlock(node) {
const openBlockOpeningToken = sourceCode.getFirstToken(node);
const openBlockClosingToken = sourceCode.getTokenAfter(node.expression, {
Expand Down Expand Up @@ -292,7 +302,7 @@ export default createRule('mustache-spacing', {
false
);
},
SvelteKeyBlock(node: AST.SvelteEachBlock | AST.SvelteKeyBlock) {
SvelteKeyBlock(node: AST.SvelteKeyBlock) {
const openBlockOpeningToken = sourceCode.getFirstToken(node);
const openBlockClosingToken = sourceCode.getTokenAfter(node.expression, {
includeComments: false,
Expand Down Expand Up @@ -387,6 +397,32 @@ export default createRule('mustache-spacing', {
openBlockClosingToken === sourceCode.getTokenAfter(openBlockLast)
)
);
},
SvelteSnippetBlock(node) {
const openBlockOpeningToken = sourceCode.getFirstToken(node);
const openBlockClosingToken = sourceCode.getTokenAfter(node.context || node.id, {
includeComments: false,
filter: isClosingBraceToken
})!;
verifyBraces(
openBlockOpeningToken,
openBlockClosingToken,
options.tags.openingBrace,
options.tags.closingBrace,
true
);
const closeBlockClosingToken = sourceCode.getLastToken(node);
const closeBlockOpeningToken = sourceCode.getTokenBefore(closeBlockClosingToken, {
includeComments: false,
filter: isOpeningBraceToken
})!;
verifyBraces(
closeBlockOpeningToken,
closeBlockClosingToken,
options.tags.openingBrace,
options.tags.closingBrace,
false
);
}
};
}
Expand Down
40 changes: 31 additions & 9 deletions src/utils/ast-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,8 @@ export function getMustacheTokens(
| SvAST.SvelteMustacheTag
| SvAST.SvelteShorthandAttribute
| SvAST.SvelteSpreadAttribute
| SvAST.SvelteDebugTag,
| SvAST.SvelteDebugTag
| SvAST.SvelteRenderTag,
sourceCode: SourceCode
): {
openToken: SvAST.Token;
Expand All @@ -365,7 +366,8 @@ export function getMustacheTokens(
| SvAST.SvelteMustacheTag
| SvAST.SvelteShorthandAttribute
| SvAST.SvelteSpreadAttribute
| SvAST.SvelteDebugTag,
| SvAST.SvelteDebugTag
| SvAST.SvelteRenderTag,
sourceCode: SourceCode
): {
openToken: SvAST.Token;
Expand All @@ -379,18 +381,14 @@ export function getMustacheTokens(
| SvAST.SvelteMustacheTag
| SvAST.SvelteShorthandAttribute
| SvAST.SvelteSpreadAttribute
| SvAST.SvelteDebugTag,
| SvAST.SvelteDebugTag
| SvAST.SvelteRenderTag,
sourceCode: SourceCode
): {
openToken: SvAST.Token;
closeToken: SvAST.Token;
} | null {
if (
node.type === 'SvelteMustacheTag' ||
node.type === 'SvelteShorthandAttribute' ||
node.type === 'SvelteSpreadAttribute' ||
node.type === 'SvelteDebugTag'
) {
if (isWrappedInBraces(node)) {
const openToken = sourceCode.getFirstToken(node);
const closeToken = sourceCode.getLastToken(node);
return {
Expand Down Expand Up @@ -433,6 +431,30 @@ export function getMustacheTokens(
};
}

function isWrappedInBraces(
node:
| SvAST.SvelteDirective
| SvAST.SvelteSpecialDirective
| SvAST.SvelteMustacheTag
| SvAST.SvelteShorthandAttribute
| SvAST.SvelteSpreadAttribute
| SvAST.SvelteDebugTag
| SvAST.SvelteRenderTag
): node is
| SvAST.SvelteMustacheTag
| SvAST.SvelteShorthandAttribute
| SvAST.SvelteSpreadAttribute
| SvAST.SvelteDebugTag
| SvAST.SvelteRenderTag {
return (
node.type === 'SvelteMustacheTag' ||
node.type === 'SvelteShorthandAttribute' ||
node.type === 'SvelteSpreadAttribute' ||
node.type === 'SvelteDebugTag' ||
node.type === 'SvelteRenderTag'
);
}

/** Get attribute key text */
export function getAttributeKeyText(
node:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- message: Expected 1 space before '}', but not found.
line: 2
column: 16
suggestions: null
- message: Expected 1 space before '}', but not found.
line: 4
column: 15
suggestions: null
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{#snippet foo()}
{/snippet}
{@render foo()}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{#snippet foo() }
{/snippet}
{@render foo() }
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte": ">=5.0.0-0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
- message: Expected 1 space after '{', but not found.
line: 2
column: 1
suggestions: null
- message: Expected 1 space before '}', but not found.
line: 2
column: 16
suggestions: null
- message: Expected 1 space after '{', but not found.
line: 3
column: 1
suggestions: null
- message: Expected 1 space before '}', but not found.
line: 3
column: 10
suggestions: null
- message: Expected 1 space after '{', but not found.
line: 4
column: 1
suggestions: null
- message: Expected 1 space before '}', but not found.
line: 4
column: 15
suggestions: null
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{#snippet foo()}
{/snippet}
{@render foo()}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{ #snippet foo() }
{ /snippet }
{ @render foo() }
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte": ">=5.0.0-0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
- message: Expected no space after '{', but found.
line: 2
column: 3
suggestions: null
- message: Expected no space before '}', but found.
line: 2
column: 17
suggestions: null
- message: Expected no space after '{', but found.
line: 3
column: 1
suggestions: null
- message: Expected no space before '}', but found.
line: 3
column: 11
suggestions: null
- message: Expected no space after '{', but found.
line: 4
column: 1
suggestions: null
- message: Expected no space before '}', but found.
line: 4
column: 16
suggestions: null
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{ #snippet foo() }
{ /snippet }
{ @render foo() }
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{#snippet foo()}
{/snippet}
{@render foo()}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"FIXME": "It seems to return the wrong location in Svelte v5.",
"svelte": "<=0.0.0 >=5.0.0-0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{ #snippet foo() }
{ /snippet }
{ @render foo() }
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte": ">=5.0.0-0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- prettier-ignore -->
{#snippet foo()}
{/snippet}
{@render foo()}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte": ">=5.0.0-0"
}
Loading