Support Typescript - Contributors Call To Action
See original GitHub issueHi All,
As you probably saw in the last few months we worked on a PR that will add Typescript support to our codebase. All the companies and utils were migrated to use Typescript in this pr #404.
Call to action - testing all companies with the typescript support
We should try and finalize it this week so we will be able to start August with static type checks guarding us and letting us be more relaxed during this full-parenting-month.
WE NEED YOUR HELP! making sure all the companies work as expected.
The table below list all the I mentioned below the creator of each company, even if you are not a creator if you managed to test more companies please add a comment and I will update the table accordingly.
Company | Creator | Tested by |
---|---|---|
Bank Hapoalim | @sebikaplun | @esakal |
Leumi Bank | @esakal | @esakal, @baruchiro |
Discount Bank | @brafdlog | |
Mizrahi Bank | @baruchiro | @baruchiro |
Otsar Hahayal Bank | @matanelgabsi | |
Visa Cal | @nirgin | @brafdlog, @esakal |
Max | @esakal, @baruchiro | |
Isracard | @baruchiro, @esakal | |
Amex | @erezd | @esakal |
Union Bank | @dratler,@kalinoy,@shanigad,@dudiventura and @NoamGoren | |
Beinleumi | @dudiventura |
(*) Hopefully at least two contributors will confirm each company, although one will be accepted as well.
Testing steps
IMPORTANT NOTICE: the test folder was moved from
./tests
intosrc/tests
to meet the Typescript requirement that everything is under thesrc
folder. Once you checkout the Typescript branch you will need to re-create that file (explained in the guide below).
Please use the following guide to test the companies that you have and drop a comment with the list of companies you tested. If it fails on one or more of them add the compilation error in the comment.
- Make sure you don’t have any uncommitted changes.
- Check out the
typescript
branch
git pull
git checkout typescript
- delete
node_modules
folder - install dependencies
npm install
- build the repo and make sure you don’t get any Typescript compile errors
npm run build
- create the tests configuration file with your credential. Duplicate file
./src/tests/tests-config.tpl.js
->./src/tests/tests-config.js
- assign a valid path in the test configuration file under
excelFilesDist
property. - add your credentials in the test file.
- run the tests
npm run test
Acceptance criteria: The library builds successfully All the companies you have created a valid excel file (meaning all the fields you expect to see there actually exist).
Thank you all for helping with this one. We hope the Typescript support will let us do great things with this library.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:3
- Comments:22 (12 by maintainers)
A short update. I pushed a commit that merge latest changes from master and also revert the error status values to match the ones we are currently sending to preserve backward compatibility with them.
https://github.com/eshaham/israeli-bank-scrapers/pull/404/commits/cf92390be739dbe3cc6e140c9ece9ad967e4f95e
it is pending a review of @eshaham but if you will run the code you will already test it with those changes 👍
@baruchiro I messed up meant to do it a few times already, but apparently each time something distracted me and then I forgot 🤦 anyway, v1.0.0 is now released 🥳 cc @esakal