Release: #1 options parameter and ignore_stages options

Add also CHANGELOG.md, CONTRIBUTING.md and update README.md. Also update .gitignore to not track .tmp/ directory.

.gitignore

@@ -17,3 +17,6 @@ build/Release
 # Deployed apps should consider commenting this line out:
 # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
+
+# Temporary files
+.tmp

CHANGELOG.md

@@ -0,0 +1,9 @@
+Changelog [^1]
+==============
+
+### `v0.1.0` 2014-07-31
+
+ * API change: Add a optional `options` parameter to the function.
+ * New feature: Use `{ ignore_stages: true }` to only return stables versions.
+
+[^1]: Date in *ISO 8601* format (year-month-day)

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+Contributing :heart:
+====================
+
+Thanks for your interest! In order to keep the code coherent there are some
+easy-to-follow rules.
+
+ * Use [JSHint](http://www.jshint.com) and respect the `.jshintrc` file.
+ * Use [EditorConfig](http://www.editorconfig.com) and respect the
+   `.editorconfig` file.
+ * Write test for your modifications (use `mocha` and `chai` modules).
+ * Keep the code coverage as high as possible (100% is awesome!). Install
+   `istanbul` module and run `npm run coverage` to check it.
+ * Proudly add yourself to the authors in `package.json`! :+1:

README.md

@@ -1,4 +1,5 @@
-[![version-sort logo](https://raw.githubusercontent.com/quentinrossetti/version-sort/master/logo.png)](https://github.com/quentinrossetti/version-sort)
+version-sort
+============
 
 [![Dependencies Status][gemnasium-image]][gemnasium-url] [![Build Status][travis-image]][travis-url] [![Code quality][codeclimate-image]][codeclimate-url] [![Code coverage][coveralls-image]][coveralls-url] [![Release][npm-image]][npm-url]
 
@@ -18,17 +19,26 @@ This module sort an array of versions. Here some exemples of valid versions:
 2.4.20alpha
 2.4.20beta
 2.4.20rc1
-2.4.20rc
+2.4.20rc2
 ```
 
 To use it just call the module as a function.
 
 ```js
 var sort = require('version-sort');
 data = [ '2.4.20', '2.4.20rc1', '1.1', '2.4.20beta1' ];
-sort(data); // '1.1', '2.4.20', '2.4.20beta1', '2.4.20rc1'
+sort(data); // '1.1', '2.4.20beta1', '2.4.20rc1', '2.4.20'
 ```
 
+### Options
+
+```js
+var results = sort(data, options);
+```
+
+ * `ignore_stages`: *(default: `false`)* Only return stables versions and ignore
+   staged versions. `[ '1.1', '1.1alpha' ]` will return `[ '1.1' ]`.
+
 ## Installation
 
 ```bat

index.js

@@ -6,10 +6,18 @@ var _ = require('underscore');
  * @module version-sort
  * @function index
  * @param  {array} versions An array of versions to sort.
+ * @param {object} opts An object of options.
  * @return {array} The same version array but sorted.*
  * @license http://git.io/bHDfwQ ISC License
  */
-module.exports = function (versions) {
+module.exports = function (versions, opts) {
+
+  var options = {
+    ignore_stages: false
+  };
+  if (opts) {
+    options.ignore_stages = opts.ignore_stages || options.ignore_stages
+  }
 
   var regex = /^([\d+\.]+)(([a-z]*)(\d*))$/;
 
@@ -97,6 +105,9 @@ module.exports = function (versions) {
   var versionsSort = [];
 
   v.forEach(function (_version, _i) {
+    if (options.ignore_stages && _version.stageName) {
+      return;
+    }
     var calc = '';
     // number
     var split       = _version.number.split('.');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "version-sort",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Sort an array of versions.",
   "main": "index.js",
   "scripts": {

test/index.js

@@ -8,7 +8,7 @@ var expect = chai.expect;
 
 describe('version-sorter module', function () {
 
-  it('should sort softwares by version properly', function () {
+  it('should sort versions properly', function () {
     var data = [
       '1.1.0',
       '1.1.4.5687',
@@ -36,4 +36,10 @@ describe('version-sorter module', function () {
     }
   });
 
+  it('should return only stables version with `ignore_stages`', function () {
+    var data = [ '1.1alpha', '1.1', '1.2beta', '1.2', '1.3alpha' ];
+    var r = sorter(data, { ignore_stages: true });
+    expect(r).to.eql([ '1.1', '1.2' ]);
+  });
+
 });