Format repo, add new rules #7226
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luu-alex
requested review from
avkos,
jdevcs and
Muhammad-Altabba
as code owners
Bundle StatsHey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Benchmark
| Benchmark suite | Current: 98c1491 | Previous: 27155ea | Ratio |
|---|---|---|---|
processingTx |
21556 ops/sec (±6.56%) |
21492 ops/sec (±7.89%) |
1.00 |
processingContractDeploy |
39727 ops/sec (±8.37%) |
40035 ops/sec (±5.14%) |
1.01 |
processingContractMethodSend |
15392 ops/sec (±8.53%) |
15323 ops/sec (±10.31%) |
1.00 |
processingContractMethodCall |
26536 ops/sec (±8.79%) |
28246 ops/sec (±6.49%) |
1.06 |
abiEncode |
42705 ops/sec (±6.84%) |
43024 ops/sec (±7.13%) |
1.01 |
abiDecode |
29542 ops/sec (±7.26%) |
29932 ops/sec (±7.74%) |
1.01 |
sign |
1546 ops/sec (±0.96%) |
1509 ops/sec (±3.19%) |
0.98 |
verify |
364 ops/sec (±0.52%) |
367 ops/sec (±0.55%) |
1.01 |
This comment was automatically generated by workflow using github-action-benchmark.
avkos
approved these changes
Aug 29, 2024
jdevcs
reviewed
Aug 29, 2024
There was a problem hiding this comment.
This code formatting in a large size will significantly improve readability and ease maintenance by creating a consistent style. However, a major drawback is the loss of historical context, when a substantial number of lines are altered for formatting, it obscures the history of actual functional changes, making it challenging to understand the evolution of the codebase. Additionally, tools like git blame may become hard to use, as they will highlight formatting changes instead of the original authorship of the logic, complicating the ability to trace who made specific contributions to the code.
|
@jdevcs The tradeoffs you highlighted are valuable to note. I believe eventaully we will need to format this library and once we do we can have a working order of code formatting going forward, as the rules I created will always format the library to standard. I think the to look back on the actual git blame we can take a look at the previous git commits within github. |
jdevcs
approved these changes
Sep 5, 2024
|
@luu-alex merge this PR for avoiding merge conflicts, as its massively touching each file. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## 4.x #7226 +/- ##
==========================================
- Coverage 94.48% 94.44% -0.05%
==========================================
Files 216 216
Lines 8439 8454 +15
Branches 2318 2335 +17
==========================================
+ Hits 7974 7984 +10
- Misses 465 470 +5
Flags with carried forward coverage won't be shown. Click here to find out more. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
for all ts files - ignore default-param-last rule.
This will allow us to git push without running into errors that are not a problem for the library.
Please include a summary of the changes and be sure to follow our Contribution Guidelines.
Type of change
Checklist:
npm run lintwith success and extended the tests and types if necessary.npm run test:unitwith success.npm run test:coverageand my test cases cover all the lines and branches of the added code.npm run buildand testeddist/web3.min.jsin a browser.CHANGELOG.mdfile in the root folder.