Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript Conversion #164

Closed
wants to merge 24 commits into from
Closed

Conversation

jharrilim
Copy link

@jharrilim jharrilim commented May 20, 2019

Hi there, I have rewritten this library in Typescript and used some newer software such as Jest and Docker. If you wish, you may merge it in.

What's In The Bag

Some New Stuff

  • Automated API documentation via Typedoc
  • Better linting support for both Javascript and Typescript end users
  • Use Jest instead of Tap
  • Coverage is now created with Jest (still produces lcov report)
  • More unit tests
  • Deployment test in docker to make sure the right members are exported
  • Readme is updated for the new changes
  • Added Spanish from First aproximation to Spanish language.  #162

Some Breaking Changes

  • Scoring Strategy is no longer an object with an "apply" function and is now just a function
  • There are no more callbacks

Things that stayed the same

  • The core algorithm
  • Performance

Test it out

npm t will run all of the tests except the deployment test. You can run the deployment test with npm run test:deployment. You must have Docker installed.

You can run the unit tests and integration tests with verbose output so you may see the entire description of what is covered.

Unit tests with verbose output:
npm run test:unit -- --verbose

Integration tests with verbose output:
npm run test:integration -- --verbose

@thisandagain
Copy link
Owner

Thanks for all the work on this! I appreciate the enthusiasm, but I maintain quite a few projects and would rather not maintain things in both JS and TS.

thisandagain pushed a commit that referenced this pull request Aug 22, 2019
thisandagain added a commit that referenced this pull request Aug 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants