JoshuaKGoldberg / create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝
MIT License
620 stars 63 forks source link

🚀 Feature: move perfectionist errors to warn #1495

Open sys13 opened 1 month ago

sys13 commented 1 month ago

Bug Report Checklist

Overview

When writing code I usually interpret the red error squiggles as something that I've done wrong, questioning if there's something I need to change. The perfectionist plugins often show errors, but I don't need to fix anything, rather just save and let the auto fix deal with it. In this case, I'd prefer a warning, more as a prompt to save.

perfectionist/sort-intersection-types
perfectionist/sort-objects

Additional Info

could add:

'perfectionist/sort-intersection-types': 'warn',
'perfectionist/sort-objects': [
    'warn',
    {
        order: 'asc',
        'partition-by-comment': true,
        type: 'natural',
    },
],
JoshuaKGoldberg commented 1 month ago

👋 thanks for mentioning @sys13!

red error squiggles

Interesting, what editor are you using? For VS Code, this template switches all ESLint reports from red (error) to yellow (warn).

https://github.com/JoshuaKGoldberg/create-typescript-app/blob/28ac87a6fbd116602c55fc0bdffa485119060dc3/.vscode/settings.json#L16

The problem with warnings in ESLint is that they have a bad habit of being ignored by developers over time. https://github.com/eslint/eslint/issues/16696 -> https://github.com/eslint/eslint/pull/16882 has some good discussion around that. Which is why I'm a big fan of showing the reports as warnings in the UI but treating them as errors in CI.

sys13 commented 1 month ago

Ah, thanks @JoshuaKGoldberg - I don't use the full project (just bolted in the eslint rules, so much good work there) so I missed the vscode setting.

I do like having errors for things that I need to fix while I'm coding, and warnings for things that the editor can auto fix. Prefer not to wait until CI, as I have to go back and get in context to make the fixes. As an idea maybe you can have a minimal/maximal setting for how to approach things, instead of a one-size-fits-all.

JoshuaKGoldberg commented 1 month ago

minimal/maximal setting for how to approach things, instead of a one-size-fits-all

Can you say more? What kinds of things would you want to change around with those settings?

Slash, is https://github.com/JoshuaKGoldberg/create-typescript-app/blob/28ac87a6fbd116602c55fc0bdffa485119060dc3/docs/Tooling.md different from what you're looking for?

sys13 commented 1 month ago

I think what I'm proposing is turning off "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }], for the Everything level, and turning some things into warn (like perfectionist) to still not be too alarming while in the editor.