Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.

Support publishing new udaru packages to npm #496

Merged
merged 7 commits into from
Mar 22, 2018
Merged

Conversation

dberesford
Copy link
Contributor

We will be publishing the 3 new packages as the following npm modules:

  • @nearform/udaru-core -> packages/udaru-core
  • @nearform/udaru-hapi-plugin -> packages/udaru-hapi-plugin
  • udaru -> packages/udaru-hapi-server

The existing npm.im/udaru module in npm will be used for the standalone server. The other two packages are new and will be published under the @nearform name space. (Thanks to @mcollina for advising on this).

The above naming convention also give us scope in the future for developing fastify or express http wrappers around core.

This PR supports the above, it's a combination of:

  • updates to the various require statements everywhere
  • README updates
  • small example of how to use udaru-core added

More tidy up (particularly around documentation) to follow before we actually publish.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.006%) to 94.182% when pulling 95f19e9 on new-packages into 02dc5ce on master.

@coveralls
Copy link

coveralls commented Mar 21, 2018

Coverage Status

Coverage increased (+0.006%) to 94.182% when pulling cd20135 on new-packages into 02dc5ce on master.


### Stand alone server
```
$ npx udaru
Copy link
Contributor

Choose a reason for hiding this comment

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

is npx correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes it is (see https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
This is not tested though but the intent is to be able to run it via npx

Copy link
Contributor

@cianfoley-nearform cianfoley-nearform left a comment

Choose a reason for hiding this comment

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

looks good to me Damien, fair play!

@dberesford dberesford merged commit 0cbc30a into master Mar 22, 2018
@dberesford dberesford deleted the new-packages branch March 22, 2018 18:57
Copy link
Contributor

@mihaidma mihaidma left a comment

Choose a reason for hiding this comment

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

LGTM only one small comment


1) `udaru-core` - the core udaru library

2) `udaru-hapi-plugin` - a plugin for Hapi that exposes a HTTP interface to `udaru-core`
Copy link
Contributor

Choose a reason for hiding this comment

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

Hapi should be written as hapi.js

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants