msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

chore: better ignore code handling (#11606)

Browse Source 
Instead of hacking an ignores array onto each node (and possibly degrading perf a bit because the object shape is mutated) we keep track of ignores in a stack. The new approach also avoids the indirection the old one had to do because the new approach looks upwards (checking if parent is a fragment) instead of iterating the children (checking for comments in them).
As a bonus unknown code warnings are now in order (line-column-wise) with the other warnings. Also fixes #11482 because text nodes of all shapes are ok
pull/11607/head
Simon H 2 months ago committed by GitHub
parent ac7709f65c
commit 2bc39b1de2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 103 additions and 110 deletions
Show Stats Download Patch File Download Diff File

5
packages/svelte/scripts/process-messages/templates/compile-warnings.js
Unescape View File

@ -1,4 +1,4 @@
import { filename, locator, warnings } from './state.js';
import { filename, locator, warnings, ignore_stack } from './state.js';
/** @typedef {{ start?: number, end?: number }} NodeLike */
@ -8,8 +8,7 @@ import { filename, locator, warnings } from './state.js';
* @param {string} message
*/
function w(node, code, message) {
// @ts-expect-error
if (node?.ignores?.has(code)) return;
if (ignore_stack.at(-1)?.has(code)) return;
warnings.push({
code,

3
packages/svelte/src/compiler/phases/2-analyze/a11y.js
Unescape View File

@ -727,9 +727,6 @@ function check_element(node, state) {
for (const attribute of node.attributes) {
if (attribute.type !== 'Attribute') continue;
// @ts-expect-error gross hack
attribute.ignores = node.ignores;
const name = attribute.name.toLowerCase();
// aria-props
if (name.startsWith('aria-')) {

99
packages/svelte/src/compiler/phases/2-analyze/index.js
Unescape View File

@ -25,6 +25,7 @@ import { prune } from './css/css-prune.js';
import { hash } from './utils.js';
import { warn_unused } from './css/css-warn.js';
import { extract_svelte_ignore } from '../../utils/extract_svelte_ignore.js';
import { pop_ignore, push_ignore } from '../../state.js';
/**
* @param {import('#compiler').Script | null} script
@ -439,8 +440,7 @@ export function analyze_component(root, source, options) {
component_slots: new Set(),
expression: null,
private_derived_state: [],
function_depth: scope.function_depth,
ignores: new Set()
function_depth: scope.function_depth
};
walk(
@ -511,8 +511,7 @@ export function analyze_component(root, source, options) {
component_slots: new Set(),
expression: null,
private_derived_state: [],
function_depth: scope.function_depth,
ignores: new Set()
function_depth: scope.function_depth
};
walk(
@ -1100,67 +1099,51 @@ function is_safe_identifier(expression, scope) {
/** @type {import('./types').Visitors} */
const common_visitors = {
_(node, context) {
// @ts-expect-error
const comments = /** @type {import('estree').Comment[]} */ (node.leadingComments);
if (comments) {
_(node, { state, next, path }) {
const parent = path.at(-1);
if (parent?.type === 'Fragment' && node.type !== 'Comment' && node.type !== 'Text') {
const idx = parent.nodes.indexOf(/** @type {any} */ (node));
/** @type {string[]} */
const ignores = [];
for (const comment of comments) {
const start = /** @type {any} */ (comment).start + 2;
ignores.push(...extract_svelte_ignore(start, comment.value, context.state.analysis.runes));
for (let i = idx - 1; i >= 0; i--) {
const prev = parent.nodes[i];
if (prev.type === 'Comment') {
ignores.push(
...extract_svelte_ignore(
prev.start + 2 /* '//'.length */,
prev.data,
state.analysis.runes
)
);
} else if (prev.type !== 'Text') {
break;
}
}
if (ignores.length > 0) {
// @ts-expect-error see below
node.ignores = new Set([...context.state.ignores, ...ignores]);
push_ignore(ignores);
next();
pop_ignore();
}
}
// @ts-expect-error
if (node.ignores) {
context.next({
...context.state,
// @ts-expect-error see below
ignores: node.ignores
});
} else if (context.state.ignores.size > 0) {
// @ts-expect-error
node.ignores = context.state.ignores;
}
},
Fragment(node, context) {
/** @type {string[]} */
let ignores = [];
for (const child of node.nodes) {
if (child.type === 'Text' && child.data.trim() === '') {
continue;
}
if (child.type === 'Comment') {
const start =
child.start +
(context.state.analysis.source.slice(child.start, child.start + 4) === '<!--' ? 4 : 2);
ignores.push(...extract_svelte_ignore(start, child.data, context.state.analysis.runes));
} else {
const combined_ignores = new Set(context.state.ignores);
for (const ignore of ignores) combined_ignores.add(ignore);
if (combined_ignores.size > 0) {
// TODO this is a grotesque hack that's made necessary by the fact that
// we can't call `context.visit(...)` here, because we do the convoluted
// visitor merging thing. I'm increasingly of the view that we should
// rearchitect this stuff and have a single visitor per node. It'd be
// more efficient and much simpler.
// @ts-expect-error
child.ignores = combined_ignores;
} else {
const comments = /** @type {any} */ (node).leadingComments;
if (comments) {
/** @type {string[]} */
const ignores = [];
for (const comment of comments) {
ignores.push(
...extract_svelte_ignore(
comment.start + 4 /* '<!--'.length */,
comment.value,
state.analysis.runes
)
);
}
if (ignores.length > 0) {
push_ignore(ignores);
next();
pop_ignore();
}
ignores = [];
}
}
},

1
packages/svelte/src/compiler/phases/2-analyze/types.d.ts vendored
Unescape View File

@ -22,7 +22,6 @@ export interface AnalysisState {
expression: ExpressionTag | ClassDirective | SpreadAttribute | null;
private_derived_state: string[];
function_depth: number;
ignores: Set<string>;
}
export interface LegacyAnalysisState extends AnalysisState {

16
packages/svelte/src/compiler/state.js
Unescape View File

@ -10,6 +10,21 @@ export let filename;
export let locator = getLocator('', { offsetLine: 1 });
/** @type {Set<string>[]} */
export let ignore_stack = [];
/**
* @param {string[]} ignores
*/
export function push_ignore(ignores) {
const next = new Set([...(ignore_stack.at(-1) || []), ...ignores]);
ignore_stack.push(next);
}
export function pop_ignore() {
ignore_stack.pop();
}
/**
* @param {{
* source: string;
@ -20,4 +35,5 @@ export function reset(options) {
filename = options.filename;
locator = getLocator(options.source, { offsetLine: 1 });
warnings = [];
ignore_stack = [];
}

5
packages/svelte/src/compiler/warnings.js
Unescape View File

@ -1,6 +1,6 @@
/* This file is generated by scripts/process-messages/index.js. Do not edit! */
import { filename, locator, warnings } from './state.js';
import { filename, locator, warnings, ignore_stack } from './state.js';
/** @typedef {{ start?: number, end?: number }} NodeLike */
/**
@ -9,8 +9,7 @@ import { filename, locator, warnings } from './state.js';
* @param {string} message
*/
function w(node, code, message) {
// @ts-expect-error
if (node?.ignores?.has(code)) return;
if (ignore_stack.at(-1)?.has(code)) return;
warnings.push({
code,

84
packages/svelte/tests/validator/samples/unknown-code/warnings.json
Unescape View File

@ -1,74 +1,74 @@
[
{
"code": "legacy_code",
"end": {
"column": 41,
"line": 3
},
"message": "`a11y-missing-attribute` is no longer valid — please use `a11y_missing_attribute` instead",
"start": {
"column": 19,
"line": 3
"line": 3,
"column": 17
},
"end": {
"line": 3,
"column": 39
}
},
{
"code": "unknown_code",
"end": {
"column": 41,
"line": 8
},
"message": "`ally_missing_attribute` is not a recognised code (did you mean `a11y_missing_attribute`?)",
"code": "a11y_missing_attribute",
"message": "`<img>` element should have an alt attribute",
"start": {
"column": 19,
"line": 8
"line": 5,
"column": 1
},
"end": {
"line": 5,
"column": 29
}
},
{
"code": "legacy_code",
"end": {
"column": 39,
"line": 13
},
"message": "`a11y-misplaced-scope` is no longer valid — please use `a11y_misplaced_scope` instead",
"code": "unknown_code",
"message": "`ally_missing_attribute` is not a recognised code (did you mean `a11y_missing_attribute`?)",
"start": {
"column": 19,
"line": 13
"line": 8,
"column": 17
},
"end": {
"line": 8,
"column": 39
}
},
{
"code": "a11y_missing_attribute",
"end": {
"column": 29,
"line": 5
},
"message": "`<img>` element should have an alt attribute",
"start": {
"column": 1,
"line": 5
"line": 10,
"column": 1
},
"end": {
"line": 10,
"column": 29
}
},
{
"code": "a11y_missing_attribute",
"end": {
"column": 29,
"line": 10
},
"message": "`<img>` element should have an alt attribute",
"code": "legacy_code",
"message": "`a11y-misplaced-scope` is no longer valid — please use `a11y_misplaced_scope` instead",
"start": {
"column": 1,
"line": 10
"line": 13,
"column": 17
},
"end": {
"line": 13,
"column": 37
}
},
{
"code": "a11y_misplaced_scope",
"end": {
"column": 10,
"line": 14
},
"message": "The scope attribute should only be used with `<th>` elements",
"start": {
"column": 5,
"line": 14
"line": 14,
"column": 5
},
"end": {
"line": 14,
"column": 10
}
}
]

Write Preview
Loading…
Cancel
Save