lodown-masonkristopher

lodown

An npm functional programming library project

In this project, you're going to create your own functional library of code and release this code for use through the npm (Node Package Management) platform.

You'll then use your lodown library to solve problems in the next project.

Setup

1. Fork this repository to your own GitHub account.

2. Clone your forked version of the lodown repository to a new Cloud9 workspace.

3. We'll need a package.json file, which describes for npm our library project and lists any dependant libraries of code. To create a package.json configuration file for our lodown library, from the command-line, run the command:

    npm init
   

4. IMPORTANT CONFIGURATION: Fill in the prompts with your own details:

   1. When asked to name your lodown project, give it a unique name by appending your GitHub username to the name of the project (of course, replacing <my-github-username> with your actual GitHub username.), like so:

      lodown-<my-github-username>

   2. When asked for test command, enter:

      istanbul cover _mocha -- test/ -R spec

   3. When asked for your git repository, you will probably be given the correct url as the default, so just select this by pressing return, otherwise, provide your forked GitHub repository's url.

5. Once you're done creating your package.json file, go to the command line and install the required test libraries by running the following command:

    npm install i -D mocha chai sinon istanbul
   

6. Implement your library in the file index.js. Remember that index.js is a Node.js module, so you must export your API using module.exports, for example:

    function each(collection, action) {
        // ...code
    }
    module.exports.each = each;
   

7. Write clear docs for each Function using the proper JavaScript documentation format. You should clearly explain how each Function works, the type of each paramater and how each paramater is used, and explain any return value. It should be evident from your docs you clearly understand how each Function works. Bonus points for listing usage examples in your docs. Example:

    /**
     * filter: Designed to filter values in a collection based on a test. 
     * Takes a collection, Array or Object, and passes each value 
     * in the collection through a test Function. The test Function returns 
     * true if the value passes the test, false otherwise. Values that pass 
     * the test are collected and returned in an output Array.
     * 
     * @param {Array or Object} collection: The collection to filter.
     * @param {Function} test: The Function to be applied to each value in 
     * the collection. The test Function must return a Boolean based on some 
     * logic which tests the value given to it.
     * 
     * @return {Array}: An Array containing the filtered collection values. 
     * The Array will contain only the values that passed the test.
     * 
     * Usage: 
     * 
     *      const letters = ['a', 'b', 'b', 'c'];
     *      const onlyBs = filter(letters, function(letter) {
     *          return letter === 'b';
     *      });
     *      console.log(onlyBs); // -> ['b', 'b']
     */
    function filter(collection, test) {
        // ...code
    }
    module.exports.each = each;
   

Release your library!

Once you're done with all Functions and their docs, release your lodown library to npm (node package manager), following the steps below to do so (using your GitHub username to create a unique name for your library):

1. Create a new account in npm's website.

2. Run this command from the terminal

    npm login
   

3. Enter your username and password. This will store the credentials so you don’t have to enter it for every publish.

4. Now to publish, run

    npm publish
   

This will publish your package to NPM registry. Once publish completes(in less than a minute), you can search for your package on npm's website.

Updating your library

If you want to make changes to your package, you have to change the version number and publish again.

The easiest way to do so is using the npm commands :

npm version patch
npm version minor 
npm version major 

to update the version automatically rather than manually updating them. These commands are based on semantic versioning.

Optional: Unit tests

If you want to learn about and create unit tests for your code, write your tests in the file test/index.spec.js. Check out the chai api for examples on asserting expectations and be careful when asserting/expecting against complex types - you'll have to make use of the .eql api, and not .equal. For example:

    expect(lodown.filter([1, 2, 3], function(value) { return value > 2; } )).to.eql([3]);

8. To run your tests, run the following command:

    npm test
   

9. Check the console output for passes and failures.

10. Preview (Cloud9) or open the file at coverage/lcov-report/index.html for your coverage report. Make certain all lines of code are traversed in your tests!

Resources:

Docs

1. https://mochajs.org
2. http://chaijs.com/api/bdd/
3. http://sinonjs.org/docs/#spies-api

Reading

1. http://marcofranssen.nl/using-mocha-chai-sinon-to-test-node-js/
2. http://stackoverflow.com/questions/19298118/what-is-the-role-of-describe-in-mocha
3. http://www.vapidspace.com/coding/2014/10/29/code-coverage-metrics-with-mocha-and-istanbul/

Quick Videos

1. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-setting-up-unit-testing-with-mocha-and-chai
2. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-unit-testing-with-mocha-and-chai