Skip to content

Cleanup #99

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

Merged
merged 6 commits into from
Dec 6, 2018
Merged

Cleanup #99

merged 6 commits into from
Dec 6, 2018

Conversation

dpopp07
Copy link
Contributor

@dpopp07 dpopp07 commented Dec 5, 2018

Goals

  1. Allow the examples server to run with the development code bundle
  2. Remove duplicated code between this SDK and the Watson Node SDK

Solutions

  1. This wasn't simple because the examples folder also needs to be able to be bundled and run as an example app on ibm cloud. What I did is a little scrappy but it is effective and should not affect that requirement. I wrote a script to move the development bundle directly into the bower components of the examples folder (which is not source controlled) upon running npm run dev

  2. I read through the SpeechJS version of the RecognizeStream class and the transpiled recognize-stream.js and they were almost exactly the same. This confirmed there is no need to have the browser-specific version. I decided to make the version in the Node SDK the source of truth and have the SpeechJS SDK depend on this library. The alternative would be to release to stream classes as their own independent npm packages.

Other changes

  • The bundled dist/ code was being committed for some reason (even though it was already gitignored) so I removed those from version control
  • The documentation in the readme was a little disorganized and so i moved some of it to a docs/ folder to make the main README cleaner
  • added some in-code documentation about how to use IAM since we have been getting a lot of questions around that
  • Fixed linting issues with some code but stopped doing that because of weird linting rules - that will need to be a future item

@germanattanasio
Copy link
Contributor

@dpopp07 so webpack will create a bundle using the recognizestream from the node-sdk?

Copy link
Contributor

@germanattanasio germanattanasio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

@dpopp07
Copy link
Contributor Author

dpopp07 commented Dec 6, 2018

@germanattanasio Yes it will

@dpopp07 dpopp07 merged commit 438d657 into master Dec 6, 2018
@dpopp07 dpopp07 deleted the cleanup branch December 6, 2018 19:54
@watson-github-bot
Copy link

🎉 This PR is included in version 0.35.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

3 participants