Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update eslint config to allow direct reference of static class functions #21632

Merged
merged 1 commit into from
Apr 21, 2023
Merged

chore: update eslint config to allow direct reference of static class functions #21632

merged 1 commit into from
Apr 21, 2023

Conversation

cgrindel
Copy link
Contributor

Changes

Update eslint configuration to allow static class functions to be referenced directly without wrapping them in an arrow function.

Context

Slack discussion

If someone defines a static comparison function on a class, it would be ideal to reference this function in Array.sort() like so:

bzlmodVersions.sort(BzlmodVersion.defaultCompare);

However, eslint's unbound-method rule will complain with the following message:

@typescript-eslint/unbound-method: Avoid referencing unbound methods which may cause unintentional scoping of `this`.If your function does not access `this`, you can annotate it with `this: void`, or consider using an arrow function instead.

Given that static class functions should be written without a reference to this, configuring ignoreStatic for the rule would allow one to reference the static function directly.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@cgrindel
Copy link
Contributor Author

CC: @viceice

@viceice viceice added this pull request to the merge queue Apr 21, 2023
Merged via the queue into renovatebot:main with commit d6b5679 Apr 21, 2023
@cgrindel cgrindel deleted the chore/allow_static_fn_refs branch April 21, 2023 16:12
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.57.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

mjunker pushed a commit to mjunker/renovate that referenced this pull request May 17, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants