Skip to content
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/popular-donkeys-cross.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"eslint-plugin-svelte": patch
---

fix(no-top-level-browser-globals): false positive for `{#if browser}`
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { createRule } from '../utils/index.js';
import globals from 'globals';
import type { TSESTree } from '@typescript-eslint/types';
import { findVariable, getScope } from '../utils/ast-utils.js';
import type { AST } from 'svelte-eslint-parser';

export default createRule('no-top-level-browser-globals', {
meta: {
Expand Down Expand Up @@ -36,10 +37,10 @@ export default createRule('no-top-level-browser-globals', {
};
const maybeGuards: MaybeGuard[] = [];

const functions: TSESTree.FunctionLike[] = [];
const functions: (TSESTree.FunctionLike | AST.SvelteSnippetBlock)[] = [];
const typeAnnotations: (TSESTree.TypeNode | TSESTree.TSTypeAnnotation)[] = [];

function enterFunction(node: TSESTree.FunctionLike) {
function enterFunction(node: TSESTree.FunctionLike | AST.SvelteSnippetBlock) {
if (isTopLevelLocation(node)) {
functions.push(node);
}
Expand Down Expand Up @@ -120,6 +121,7 @@ export default createRule('no-top-level-browser-globals', {

return {
':function': enterFunction,
SvelteSnippetBlock: enterFunction,
'*.typeAnnotation': enterTypeAnnotation,
MetaProperty: enterMetaProperty,
'Program:exit': verifyGlobalReferences
Expand All @@ -144,7 +146,7 @@ export default createRule('no-top-level-browser-globals', {
* Checks whether the node is in a top-level location.
* @returns `true` if the node is in a top-level location.
*/
function isTopLevelLocation(node: TSESTree.Node) {
function isTopLevelLocation(node: TSESTree.Node | AST.SvelteSnippetBlock) {
for (const func of functions) {
if (func.range[0] <= node.range[0] && node.range[1] <= func.range[1]) {
return false;
Expand Down Expand Up @@ -321,7 +323,7 @@ export default createRule('no-top-level-browser-globals', {
node: TSESTree.Expression;
not?: boolean;
}): ((node: TSESTree.Node) => boolean) | null {
const parent = guardInfo.node.parent;
const parent = guardInfo.node.parent as TSESTree.Node | AST.SvelteNode;
if (!parent) return null;

if (parent.type === 'ConditionalExpression') {
Expand All @@ -331,6 +333,22 @@ export default createRule('no-top-level-browser-globals', {
if (parent.type === 'UnaryExpression' && parent.operator === '!') {
return getGuardChecker({ not: !guardInfo.not, node: parent });
}
if (parent.type === 'SvelteIfBlock' && parent.expression === guardInfo.node) {
if (!guardInfo.not) {
if (parent.children.length === 0) {
return null; // No block to check
}
const first = parent.children[0];
const last = parent.children.at(-1)!;
return (n) => first.range[0] <= n.range[0] && n.range[1] <= last.range[1];
}
// not
if (parent.else) {
const block = parent.else;
return (n) => block.range[0] <= n.range[0] && n.range[1] <= block.range[1];
}
return null;
}
if (parent.type === 'IfStatement' && parent.test === guardInfo.node) {
if (!guardInfo.not) {
const block = parent.consequent;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
- message: Unexpected top-level browser global variable "location".
line: 5
column: 2
suggestions: null
- message: Unexpected top-level browser global variable "location".
line: 12
column: 3
suggestions: null
- message: Unexpected top-level browser global variable "location".
line: 18
column: 3
suggestions: null
- message: Unexpected top-level browser global variable "location".
line: 22
column: 3
suggestions: null
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<script>
import { browser } from '$app/environment';
</script>

{location.href}

{#if browser}
{location.href} <!-- Client-side -->
{/if}

{#if !browser}
{location.href} <!-- Server-side -->
{/if}

{#if browser}
{location.href} <!-- Client-side -->
{:else}
{location.href} <!-- Server-side -->
{/if}

{#if !browser}
{location.href} <!-- Server-side -->
{:else}
{location.href} <!-- Client-side -->
{/if}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<script>
import { browser } from '$app/environment';
</script>

{#if browser}
{location.href}
{/if}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{#snippet f()}
{location.href} <!-- This is valid because usage cannot be tracked. -->
{/snippet}
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,9 @@
<script>
import { browser } from '$app/environment';
</script>

{#if !browser}
Server-side.
{:else}
{location.href}
{/if}
Loading