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

V2.0.0 (Closes #7, #61, #67, #73, #77 #102, #103, #106, #120) #118

Merged
merged 60 commits into from
Jul 9, 2017

Conversation

alallier
Copy link
Owner

@alallier alallier commented Jun 30, 2017

Reload v2.0.0

Added

Modified

Removed

API Breaking Changes

This PR makes breaking changes to the reload API. Please reference the new API in the README. The only required argument to reload now is app. This makes reload a lot easier to use. Reload takes a maximum of two arguments app and an opts (options) object with the following optional parameters, port, route, and verbose. Two new options were added port and route. Reload runs on default port 9856 unless otherwise specified in the opts object.

General Notes

  • Reload will now throw an error if no arguments are specified or invalid arguments are detected (to the best of our knowledge).
  • We will also still support reload calls with old parameters but leave a deprecated warning to update to the new parameters.

alallier and others added 30 commits April 16, 2017 17:35
…js. This may also help reduce confusion when someone looks at the source code
…tion. Check to see if the parameter is a number, if it is configure reload to create and connect to a websocket running on that port, otherwise do the default (use the servers port, from the server being passed).
separate configuration of app routing from starting web socket server
Added the ability to specifying a custom port to run the WebSocket on (Closes #61)
Replace v0.1 and v0.12 with v6 and v7 (stable and dev) (Closes #73)
* Updated README with API changes
* Updated sample app
Removed all old API arguments and replaced with an object of parameters. (Closes #77)
…the app to become simpler for many reasons:

* Allows for easy setup in an app
* Removes complex two part function for people who have split up app and server (this reverses #71)

This commit closes #95 as it allows the reload path to be configured, allowing someone to use the `reload` route in their application if they needed outside of reload.

This commit refactors the params again to start with the only required argument app, everything else has defaults and is in an optional object param.
…Invalid arguments are checked for to the best of our ability
Add table of contents to README (closes #103)
* Updates dependencies in reload and the sample app to the latest.
* Removed death as it was never being used.
* Added supertest script to call server to express sample app to make things [eaiser](#89 (comment)) to understand.
* Cleaned up some parts of the `package.json` in the sample app
Kept and abstracted support for server on command line side only
@alallier
Copy link
Owner Author

alallier commented Jun 30, 2017

I still need to:

  • README tweak
  • Edit changelog. (Normally we do this after merge but since this is so big I want to do it in the PR before hand)
  • Final Testing

@alallier alallier added this to the v2.0.0 milestone Jun 30, 2017
@alallier alallier changed the title V2.0.0 (Closes #7, #61, #67, #73, #77 #102, #103) V2.0.0 (Closes #7, #61, #67, #73, #77 #102, #103, #106) Jun 30, 2017
@alallier alallier changed the title V2.0.0 (Closes #7, #61, #67, #73, #77 #102, #103, #106) V2.0.0 (Closes #7, #61, #67, #73, #77 #102, #103, #106, #120) Jul 9, 2017
@alallier
Copy link
Owner Author

alallier commented Jul 9, 2017

Thank you to everyone who played a part in helping us achieve Version 2.0. If you come across any new bugs or problem please file an issue.

@AckerApple
Copy link

I caught up with most all the changes that were worth having, in my fork.

Also updated our differences in my README.md file:
https://www.npmjs.com/package/ack-reload#benefits-of-ack-reload-over-original-reload-package

Farewell. Feel free to pick mine apart.

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.

3 participants