Skip to content

Commit

Permalink
Initial import with grunt tests and library setup
Browse files Browse the repository at this point in the history
  • Loading branch information
nyxtom committed Jan 29, 2013
1 parent 00b6ee3 commit 527a23b
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -12,3 +12,4 @@ logs
results

npm-debug.log
node_modules
1 change: 1 addition & 0 deletions .npmignore
@@ -0,0 +1 @@
/node_modules/
22 changes: 22 additions & 0 deletions LICENSE-MIT
@@ -0,0 +1,22 @@
Copyright (c) 2013 Thomas Holloway

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.
29 changes: 26 additions & 3 deletions README.md
@@ -1,4 +1,27 @@
dive
====
# dive

Various standard diving algorithms, formulas, calculations and device management.
Various standard scuba diving algorithms, formulas, calculations and device management.

## Getting Started
Install the module with: `npm install dive`

```javascript
var dive = require('dive');
dive.awesome(); // "awesome"
```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/gruntjs/grunt).

## Release History
_(Nothing yet)_

## License
Copyright (c) 2013 Thomas Holloway
Licensed under the MIT license.
39 changes: 39 additions & 0 deletions grunt.js
@@ -0,0 +1,39 @@
module.exports = function(grunt) {

// Project configuration.
grunt.initConfig({
pkg: '<json:package.json>',
test: {
files: ['test/**/*.js']
},
lint: {
files: ['grunt.js', 'lib/**/*.js', 'test/**/*.js']
},
watch: {
files: '<config:lint.files>',
tasks: 'default'
},
jshint: {
options: {
curly: true,
eqeqeq: true,
immed: true,
latedef: true,
newcap: true,
noarg: true,
sub: true,
undef: true,
boss: true,
eqnull: true,
node: true
},
globals: {
exports: true
}
}
});

// Default task.
grunt.registerTask('default', 'lint test');

};
2 changes: 2 additions & 0 deletions index.js
@@ -0,0 +1,2 @@

module.exports = require('./lib/dive');
11 changes: 11 additions & 0 deletions lib/dive.js
@@ -0,0 +1,11 @@
/*
* dive
* https://github.com/nyxtom/dive
*
* Copyright (c) 2013 Thomas Holloway
* Licensed under the MIT license.
*/

exports.awesome = function() {
return 'awesome';
};
35 changes: 35 additions & 0 deletions package.json
@@ -0,0 +1,35 @@
{
"name": "dive",
"description": "Various standard scuba diving algorithms, formulas, calculations and device management.",
"version": "0.1.0",
"homepage": "https://github.com/nyxtom/dive",
"author": {
"name": "Thomas Holloway",
"email": "nyxtom@gmail.com",
"url": "http://github.com/nyxtom"
},
"repository": {
"type": "git",
"url": "git://github.com/nyxtom/dive.git"
},
"bugs": {
"url": "https://github.com/nyxtom/dive/issues"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/nyxtom/dive/blob/master/LICENSE-MIT"
}
],
"main": "lib/dive",
"engines": {
"node": ">= 0.6.0"
},
"scripts": {
"test": "grunt test"
},
"devDependencies": {
"grunt": "~0.3.17"
},
"keywords": []
}
34 changes: 34 additions & 0 deletions test/dive_test.js
@@ -0,0 +1,34 @@
var dive = require('../lib/dive.js');

/*
======== A Handy Little Nodeunit Reference ========
https://github.com/caolan/nodeunit
Test methods:
test.expect(numAssertions)
test.done()
Test assertions:
test.ok(value, [message])
test.equal(actual, expected, [message])
test.notEqual(actual, expected, [message])
test.deepEqual(actual, expected, [message])
test.notDeepEqual(actual, expected, [message])
test.strictEqual(actual, expected, [message])
test.notStrictEqual(actual, expected, [message])
test.throws(block, [error], [message])
test.doesNotThrow(block, [error], [message])
test.ifError(value)
*/

exports['awesome'] = {
setUp: function(done) {
// setup here
done();
},
'no args': function(test) {
test.expect(1);
// tests here
test.equal(dive.awesome(), 'awesome', 'should be awesome.');
test.done();
}
};

0 comments on commit 527a23b

Please sign in to comment.