Refactor

.github/workflows/release.yml

@@ -0,0 +1,20 @@
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+jobs:
+  npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/validation.yml

@@ -0,0 +1,64 @@
+name: Validation
+
+on: [pull_request]
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: npm install
+      - name: ESLint
+        run: npm run lint
+  test:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: npm install
+      - name: Jest
+        run: npm run test --coverage
+      - name: Send coverage to codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+
+  build:
+    name: Run build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: npm install
+      - name: Build
+        run: npm run build
+
+  buildCli:
+    name: Run build-cli
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12.x
+      - name: Install dependencies
+        run: npm install
+      - name: Build
+        run: npm run build-cli

.gitignore

@@ -1 +1,8 @@
-dataset.js
+node_modules
+.vscode/
+# ignore codecoverage output
+coverage/
+# ignore cli binary output
+cli/
+# ignore dist/ output
+dist/

.nvmrc

@@ -0,0 +1 @@
+12.20.2

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,33 +1,46 @@
-# Huffman-URL-Compressor-for-Nodejs
-## Author: Mariano L. Acosta
+<p align="center">
+  <h3 align="center">Template for typescript applications</h3>
 
-# Description
-Convert any kind of String into a url-friendly parameter using Huffman Encoding.
+  <p align="center">
+     ⚙ Template repository for typescript applications meant to run in node ⚙
+    <br />
+    <a href="https://github.com/gagoar/ts-node-template#table-of-contents"><strong>Explore the docs »</strong></a>
+    <br />
+    <a href="https://github.com/gagoar/ts-node-template/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/gagoar/ts-node-template/issues">Request Feature</a>
+  </p>
+</p>
 
-# Installation
+## Table of Contents
 
-        npm install --save huffman-url-compressor
+- [Built With](#built-with)
+- [Getting Started](#getting-started)
+- [Contributing](#contributing)
+- [License](#license)
 
-# Usage
+<!-- CONTRIBUTING -->
 
-## Parameters:
+### Built With
 
-- **Train (string)**: Training set used to create the encoder. This is where the algorithm gets the frequency for each char. 
-- **Test (string)**: String that you want to encode.
+- [ncc](https://github.com/vercel/ncc/)
+- [jest](https://github.com/facebook/jest)
+- [ora](https://github.com/sindresorhus/ora)
+- [commander](https://github.com/tj/commander.js/)
+- [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)
 
-## Example:
+## Contributing
 
-        import {createEncoder, encodeConfig, decodeConfig} from 'huffman-url-compressor';
+Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated **greatly appreciated**.
 
-        //create encoder
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
 
-        let Encoder = createEncoder(train);
+<!-- LICENSE -->
 
-        //create a base64 encoded stream
-
-        let encodedParam = encodeConfig(test,Encoder)
-        
-        //retrieve the original param 
-
-        let decodParam= decodeConfig(encodedParam,Encoder)
+## License
 
+Distributed under the MIT License. See `LICENSE` for more information.