chore: enforce newline before return and after variable declarations #1107

danez · 2022-06-09T16:14:59Z

Summary

As discussed in #1105, this new eslint rule enforces newlines before returns and after variable delcarations. I did not enable it for the tests, as that would change a lot.

Might be worth upstreaming this to the netlify eslint config?
The rule is already upstream but has no config https://github.com/netlify/eslint-config-node/blob/main/.eslintrc.cjs#L114 and according to the docs

This rule does nothing if no configurations are provided.

https://eslint.org/docs/rules/padding-line-between-statements

github-actions · 2022-06-09T16:17:35Z

⏱ Benchmark results

Comparing with 32a7387

largeDepsEsbuild: 7.8s

⬆️ 4.49% increase vs. 32a7387

^                                                                           9.3s                          
│                                                                           ┌──┐                          
│           8.3s                                                            |  |                          
│           ┌──┐            7.7s                                            |  |                    7.8s  
│           |  |            ┌──┐                                            |  |                    ┌──┐  
│           |  |            |  |                                            |  |                    |▒▒|  
│ ──────────┼──┼────6.4s────┼──┼────6.3s────6.6s────────────6.7s────6.4s────┼──┼────6.5s────6.4s────|▒▒|──
│   6.1s    |  |    ┌──┐    |  |    ┌──┐    ┌──┐    6.1s    ┌──┐    ┌──┐    |  |    ┌──┐    ┌──┐    |▒▒|  
│   ┌──┐    |  |    |  |    |  |    |  |    |  |    ┌──┐    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (32a7387): 7.5s
T-29 (123e7e8): 6.1s
T-28 (8f964b7): 6.5s
T-27 (63447f8): 8s
T-26 (132485e): 7.8s
T-25 (5aaf915): 7.2s
T-24 (0dd8174): 7.9s
T-23 (ab9c0c3): 6.1s
T-22 (2d99794): 7.5s
T-21 (7487ac4): 7.9s
T-20 (716ec4f): 8.2s
T-19 (830f9f2): 6.3s
T-18 (0d22eac): 6.5s
T-17 (846798a): 7.7s
T-16 (4335698): 8.2s
T-15 (7e95f8a): 6.1s
T-14 (4ae024e): 6.3s
T-13 (e329986): 6.3s
T-12 (aad5de4): 6.1s
T-11 (6419b22): 8.3s
T-10 (f178b2c): 6.4s
T-9 (eecd8ed): 7.7s
T-8 (28a85fb): 6.3s
T-7 (61e5b72): 6.6s
T-6 (43ab287): 6.1s
T-5 (1e5cd4a): 6.7s
T-4 (5378020): 6.4s
T-3 (87e11b4): 9.3s
T-2 (55679c9): 6.5s
T-1 (d2d5f28): 6.4s
T (current commit): 7.8s

largeDepsNft: 38.7s

⬆️ 3.66% increase vs. 32a7387

^                                                                          44.6s                          
│                                                                           ┌──┐                          
│          39.9s           40.5s                                            |  |                          
│           ┌──┐            ┌──┐                                            |  |                   38.7s  
│           |  |            |  |                                            |  |                    ┌──┐  
│           |  |            |  |                                            |  |                    |▒▒|  
│ ──────────┼──┼────────────┼──┼───────────30.7s────────────32s────30.5s────┼──┼───30.2s────31s─────|▒▒|──
│  28.1s    |  |    28s     |  |   29.1s    ┌──┐            ┌──┐    ┌──┐    |  |    ┌──┐    ┌──┐    |▒▒|  
│   ┌──┐    |  |    ┌──┐    |  |    ┌──┐    |  |   27.6s    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    ┌──┐    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (32a7387): 37.3s
T-29 (123e7e8): n/a
T-28 (8f964b7): 31.7s
T-27 (63447f8): 40.7s
T-26 (132485e): n/a
T-25 (5aaf915): 34.8s
T-24 (0dd8174): n/a
T-23 (ab9c0c3): 30.2s
T-22 (2d99794): 37.5s
T-21 (7487ac4): 38.4s
T-20 (716ec4f): 41.2s
T-19 (830f9f2): 28.2s
T-18 (0d22eac): 30.4s
T-17 (846798a): 35.9s
T-16 (4335698): 39.1s
T-15 (7e95f8a): 27.2s
T-14 (4ae024e): 30.5s
T-13 (e329986): 28s
T-12 (aad5de4): 28.1s
T-11 (6419b22): 39.9s
T-10 (f178b2c): 28s
T-9 (eecd8ed): 40.5s
T-8 (28a85fb): 29.1s
T-7 (61e5b72): 30.7s
T-6 (43ab287): 27.6s
T-5 (1e5cd4a): 32s
T-4 (5378020): 30.5s
T-3 (87e11b4): 44.6s
T-2 (55679c9): 30.2s
T-1 (d2d5f28): 31s
T (current commit): 38.7s

largeDepsZisi: 55.5s

⬇️ 1.37% decrease vs. 32a7387

^                                                                         1m 20.5s                        
│                                                                           ┌──┐                          
│                                                                           |  |                          
│                                                                           |  |                          
│                                                                 1m 2.9s   |  |          1m 3.2s         
│                                                                   ┌──┐    |  |  1m 2.2s   ┌──┐          
│          57.6s           58.3s                                    |  |    |  |    ┌──┐    |  |   55.5s  
│ ──────────┌──┐────────────┌──┐────────────────────────────────────┼──┼────┼──┼────┼──┼────┼──┼────┌──┐──
│           |  |            |  |            47s            48.3s    |  |    |  |    |  |    |  |    |▒▒|  
│  44.4s    |  |   44.1s    |  |   45.1s    ┌──┐   43.6s    ┌──┐    |  |    |  |    |  |    |  |    |▒▒|  
│   ┌──┐    |  |    ┌──┐    |  |    ┌──┐    |  |    ┌──┐    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (32a7387): 56.3s
T-29 (123e7e8): n/a
T-28 (8f964b7): 49s
T-27 (63447f8): 57.5s
T-26 (132485e): 55.2s
T-25 (5aaf915): n/a
T-24 (0dd8174): 56.8s
T-23 (ab9c0c3): 44.7s
T-22 (2d99794): 47.1s
T-21 (7487ac4): 52.3s
T-20 (716ec4f): 51.1s
T-19 (830f9f2): 38.7s
T-18 (0d22eac): 46.3s
T-17 (846798a): n/a
T-16 (4335698): 57.6s
T-15 (7e95f8a): 43.9s
T-14 (4ae024e): 46.8s
T-13 (e329986): 43.7s
T-12 (aad5de4): 44.4s
T-11 (6419b22): 57.6s
T-10 (f178b2c): 44.1s
T-9 (eecd8ed): 58.3s
T-8 (28a85fb): 45.1s
T-7 (61e5b72): 47s
T-6 (43ab287): 43.6s
T-5 (1e5cd4a): 48.3s
T-4 (5378020): 1m 2.9s
T-3 (87e11b4): 1m 20.5s
T-2 (55679c9): 1m 2.2s
T-1 (d2d5f28): 1m 3.2s
T (current commit): 55.5s

eduardoboucas · 2022-06-09T16:23:32Z

Might be worth upstreaming this to the netlify eslint config?

Definitely! I would suggest opening a PR and adding an action item to the next developer tooling guild sync.

eduardoboucas

😍😍😍

…etlify/zip-it-and-ship-it#1107)

chore: enforce newline before return and after variable declarations

4df40a3

danez added the type: chore work needed to keep the product and development running smoothly label Jun 9, 2022

danez requested a review from a team June 9, 2022 16:15

eduardoboucas approved these changes Jun 9, 2022

View reviewed changes

danez added the automerge label Jun 10, 2022

kodiakhq bot merged commit 14bf813 into main Jun 10, 2022

kodiakhq bot deleted the eslint-rule-newline branch June 10, 2022 10:26

Skn0tt pushed a commit to netlify/build that referenced this pull request May 21, 2024

chore: enforce newline before return and after variable declarations (n…

d61030e

…etlify/zip-it-and-ship-it#1107)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: enforce newline before return and after variable declarations #1107

chore: enforce newline before return and after variable declarations #1107

danez commented Jun 9, 2022 •

edited

github-actions bot commented Jun 9, 2022

eduardoboucas commented Jun 9, 2022

eduardoboucas left a comment

chore: enforce newline before return and after variable declarations #1107

chore: enforce newline before return and after variable declarations #1107

Conversation

danez commented Jun 9, 2022 • edited

Summary

github-actions bot commented Jun 9, 2022

⏱ Benchmark results

largeDepsEsbuild: 7.8s

largeDepsNft: 38.7s

largeDepsZisi: 55.5s

eduardoboucas commented Jun 9, 2022

eduardoboucas left a comment

Choose a reason for hiding this comment

danez commented Jun 9, 2022 •

edited