@shyamsfo/the-sink

What is this

Published a hello world module on npm following this:

https://whitep4nth3r.com/blog/how-to-build-test-and-release-node-module-es6

Installation and usage

First run:

yarn add @shyamsfo/the-sink --save

Then, in your js file:

import the_sink from '@shyamsfo/the-sink';
the_sink.now()
the_sink.get_name()

Development Setup

First clone the repo. Then run:

yarn install

Development

1. Run yarn dev to watch for changes and compile continously
2. yarn clean to clean resources
3. yarn types to generate types
4. yarn build to do a build.
5. yarn test to run tests

Once development is complete we are ready to publish. See below.

Publish

1. First commit all the code using git add . and git commit -m "Commit message"
2. Then run yarn publish
3. This will ask for new version number
4. package.json will be updated with new version number and a new commit will be done
5. prepublish will be run that will do the clean build
6. package will be published
7. git push (including tags) will be done.
8. Verify package has been published at https://www.npmjs.com/package/@shyamsfo/the-sink

Setup

How to start a new npm package:

npm init --scope=@shyamsfo
<Development of all code>
npm login
npm publish --access public

Local testing from another node project

# in this directory
yarn link

In the client:

yarn link @shyamsfo/the-sink