feat: add ability to ignore warnings through compiler option #12296

dummdidumm · 2024-07-04T09:05:08Z

Some people want to disable certain warnings for their whole application without having to add svelte-ignore comments everywhere. This new option makes that possible.
closes #9188
part of sveltejs/language-tools#650

I briefly thought about making it a function like onwarn, which has more flexibility, but I think in this case it's better to be simple and just pass a list of strings.
I also thought about whether or not we should allow something like a11y_*, which means "everything starting with a11y_ is ignored". This would give the same flexibility someone for onwarn wants, and we could also use that same logic on svelte-ignore comments (e.g. you can do  to ignore multiple a11y warnings at once). I would be open to adding this capability (more than having an onwarn function) if other maintainers think this is a good idea. We decided to go with a warning => boolean function. Provides more flexibility, and since the warning contains the filename you could also filter based on where the component is.

Before submitting the PR, please make sure you do the following

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
Prefix your PR title with feat:, fix:, chore:, or docs:.
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests and linting

Run the tests with pnpm test and lint the project with pnpm lint

changeset-bot · 2024-07-04T09:05:12Z

🦋 Changeset detected

Latest commit: 085b7f6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
svelte	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Some people want to disable certain warnings for their whole application without having to add svelte-ignore comments everywhere. This new option makes that possible. closes #9188 part of sveltejs/language-tools#650

.changeset/little-seals-reflect.md

dummdidumm · 2024-07-11T19:56:28Z

Good to go apart from this question: should it be called filterWarning (singular instead of plural), since it's only concerned with one warning at a time?

Rich-Harris · 2024-07-14T14:25:53Z

Another idea: warningFilter — in other words filter is a noun rather than a verb, and warning is the qualifier rather than the subject. That way we side-step the question altogether

Rich-Harris · 2024-07-14T14:31:44Z

packages/svelte/src/compiler/state.js

@@ -50,7 +53,7 @@ export function pop_ignore() {

 /**
 * @param {string} _source
- * @param {{ filename?: string, rootDir?: string }} options
+ * @param {{ filename?: string, rootDir?: string, filterWarning?: CompileOptions['filterWarning'] }} options


What if this was required? The parse API would need to supply a default () => true option, but could also take an option which would be useful. The other place reset is called is in migrate, where we probably want to use () => false since there's not a lot that can be done about warnings there.

Suggested change

* @param {{ filename?: string, rootDir?: string, filterWarning?: CompileOptions['filterWarning'] }} options

* @param {{ filename?: string, rootDir?: string, filterWarning: CompileOptions['filterWarning'] }} options

The other places don't care about warnings (there's nothing done with them), and we need to call reset anyway at which point any warnings are deleted, so not sure it's worth it.
We can definitely fall back to () => true in state.js though to avoid the dance in compile_warnings.js

Rich-Harris · 2024-07-14T14:32:10Z

packages/svelte/scripts/process-messages/templates/compile-warnings.js

 	);
+
+	if (filter_warning && !filter_warning(warning)) return;


If we make it required, we can get rid of filter_warning &&

Suggested change

if (filter_warning && !filter_warning(warning)) return;

if (!filter_warning(warning)) return;

Rich-Harris · 2024-07-14T14:32:27Z

packages/svelte/src/compiler/warnings.js

+
+	const warning = new InternalCompileWarning(code, message, node && node.start !== undefined ? [node.start, node.end ?? node.start] : undefined);
+
+	if (filter_warning && !filter_warning(warning)) return;


Suggested change

if (filter_warning && !filter_warning(warning)) return;

if (!filter_warning(warning)) return;

.changeset/little-seals-reflect.md

Rich-Harris · 2024-07-16T15:31:26Z

Oops, looks like we need to reset warningFilter before we validate options, because we need to call it during validation. Fix incoming

* feat: add ability to ignore warnings through compiler option Some people want to disable certain warnings for their whole application without having to add svelte-ignore comments everywhere. This new option makes that possible. closes #9188 part of sveltejs/language-tools#650 * make it a function * singular * warningFilter * make internal filter non-nullable * Update .changeset/little-seals-reflect.md * filter_warning -> warning_filter, for symmetry with public option * fix --------- Co-authored-by: Rich Harris <rich.harris@vercel.com>

vercel bot deployed to Preview – svelte-5-preview July 4, 2024 09:05 View deployment

feat: add ability to ignore warnings through compiler option

281debf

Some people want to disable certain warnings for their whole application without having to add svelte-ignore comments everywhere. This new option makes that possible. closes #9188 part of sveltejs/language-tools#650

dummdidumm force-pushed the warning-ignore-option branch from 538d30a to 281debf Compare July 4, 2024 09:09

vercel bot deployed to Preview – svelte-dev July 4, 2024 09:10 View deployment

vercel bot deployed to Preview – svelte-5-preview July 4, 2024 09:13 View deployment

mquandalle reviewed Jul 11, 2024

View reviewed changes

.changeset/little-seals-reflect.md Outdated Show resolved Hide resolved

dummdidumm added 2 commits July 11, 2024 21:50

Merge branch 'main' into warning-ignore-option

8e318f7

make it a function

3b766f5

vercel bot deployed to Preview – svelte-5-preview July 11, 2024 19:57 View deployment

vercel bot deployed to Preview – svelte-dev July 11, 2024 19:57 View deployment

singular

7003a80

vercel bot deployed to Preview – svelte-dev July 12, 2024 10:38 View deployment

vercel bot deployed to Preview – svelte-5-preview July 12, 2024 10:41 View deployment

Rich-Harris reviewed Jul 14, 2024

View reviewed changes

dummdidumm added 2 commits July 15, 2024 09:02

warningFilter

656ff15

make internal filter non-nullable

3b6b742

vercel bot deployed to Preview – svelte-5-preview July 15, 2024 07:08 View deployment

vercel bot deployed to Preview – svelte-dev July 15, 2024 07:08 View deployment

Rich-Harris reviewed Jul 16, 2024

View reviewed changes

.changeset/little-seals-reflect.md Outdated Show resolved Hide resolved

Rich-Harris added 2 commits July 16, 2024 11:19

Update .changeset/little-seals-reflect.md

c9c8842

filter_warning -> warning_filter, for symmetry with public option

b05318e

Rich-Harris approved these changes Jul 16, 2024

View reviewed changes

vercel bot deployed to Preview – svelte-dev July 16, 2024 15:22 View deployment

vercel bot had a problem deploying to Preview – svelte-5-preview July 16, 2024 15:22 Failure

fix

085b7f6

vercel bot deployed to Preview – svelte-dev July 16, 2024 15:36 View deployment

vercel bot deployed to Preview – svelte-5-preview July 16, 2024 15:39 View deployment

Rich-Harris merged commit d9569d0 into main Jul 16, 2024
9 checks passed

Rich-Harris deleted the warning-ignore-option branch July 16, 2024 15:41

github-actions bot mentioned this pull request Jul 16, 2024

Version Packages (next) #12456

Merged

dummdidumm mentioned this pull request Sep 26, 2024

Disable warnings like a11y #13402

Closed

mquandalle mentioned this pull request Apr 10, 2025

Disable accessibility warnings per directory #15728

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add ability to ignore warnings through compiler option #12296

feat: add ability to ignore warnings through compiler option #12296

Uh oh!

dummdidumm commented Jul 4, 2024 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 4, 2024 •

edited

Loading

Uh oh!

Uh oh!

dummdidumm commented Jul 11, 2024

Uh oh!

Rich-Harris commented Jul 14, 2024

Uh oh!

Rich-Harris Jul 14, 2024

Uh oh!

dummdidumm Jul 15, 2024

Uh oh!

Rich-Harris Jul 14, 2024

Uh oh!

Rich-Harris Jul 14, 2024

Uh oh!

Uh oh!

Rich-Harris commented Jul 16, 2024

Uh oh!

Uh oh!

Uh oh!

	* @param {{ filename?: string, rootDir?: string, filterWarning?: CompileOptions['filterWarning'] }} options
	* @param {{ filename?: string, rootDir?: string, filterWarning: CompileOptions['filterWarning'] }} options

	if (filter_warning && !filter_warning(warning)) return;
	if (!filter_warning(warning)) return;


		const warning = new InternalCompileWarning(code, message, node && node.start !== undefined ? [node.start, node.end ?? node.start] : undefined);

		if (filter_warning && !filter_warning(warning)) return;

Uh oh!

feat: add ability to ignore warnings through compiler option #12296

feat: add ability to ignore warnings through compiler option #12296

Uh oh!

Conversation

dummdidumm commented Jul 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before submitting the PR, please make sure you do the following

Tests and linting

Uh oh!

changeset-bot bot commented Jul 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

dummdidumm commented Jul 11, 2024

Uh oh!

Rich-Harris commented Jul 14, 2024

Uh oh!

Rich-Harris Jul 14, 2024

Choose a reason for hiding this comment

Uh oh!

dummdidumm Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

Rich-Harris Jul 14, 2024

Choose a reason for hiding this comment

Uh oh!

Rich-Harris Jul 14, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Rich-Harris commented Jul 16, 2024

Uh oh!

Uh oh!

Uh oh!

dummdidumm commented Jul 4, 2024 •

edited

Loading

changeset-bot bot commented Jul 4, 2024 •

edited

Loading