Ban "Omit" in favor of "Except"

[twschiller]

• We should always use Except vs. Omit where possible because Except enforces the property actually exists on the object: https://github.com/sindresorhus/type-fest/blob/main/source/except.d.ts
• Might be able to configure on the ban types rule? https://typescript-eslint.io/rules/ban-types/

[fregante]

Probably not a good idea to alter ban-types because eslint doesn’t allow extending existing configuration (rather, it’s possible but you need you import and extend manually) — at least until #36

Should be easier with the no-restricted-syntax rule, but it needs to be added to the extension first.

#186 will take extra work to bring it to the shared config

[fregante]

By the way, Omit is actually the default for TypeScript. Meaning: You can already pass objects with any number of properties, TypeScript only matches that you have the required ones.

TS playground

Omit and Except have different use cases:

• Omit<{foo: string, bar: string}, 'foo'> is identical to {bar: string}
• Except<{foo: string, bar: string}, 'foo'> is identical to {bar: string, foo: never}

The latter is not generally needed, every other part of TS already doesn't guarantee that.

[twschiller]

Interesting, I wasn't aware of that difference in the resulting type (with never). My understanding was that Except enforces you pass property names that exist on the type, so is more resilient to errors due to property name changes

In practice, the resulting type from Except is still more informative at usage sites, because it provides a stronger statement that the property should not be relied on

I don't have a strong preference for how to implement it. I agree that no-restricted-syntax would work for implementing