fix(eslint-plugin): [padding-line-between-statements] make function overloading is also processed

[lonyele]

PR Checklist

• Addresses an existing issue: fixes [padding-line-between-statements] wrong blank line in overloaded exported functions #4030
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Problem

normal function overloading was not processed at all because TSDeclareFunction was not called at all. Cases such as below should have made error that there is a blank space expected

options: [{ blankLine: 'always', prev: '*', next: 'block-like' }],

function bar(arg: number): number;
function bar(arg: string | number) {
  return arg;
}

What I did

1. make TSDeclareFunction is also processed.
2. I added test case for already working export function overloading case

Context

I may be wrong because as I think more about it new approaches showing up but let's give it a shot

Issue provided 3 cases

options: [{ blankLine: 'always', prev: '*', next: 'block-like' }],

Case - 1 (error. Not expected)
export function bar(arg: number): number;
export function bar(arg: string | number) {
  return arg;
}

Case - 2 (no error, Expected)
function bar(arg: number): number;
function bar(arg: string | number) {
  return arg;
}

Case - 3 (no error, Expected)
class Foo {
  bar(arg: number): number;
  bar(arg: string | number) {
    return arg;
  }
}

• Case 1 is WAI,
  because block-like(curly brace at last token) and * are matched thus rule applies. To make this work like issue is saying, I think this option can override the option with block-like

options: [
  { blankLine: 'always', prev: '*', next: 'block-like' },
  { blankLine: 'never', prev: '*', next: 'export' }
]

• Case 2 should have errored.
  But It wasn't because TSDeclareFunction was ignored for this rule. This PR fixes it. This option can be used to work as issuer intended

options: [
  { blankLine: 'always', prev: '*', next: 'block-like' },
  { blankLine: 'never', prev: '*', next: 'function' }
]

• Case 3 is not related to this rule?
  I found this lines-between-class-members rule and it is the one that is taking care of the lines inside of class

[nx-cloud]

☁️ Nx Cloud Report

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

📂 See all runs for this branch

---

✅ Successfully ran 44 targets

• Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 16.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx test @typescript-eslint/eslint-plugin-internal
• Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12.x - nx test @typescript-eslint/eslint-plugin
• Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14.x - nx test @typescript-eslint/eslint-plugin
• Node 12.x - nx run-many --target=typecheck --all --parallel
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/parser
• Node 12.x - nx test @typescript-eslint/experimental-utils
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 16.x - nx test @typescript-eslint/parser
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 16.x - nx test @typescript-eslint/experimental-utils
• Node 16.x - nx test @typescript-eslint/scope-manager
• Node 12.x - nx test @typescript-eslint/parser
• Node 16.x - nx test @typescript-eslint/visitor-keys
• Node 12.x - nx test @typescript-eslint/experimental-utils
• Node 12.x - nx test @typescript-eslint/scope-manager
• Node 16.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx test @typescript-eslint/visitor-keys
• Node 16.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx test @typescript-eslint/typescript-estree
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14.x - nx test @typescript-eslint/parser
• Node 14.x - nx test @typescript-eslint/experimental-utils
• Node 14.x - nx test @typescript-eslint/scope-manager
• Node 14.x - nx test @typescript-eslint/visitor-keys
• Node 14.x - nx test @typescript-eslint/typescript-estree
• Node 14.x - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 16.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 12.x - nx prebuild @typescript-eslint/types
• Node 14.x - nx prebuild @typescript-eslint/types

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @lonyele!

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.

[netlify]

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: d6f38f1

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61c6f4ef126b8a0007a6b806

[codecov]

Codecov Report

Merging #4345 (d6f38f1) into main (bade083) will increase coverage by 0.31%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4345      +/-   ##
==========================================
+ Coverage   93.88%   94.20%   +0.31%     
==========================================
  Files         297      152     -145     
  Lines       11179     8104    -3075     
  Branches     3246     2592     -654     
==========================================
- Hits        10495     7634    -2861     
+ Misses        416      266     -150     
+ Partials      268      204      -64     

Flag	Coverage Δ
unittest	94.20% <ø> (+0.31%)	⬆️

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

Impacted Files	Coverage Δ
...lugin/src/rules/padding-line-between-statements.ts	93.83% <ø> (ø)
packages/scope-manager/src/lib/webworker.ts
packages/scope-manager/src/lib/es2015.symbol.ts
...e-manager/src/definition/FunctionNameDefinition.ts
...es/scope-manager/src/scope/ConditionalTypeScope.ts
packages/scope-manager/src/referencer/index.ts
...kages/scope-manager/src/referencer/ClassVisitor.ts
...ges/scope-manager/src/referencer/PatternVisitor.ts
packages/scope-manager/src/lib/es2015.generator.ts
packages/scope-manager/src/lib/es2019.symbol.ts
... and 136 more

[bradzacher]

thanks for this!