fix(experimental-utils): fix eslint-utils' negative predicates' return types in ast-utils

[MichaelDeBoey]

Just like it's done with isNotCommentToken

typescript-eslint/packages/experimental-utils/src/ast-utils/eslint-utils/predicates.ts

Lines 49 to 51 in d4f0774

	const isNotCommentToken = eslintUtils.isNotCommentToken as (
	token: TSESTree.Token,
	) => token is Exclude<TSESTree.Token, TSESTree.Comment>;

[typescript-eslint]

Thanks for the PR, @MichaelDeBoey!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[bradzacher]

While I definitely like the idea of this, ultimately this doesn't actually do anything.

The type of Token['value'] is string.
Because TypeScript doesn't support exclusions from the primitive types - Excludes<string, '=>'> just results in string.

Exclude<TSESTree.Token, TSESTree.Comment> OTOH does do something as Comment is a distinct type in the union, which can be excluded.

[MichaelDeBoey]

@bradzacher You think there's another way of getting the correct type then?

Edit: posted https://twitter.com/MichaelDeBoey93/status/1401920255404953604 to get some help

[bradzacher]

There is unfortunately not right now.
There was a TS issue about "negative" types a while back. It's something the TS team has thought about but has not implemented.

Edit: orta dug up the issue: microsoft/TypeScript#29317

[MichaelDeBoey]

@bradzacher microsoft/TypeScript#29317 is the issue as mentioned by @orta in https://twitter.com/orta/status/1401934733634846723

So there's no other way to do this then?
Not even when it's a complicated way?

@bradzacher Making the value of PunctuatorToken equal to '=>' | '}' | ']' | ')' | ':' | ',' | '{' | '[' | ... for instance? 🤔

interface PunctuatorToken extends BaseToken {
  type: AST_TOKEN_TYPES.Punctuator;
  value: '=>' | '}' | ']' | ')' | ':' | ',' | '{' | '[' | ...;
}

[bradzacher]

Correct, but then we would have to attempt to list out every single possible token string and keep it up to date.

Not an impossible task, just a (relatively) low value one.

Also it's not a great thing because custom parsers (babel, Vue, markdown, angular) may add new tokens, which then causes our types to be wrong. By-and-large our rules shouldn't make assumptions about the parser.

[MichaelDeBoey]

@bradzacher This PR adds type-safety and type guards for those functions.
I know I'm biased, but I think the "low value maintenance" of the value type is subordinate to the extra value you get from having the type guards I think?

What do you think?
Should we proceed here?

I'm happy to create another PR to update the value type if that's preferred btw.

[nx-cloud]

Nx Cloud Report

CI ran the following commands for commit 0127fc9. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status	Command
	nx run-many --target=build --all --parallel
	nx run-many --target=typecheck --all --parallel

---

Sent with 💌 from NxCloud.

[MichaelDeBoey]

@bradzacher Now that #3496 is merged, this one can be merged too I think?

[bradzacher]

yup - looks good now and it should all work!!