☁️ Nx Cloud Report

CI is running/has finished running commands for commit871e9ca. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Sent with 💌 fromNxCloud.

Thanks for the PR,@Zamiell!

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 onhttps://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day.

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	871e9ca
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6296c3849d15340008441833
😎 Deploy Preview	https://deploy-preview-4864--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site settings.

Codecov Report

Merging#4864 (a50f6e1) intomain (7275977) willdecrease coverage by2.72%.
The diff coverage is81.85%.

❗ Current heada50f6e1 differs from pull request most recent head871e9ca. Consider uploading reports for the commit871e9ca to get more accurate results

@@            Coverage Diff             @@##             main    #4864      +/-   ##==========================================- Coverage   94.25%   91.53%   -2.73%==========================================  Files         153      228      +75       Lines        8305    10856    +2551       Branches     2702     3351     +649     ==========================================+ Hits         7828     9937    +2109- Misses        263      637     +374- Partials      214      282      +68

Flags with carried forward coverage won't be shown.Click here to find out more.

No idea why linting is failing in CI. It passes locally when I donpm run lint.

I also found a bug with thetypeChecker.getTypeAtLocation method while writing this PR.
If you pass itts.VariableDeclaration instead ofts.BindingName, it will cause a run-time error.

Which means that the function signature of this method needs to be updated in the TypeScript repository.
This is over my pay grade to fix, but someone should look into this.

Some notes:

• I fixed a few bad JSDoc comments (@return -->@returns). You should add a lint rule for this to the project, I recommend:https://github.com/gajus/eslint-plugin-jsdoc
• As per Josh's recommendation, I fixed some bugs in the rest of the codebase that this lint rule caught, which is why there are seemingly unrelated code changes in this PR.
• I converted alltsutils.isTypeFlagSet toutil.isTypeFlagSet, as the former is an unmaintained 3rd-party API, and the latter is a (presumably-still-maintained) internal function. I also fixed the definition for this function, as it really takes an integer instead of an enum.
• I madeutil.isSymbolFlagSet, then converted alltsutils.isSymbolFlagSet toutil.isSymbolFlagSet for similar reasons, and did some small refactoring in "typeFlagUtils.ts" to make things more clear.

Needs to still be addressed:

1. CUSTOM_RULES.md

The documentation here recommends usingtsutils.isTypeFlagSet, but this code won't work because the type signature for that function is bugged and the library is no longer maintained. Thus, I thinkutil.isTypeFlagSet should be moved to the@typescript-eslint/utils or something, because right now it isn't exported for end-users to use (I think?). And then this file should be updated to use the new exported function.

Here's a list of errors that I ignored:

1. semi.ts

This file has code that uses a reducer on an enum array, but with a starting value of{} to compose a new record. This is a non-standard way to build a record (I think?), since normally thereduce function is supposed to operate on the array elements themselves.

Thus, thestrict-enums rule rightly complains that thereduce function is being used incorrectly.

2. no-redundant-type-constituents.ts

This uses a complex type oftype PrimitiveTypeFlag = typeof primitiveTypeFlags[number], and I'm not sure what that even means.

3. no-implied-eval.ts

My first thought was to change this toInternalSymbolName.Function, but that doesn't actually match the value that is being used here, so I don't know what to do. I assume that should be a corresponding enum to use, I just don't know what it is.

The comment for the___String type gives more information about this:

/**     * This represents a string whose leading underscore have been escaped by adding extra leading underscores.     * The shape of this brand is rather unique compared to others we've used.     * Instead of just an intersection of a string and an object, it is that union-ed     * with an intersection of void and an object. This makes it wholly incompatible     * with a normal string (which is good, it cannot be misused on assignment or on usage),     * while still being comparable with a normal string via === (also good) and castable from a string.     */exporttype__String=(string&{__escapedIdentifier:void;})|(void&{__escapedIdentifier:void;})|InternalSymbolName;

So I guess it's just weird and I should just put// eslint-disable-line?

4. isTypeReadonly.ts

Same as "no-implied-eval.ts".

5. no-implied-eval.ts

Same as "no-implied-eval.ts".

6. consistent-type-exports.ts

Same as "no-implied-eval.ts".

This monorepo is a good test case for finding bugs in the rule. For example, it caught a bug with variadic functions, which I didn't have a test case for originally. Still working on some of the other errors.

There are branch conflicts in thre README.md files.

1. Why are there 2 duplicated README.md files? That doesn't make any sense.
2. Is there a script to generate the README.md tables?

Also, after Brad's updates, I get the following errors when building:

james@1qaz MINGW64 /d/Repositories/typescript-eslint/packages/eslint-plugin (strict-enums)$ yarn buildyarn run v1.22.19$ tsc -b tsconfig.build.json../types/src/ts-estree.ts:1:27 - error TS2307: Cannot find module './generated/ast-spec' or its corresponding type declarations.1 import * as TSESTree from './generated/ast-spec';                            ~~~~~~~~~~~~~~~~~~~~~~../types/src/ts-estree.ts:4:16 - error TS2664: Invalid module name in augmentation, module './generated/ast-spec' cannot be found.4 declare module './generated/ast-spec' {                 ~~~~~~~~~~~~~~~~~~~~~~../types/src/ts-estree.ts:21:27 - error TS2307: Cannot find module './generated/ast-spec' or its corresponding type declarations.21 export * as TSESTree from './generated/ast-spec';                             ~~~~~~~~~~~~~~~~~~~~~~../types/src/index.ts:1:49 - error TS2307: Cannot find module './generated/ast-spec' or its corresponding type declarations.1 export { AST_NODE_TYPES, AST_TOKEN_TYPES } from './generated/ast-spec';                                                  ~~~~~~~~~~~~~~~~~~~~~~../visitor-keys/src/get-keys.ts:1:26 - error TS2307: Cannot find module '@typescript-eslint/types' or its corresponding type declarations.1 import { TSESTree } from '@typescript-eslint/types';                           ~~~~~~~~~~~~~~~~~~~~~~~~~~../visitor-keys/src/visitor-keys.ts:1:42 - error TS2307: Cannot find module '@typescript-eslint/types' or its corresponding type declarations.1 import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/types';                                           ~~~~~~~~~~~~~~~~~~~~~~~~~~../visitor-keys/src/visitor-keys.ts:152:62 - error TS2345: Argument of type 'AdditionalKeys' is not assignable to parameter of type 'VisitorKeys'.  'string' index signatures are incompatible.    Type 'readonly GetNodeTypeKeys<T>[] | undefined' is not assignable to type 'readonly string[]'.      Type 'undefined' is not assignable to type 'readonly string[]'.152 const visitorKeys: VisitorKeys = eslintVisitorKeys.unionWith(additionalKeys);                                                                 ~~~~~~~~~~~~~~Found 7 errors.

Anyone know why that is? I'm unable to work on the branch until that is resolved.

Brad can you respond to my messages on May 31st?

@Zamiell - bothpackages/eslint-plugin/README.md andpackages/eslint-plugin/docs/rules/README.md no longer have rules table in them.

At the time the "canonical" table was the former (root readme), and the latter was added as part of the website build.

However the rules table is now no longer generated in source files - instead they are generated as part of the website build.

👋@Zamiell, just checking in - do you still have time to work on this? And if so, are there still open questions you're waiting on answers to?

Closing this PR as it's been stale for a few months without activity. Feel free to reopen@Zamiell if you have time - but no worries if not! If anybody wants to drive it forward, please do post your own PR - and if you use this as a start, consider addingCo-authored-by: Zamiell at the end of your PR description. Thanks! 😊

Moving to#6091. I want these checks to exist 😄