Skip to content

Commit

Permalink
Added README file and fixed up ESLint issue.
Browse files Browse the repository at this point in the history
  • Loading branch information
diadical committed Nov 4, 2015
1 parent 667307a commit 4765065
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 2 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# JavaScript ES2015 solutions to Cracking the Coding Interview
These are solutions and associated unit tests for the questions in Cracking the
Coding Interview 6th edition using JavaScript ES2015 features. These solutions
specifically take advantage of ES2015 enhancements to the JavaScript language
and require the latest Node.js (>= v5.0.0) to work properly. As not all ES2015
features are available in V8 yet babel is being used to fill in the gaps (at
this point only the ES2015 module syntax is being transpiled by babel).

### Setup the project
Once downloaded ensure that Node.js is installed and run the following commands
in this directory:
```bash
npm install
```

### Running unit tests
The solutions are demonstrated by a set of unit tests which use the Mocha unit
test framework and Chai as an assertions library. These tests can be executed
at any time with:
```bash
npm test
```

As part of the unit tests ESLint will also be run against all files to ensure
that the JavaScript is valid and follows best practice.

### Linting source code
While executing ESLint by itself is not necessary (as it runs as part of the
unit test execution) you can choose to run it with:
```bash
npm run lint
```

### Dependencies
This implementation of the solutions requires the following dependencies:

* Node.js >= v5.0.0
* npm >= v3
* Mocha (installed via npm)
* Chai (installed via npm)
* Babel (installed via npm)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Cracking the Coding Interview solutions in JavaScript (ES2015)",
"main": "index.js",
"scripts": {
"lint": "./node_modules/.bin/eslint .",
"lint": "./node_modules/.bin/eslint . && echo All good!",
"test": "./node_modules/.bin/mocha"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion test/eslint.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import lint from 'mocha-eslint';
// Note: a seperate Mocha test will be run for each path and each file which
// matches a glob pattern
let paths = [
'src/**/*.js',
'src/**/*.js'
];

// Specify style of output
Expand Down

0 comments on commit 4765065

Please sign in to comment.