tooling: adding script to inspect TS interface diffs

[evertonfraga]

My goal is to quickly inspect what interfaces have changed since the packages' latest release. This is specially useful for releases.

Instead of going over diff for the source files (which would be chaotic), I chose to perform diff on the .d.ts files. They are generated at build time, therefore not part of this repo, so I can't use git to compare such files.

The ts-interface-diff.sh script downloads the latest published package, and compares the .d.ts files recursively to the ones found in the local dist directory, printing the diff to stdout. I made it generic enough to be used with any other package, so feel free to test it elsewhere, if you want.

Basic instructions on the script file itself.

How to test this PR

1. make sure to have dist files for the package you want to inspect

# install deps, links packages
npm i 

# build all packages
lerna run build

2. Run script

# Run script
./scripts/ts-interface-diff.sh ethereumjs-vm packages/vm/ 

Real-life output:

125c105
<     getContractStorage(address: Buffer, key: Buffer, cb: any): void;
---
>     getContractStorage(address: Buffer, key: Buffer): Promise<Buffer>;
134c114
<     getOriginalContractStorage(address: Buffer, key: Buffer, cb: any): void;
---
>     getOriginalContractStorage(address: Buffer, key: Buffer): Promise<Buffer>;
156c134
<     clearContractStorage(address: Buffer, cb: any): void;
---
>     clearContractStorage(address: Buffer): Promise<void>;

[codecov]

Codecov Report

Merging #764 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #764      +/-   ##
==========================================
- Coverage   92.06%   92.05%   -0.02%     
==========================================
  Files          46       44       -2     
  Lines        3025     3021       -4     
  Branches      471      471              
==========================================
- Hits         2785     2781       -4     
  Misses        145      145              
  Partials       95       95              

Flag	Coverage Δ
#account	94.11% <ø> (ø)
#block	88.36% <ø> (ø)
#blockchain	89.15% <ø> (ø)
#common	93.52% <ø> (-0.26%)	⬇️
#tx	94.16% <ø> (+0.13%)	⬆️
#vm	93.10% <ø> (ø)

Impacted Files	Coverage Δ
packages/common/src/genesisStates/index.ts
packages/common/src/chains/index.ts
packages/common/src/hardforks/index.ts
packages/tx/src/index.ts	100.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2b8b314...d33e4a7. Read the comment docs.

[alcuadrado]

This is really cool, @evertonfraga ! 👏🏻

[holgerd77]

This is really cool 😄 , please do a rebase and drop a note once you have change the diff command and this is ready for re-review, so that this won't get forgotten.

[evertonfraga]

Thanks @holgerd77!

I am changing some control flows to make a continuous git diff, instead of a separate diffs that you have to be quitting one by one.

[evertonfraga]

To fulfill the ultimate diff experience, a single diff command should be run at the end, instead of separate ones. This gave north to every other change, and the script was basically entirely rewritten.

[alcuadrado]

Great idea!

[evertonfraga]

This is ready for review :)

[ryanio]

nice, just tested out the script it's working great for me!