Merge pull request #1 from sergejmueller/1.0.0

1.0.0

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+    "plugins": ["node"],
+    "extends": ["eslint:recommended", "plugin:node/recommended"],
+    "env": {
+        "mocha": true,
+        "node": true
+    },
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "rules": {
+        "no-console": 0
+    }
+}

.gitignore

@@ -2,4 +2,3 @@ node_modules
 .npm
 logs
 *.log
-*.lock

.travis.yml

@@ -5,4 +5,4 @@ node_js:
   - "4"
   - "0.12"
   - "0.11"
-  - "0.10"
+  - "0.10"

CHANGELOG.md

@@ -1,3 +1,16 @@
+# ltrim / CHANGELOG
+
+
+### v1.0.0 (2016-10-27)
+
+* Add ESLint with `node` plugin
+* Remove `*.lock` from `.gitignore`
+* Refactor `package.json`
+* Text changes in `README.md`
+* Add `yarn.lock` file
+* Some code cleanups
+
+
 ### v0.0.3 (2016-06-17)
 
 * Cleanup readme
@@ -11,4 +24,4 @@
 
 ### v0.0.1 (2016-06-16)
 
-* Initial commit

+* Initial commit


README.md

@@ -1,7 +1,7 @@
 ltrim
 ============
 
-`ltrim` [Node.js module](https://www.npmjs.com/package/ltrim) returns a string with whitespace (or other characters) stripped from the beginning of a string. Without dependencies and library bloat.
+`ltrim` Node.js module returns a string with whitespace (or other characters) stripped from the beginning of a string. Without dependencies and library bloat.
 
 
 [![Dependency Status](https://david-dm.org/sergejmueller/ltrim.svg)](https://david-dm.org/sergejmueller/ltrim)
@@ -13,10 +13,16 @@ ltrim
 Install
 -----
 
-```
+```bash
 npm install ltrim
 ```
 
+*or*
+
+```bash
+yarn add ltrim
+```
+
 
 Usage
 -----
@@ -25,8 +31,10 @@ Usage
 ltrim ( str [, chars ] )
 ```
 
-`str` → The input string<br>
-`chars` → Characters that you want to be stripped
+Parameter | Description
+--- | ---
+`str` | The input string
+`chars` | Characters that you want to be stripped
 
 Without the second parameter, `ltrim` will strip whitespaces (spaces, tabs and new lines).
 
@@ -35,8 +43,7 @@ Examples
 -----
 
 ```javascript
-var ltrim = require('ltrim');
-
+var ltrim = require( 'ltrim' );
 
 /* Strip whitespace from the beginning of a string */
 ltrim( '    Hello    ' ) + ' World' // →Hello     World

examples/ltrim.js

@@ -1,7 +1,7 @@
 "use strict";
 
 
-var ltrim = require('..');
+var ltrim = require( '..' );
 
 
 /**

index.js

@@ -29,7 +29,7 @@ module.exports = function ( str, chars ) {
 
     // Set vars
     var i = 0,
-        letters = str.split(''),
+        letters = str.split( '' ),
         count = letters.length;
 
     // Loop letters

package.json

@@ -1,31 +1,37 @@
 {
-    "name": "ltrim",
-    "version": "0.0.3",
-    "description": "Strip whitespace - or other characters - from the beginning of a string",
-    "main": "index.js",
-    "scripts": {
-        "test": "mocha"
-    },
-    "keywords": [
-        "trim",
-        "ltrim",
-        "strip",
-        "string"
-    ],
-    "author": {
-        "name": "Sergej Müller",
-        "url": "https://sergejmueller.github.io"
-    },
-    "homepage": "https://github.com/sergejmueller/ltrim",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/sergejmueller/ltrim.git"
-    },
-    "license": "MIT",
-    "devDependencies": {
-        "chai": "^3.5.0",
-        "mocha": "^3.1.2",
-        "array-range": "^1.0.1",
-        "shuffle-array": "^1.0.0"
-    }
+  "name": "ltrim",
+  "version": "1.0.0",
+  "description": "Strip whitespace - or other characters - from the beginning of a string",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "test": "mocha",
+    "lint": "eslint ."
+  },
+  "keywords": [
+    "trim",
+    "ltrim",
+    "strip",
+    "string"
+  ],
+  "author": {
+    "name": "Sergej Müller",
+    "url": "https://sergejmueller.github.io"
+  },
+  "homepage": "https://github.com/sergejmueller/ltrim",
+  "repository": "sergejmueller/ltrim",
+  "license": "MIT",
+  "devDependencies": {
+    "array-range": "^1.0.1",
+    "chai": "^3.5.0",
+    "eslint": "^3.8.1",
+    "eslint-plugin-node": "^2.1.3",
+    "mocha": "^3.1.2",
+    "shuffle-array": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=0.10"
+  }
 }

test/test.js

@@ -1,10 +1,10 @@
 "use strict";
 
 
-var ltrim = require('..'),
-    range = require('array-range'),
-    shuffle = require('shuffle-array'),
-    expect = require('chai').expect;
+var ltrim = require( '..' ),
+    range = require( 'array-range' ),
+    shuffle = require( 'shuffle-array' ),
+    expect = require( 'chai' ).expect;
 
 
 describe( 'Strip characters from the beginning of a string', function() {
@@ -67,6 +67,6 @@ var shuffledSpecialChars = function() {
         chars.push( String.fromCharCode( _ ) );
     } );
 
-    return shuffle( chars ).join('');
+    return shuffle( chars ).join( '' );
 
 }