Add useful error on empty presets #202

wooorm · 2022-10-12T19:09:24Z

Initial checklist

I read the support docs
I read the contributing guide
I agree to follow the code of conduct
I searched issues and couldn’t find anything (or linked relevant results below)
If applicable, I’ve added docs and tests

Description of changes

Empty presets are most likely a mistake by the user. At best, they do nothing.
This improves the situation for humans that make mistakes, by throwing a useful error.

Closes GH-200.

Empty presets are most likely a mistake by the user. At best, they do nothing. This improves the situation for humans that make mistakes, by throwing a useful error. Closes GH-200.

remcohaszing · 2022-10-13T09:47:28Z

lib/index.js

+          'Expected usable value but received an empty preset, which is probably a mistake: presets typically come with `plugins` and sometimes with `settings`, but this has neither'
+        )
+      }
+


Should we update the types to reflect this?

interface PresetWithPlugins { plugins: PluggableList settings?: Record<string, unknown> } interface PresetWithSettings { plugins?: PluggableList settings: Record<string, unknown> } export type Preset = PresetWithPlugins | PresetWithSettings

I’d say that makes errors harder to read, when something is wrong, TS will try to match both, and show both.
For a small gain?

remcohaszing · 2022-10-13T09:48:36Z

Since this is semver major, this would also be a good time to consider other breaking changes. The first thing that comes to mind if officially dropping support for Node.js 12.

Signed-off-by: Titus <tituswormer@gmail.com>

codecov-commenter · 2023-08-09T13:24:31Z

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (4a94722) 100.00% compared to head (77f3d97) 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #202   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          596       602    +6     
=========================================
+ Hits           596       602    +6

Files Changed	Coverage Δ
lib/index.js	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Add useful error on empty presets

7e5bfaf

Empty presets are most likely a mistake by the user. At best, they do nothing. This improves the situation for humans that make mistakes, by throwing a useful error. Closes GH-200.

github-actions bot added the 👋 phase/new Post is being triaged automatically label Oct 12, 2022

wooorm added 🦋 type/enhancement This is great to have 🧑 semver/major This is a change 👍 phase/yes Post is accepted and can be worked on and removed 👋 phase/new Post is being triaged automatically labels Oct 12, 2022

github-actions bot added 🤞 phase/open Post is being triaged manually and removed 👍 phase/yes Post is accepted and can be worked on 🤞 phase/open Post is being triaged manually labels Oct 12, 2022

This comment has been minimized.

Sign in to view

wooorm added the 👍 phase/yes Post is accepted and can be worked on label Oct 12, 2022

ChristianMurphy approved these changes Oct 12, 2022

View reviewed changes

JounQin approved these changes Oct 13, 2022

View reviewed changes

remcohaszing reviewed Oct 13, 2022

View reviewed changes

remcohaszing mentioned this pull request Oct 17, 2022

VFileMessage generates invalid position if no position is given vfile/vfile-message#15

Closed

4 tasks

Merge branch 'main' into throw-on-useless-presets

77f3d97

Signed-off-by: Titus <tituswormer@gmail.com>

wooorm merged commit b35afe0 into main Aug 9, 2023

wooorm deleted the throw-on-useless-presets branch August 9, 2023 13:30

wooorm added the 💪 phase/solved Post is done label Aug 9, 2023

This comment has been minimized.

Sign in to view

github-actions bot removed the 👍 phase/yes Post is accepted and can be worked on label Aug 9, 2023

InfiniteLove2020 mentioned this pull request Oct 3, 2024

[Snyk] Upgrade unified from 7.1.0 to 11.0.5 InfiniteLove2020/node#7

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add useful error on empty presets #202

Add useful error on empty presets #202

wooorm commented Oct 12, 2022

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

remcohaszing Oct 13, 2022

wooorm Aug 9, 2023

remcohaszing commented Oct 13, 2022 •

edited

Loading

codecov-commenter commented Aug 9, 2023

This comment has been minimized.

Add useful error on empty presets #202

Add useful error on empty presets #202

Conversation

wooorm commented Oct 12, 2022

Initial checklist

Description of changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

remcohaszing Oct 13, 2022

Choose a reason for hiding this comment

wooorm Aug 9, 2023

Choose a reason for hiding this comment

remcohaszing commented Oct 13, 2022 • edited Loading

codecov-commenter commented Aug 9, 2023

Codecov Report

This comment has been minimized.

remcohaszing commented Oct 13, 2022 •

edited

Loading