diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,21 @@ +{ + "rules": { + "no-console": "off", + "indent": [ "error", 2 ], + "quotes": [ "error", "single" ], + "semi": ["error", "always"], + "linebreak-style": [ "error", "unix" ] + }, + "env": { + "es6": true, + "node": true, + "mocha": true, + "jasmine": true + }, + "ecmaFeatures": { + "modules": true, + "experimentalObjectRestSpread": true, + "impliedStrict": true + }, + "extends": "eslint:recommended" +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..92204fc --- /dev/null +++ b/.gitignore @@ -0,0 +1,128 @@ + +# Created by https://www.gitignore.io/api/node,macos,linux,windows + +### Linux ### +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +### macOS ### +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.gitignore.io/api/node,macos,linux,windows diff --git a/README.md b/README.md index 490cacb..f007c31 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,14 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 01: Node Ecosystem -=== - -## Submission Instructions - * work in a fork of this repository - * work in a branch on your fork - * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` - * submit a pull request to this repository - * submit a link to your pull request on canvas - * submit a question, observation, and how long you spent on canvas - -## Resources -* [node assert docs](https://nodejs.org/dist/latest-v4.x/docs/api/assert.html) -* [mocha docs](http://mochajs.org/#getting-started) - -## Requirements - -#### Configuration - -* include the following: - * **README.md** - contains documentation about your lab - * **.gitignore** - contains a robust `.gitignore` file - * **.eslintrc** - contains the provided `.eslintrc` file - * **.eslintignore** - contains the provided `.eslintignore` file - * **lib/** - should contain your modules - * **test/** - should contain your unit tests - -#### Feature Tasks -* create a node.js module (`greet.js`) that exports a single function - * the `greet` function should have a single parameter that should expect a string as it's input - * the `greet` function should return the input name, concatenated with "hello " - * the `greet` function should return `null` if the input is not a string -* create a node.js module named `arithmetic.js` - * this module should have `add` and `sub` methods - * the `add` method should contain 2 parameters - * these parameters should be numbers and the method should return the sum of the 2 numbers - * the `sub` method should contain 2 parameters - * these parameters should be numbers and the method should return the first number minus the second number -* decide on the expected behavior for non-number inputs - -#### Testing -* write a test the expects the greet module to return "hello world!" - * this should happen when invoked with "world!" as a parameter -* write a test for the `add` and `subtract` methods on the arithmetic module - * this should ensure that your functions work with number inputs - -#### Documentation -* write a description of your project (this should be in your `README.md` file) - -###### BONUS 1pt -* write a test that expects the greet module to return null when you use non string values -* write a test that ensures the functions work as expected with non number inputs - -## Rubric -* 2pts configuration -* 3pts feature tasks -* 3pts tests -* 2pts documentation +## Greeting and Arithmetic + * 2 Applications in this code base + * First says hello, takes an input of a name and outputs it + * Second does math, takes numbers in and maths them, outputs them + +## Running the App - Hello + * Using Node repl + * type in node (file name) + * Get Results + +## Running the App - Math + * Using node repl + * type in node (file name) + * Get Results diff --git a/lib/arithmetic.js b/lib/arithmetic.js new file mode 100644 index 0000000..b92a722 --- /dev/null +++ b/lib/arithmetic.js @@ -0,0 +1,13 @@ +'use strict'; + +module.exports = exports = {}; + +exports.add = function(a, b) { + if (typeof a !== 'number'|| typeof b !== 'number') return 'not a number'; + return(a + b); +}; + +exports.subtract = function(c, d) { + if (typeof c !== 'number'|| typeof d !== 'number' ) return 'not a number'; + return(c - d); +}; diff --git a/lib/greet.js b/lib/greet.js new file mode 100644 index 0000000..d068a07 --- /dev/null +++ b/lib/greet.js @@ -0,0 +1,6 @@ +'use strict'; + +module.exports = function(name) { + if (typeof name !== 'string') return null; + return(`hello ${name}!`); +}; diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js new file mode 100644 index 0000000..0a4d3c3 --- /dev/null +++ b/test/arithmetic-test.js @@ -0,0 +1,19 @@ +'use strict'; + +const math = require('../lib/arithmetic.js'); +const assert = require('assert'); + +describe('Math Module', function() { + describe('#add', function(){ + it('should return 5', function(){ + var result = math.add(2,3); + assert.ok(result === 5, 'you are wrong'); + }); + }); + describe('#subtract', function(){ + it('should return 1', function(){ + var result = math.subtract(3,2); + assert.ok(result === 1, 'you are wrong'); + }); + }); +}); diff --git a/test/greet-test.js b/test/greet-test.js new file mode 100644 index 0000000..c475fbb --- /dev/null +++ b/test/greet-test.js @@ -0,0 +1,17 @@ +'use strict'; + +const greeting = require('../lib/greet.js'); +const assert = require('assert'); + +describe('Greet Module', function(){ + describe('#greeting', function(){ + it('should return hello world!', function(){ + var result = greeting('world'); + assert.ok(result === 'hello world!', 'not equal to hello world!'); + }); + it('should throw not a string error', function(){ + var result = greeting(4); + assert.ok(result === null, 'error not thrown'); + }); + }); +});