# npm-experiments

[![Build Status](https://travis-ci.org/slayerfat/npm-experiments.svg?branch=master)](https://travis-ci.org/slayerfat/npm-experiments)

Uses [this documentation](https://docs.npmjs.com/misc/developers) and its inspired by [this article.](https://medium.com/@jdaudier/how-to-create-and-publish-your-first-node-js-module-444e7585b738)

The feature branches have some experiments on:
- [x] Basic Typescript (merged)
- [ ] Basic ES5 Javascript
- [x] Basic ES6 Javascript

## This branch setup

The main entry is inside the src folder as main.ts

This process is done in the package.json prepublish script which just calls the compiler.

Thx to tsconfig.json the typescript compiler will output the files into the lib folder.

## Local testing without publish

### With npm link

```bash
cd path/to/package
npm link # should install a global symlink
cd path/to/consumer/
npm link packageName # will create a symlink locally
```

### With npm pack

`npm pack` then `tar -tf packagename-version.tgz`

after than u can:
```bash
cd path/to/consumer/
npm install ../path/to/package/packagename-version.tgz
```

## Testing

Extracted from [This article](https://journal.artfuldev.com/write-tests-for-typescript-projects-with-mocha-and-chai-in-typescript-86e053bdb2b6)

ts-node makes all the magic happen.