safename - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

bower.json

 {
   "name": "safename",
   "main": "safename.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "authors": [
@@ -6,0 +6,0 @@ "Jacobo Tabernero <[e-mail]>"

docs/api.md

@@ -28,4 +28,3 @@ safename API
 
-Safe name with low dash '_'
-Same as `safename('your file name.txt', '_');`
+Safe name with low dash '_'.
 
@@ -36,4 +35,4 @@ **Parameters:**
 
+Same as `safename('your file name.txt', '_');`
 
-
 <a name="middle"></a>
@@ -43,4 +42,3 @@ middle(  )
 
-Safe name with middle dash '-'
-Same as `safename('your file name.txt', '-');`
+Safe name with middle dash '-'.
 
@@ -51,4 +49,4 @@ **Parameters:**
 
+Same as `safename('your file name.txt', '-');`
 
 
-

docs/readme.md

@@ -7,15 +7,3 @@ safename
 
-## Installation
 
-Install with npm
-```
-$ npm install safename
-```
-
-Install with Bower
-```
-$ bower install safename
-```
-
-
 ## Example
@@ -41,1 +29,15 @@
 
+
+## Installation
+
+Install with npm
+```
+$ npm install safename
+```
+
+Install with Bower
+```
+$ bower install safename
+```
+
+

package.json

 {
   "name": "safename",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Get safe file name from a given string.",
@@ -5,0 +5,0 @@ "main": "./safename.js",

README.md

@@ -7,15 +7,3 @@ safename
 
-## Installation
 
-Install with npm
-```
-$ npm install safename
-```
-
-Install with Bower
-```
-$ bower install safename
-```
-
-
 ## Example
@@ -41,2 +29,16 @@
 
+
+## Installation
+
+Install with npm
+```
+$ npm install safename
+```
+
+Install with Bower
+```
+$ bower install safename
+```
+
+
 safename API
@@ -69,3 +71,3 @@ ============
 
-Safe name with low dash '_'
+Safe name with low dash '_'.
 Same as `safename('your file name.txt', '_');`
@@ -79,3 +81,3 @@
 
-Safe name with middle dash '-'
+Safe name with middle dash '-'.
 Same as `safename('your file name.txt', '-');`
@@ -85,2 +87,3 @@
 
+
 Tests
@@ -87,0 +90,0 @@ -----

safename.js

@@ -92,7 +92,7 @@ 'use strict';
 
-	var diacriticsMap = {};
+	var diaMap = {};
 	for (var i=0; i < diacritics.length; i++){
 		var letters = diacritics[i].letters.split('');
 		for (var j=0; j < letters.length ; j++){
-			diacriticsMap[letters[j]] = diacritics[i].base;
+			diaMap[letters[j]] = diacritics[i].base;
 		}
@@ -105,3 +105,3 @@ }
 		for(var i=0; i< letters.length; i++) {
-			newStr += letters[i] in diacriticsMap ? diacriticsMap[letters[i]] : letters[i];
+			newStr += letters[i] in diaMap ? diaMap[letters[i]] : letters[i];
 		}
@@ -111,11 +111,10 @@ return newStr;
 
-	// safe name for urls
 	var transformName = function (name, space) {
-		name = removeDiacritics( name );
-		name = name.replace(/ /g, space);
-		name = name.replace(/[^A-Za-z0-9-_\.]/g, '');
-		name = name.replace(/\.+/g, '.');
-		name = name.replace(/-+/g, '-');
-		name = name.replace(/_+/g, '_');
-		return name;
+		var n = removeDiacritics( name );
+		n = n.replace(/ /g, space);
+		n = n.replace(/[^A-Za-z0-9-_\.]/g, '');
+		n = n.replace(/\.+/g, '.');
+		n = n.replace(/-+/g, '-');
+		n = n.replace(/_+/g, '_');
+		return n;
 	};
@@ -125,25 +124,27 @@
 	 * Get safe name for files
-	 * @param  {String} filename string to transform
+	 * @param  {String} name string to transform
 	 * @param  {String} space    replace for spaces. Optional, low dash ('_') by default
 	 * @return {String}          safe name
 	 */
-	var safename = function (filename, space) {
+	var safename = function (name, space) {
 		space = space || '_';
-		return transformName( filename, space);
+		return transformName( name, space);
 	};
 
 	/**
-	 * Safe name with low dash '_'
+	 * Safe name with low dash '_'.
+	 *
 	 * Same as `safename('your file name.txt', '_');`
 	 */
-	safename.low = function (filename) {
-		return transformName( filename, '_');
+	safename.low = function (name) {
+		return transformName( name, '_');
 	};
 
 	/**
-	 * Safe name with middle dash '-'
+	 * Safe name with middle dash '-'.
+	 *
 	 * Same as `safename('your file name.txt', '-');`
 	 */
-	safename.middle = function (filename) {
-		return transformName( filename, '-');
+	safename.middle = function (name) {
+		return transformName( name, '-');
 	};
@@ -150,0 +151,0 @@

No alert changes

Improved metrics

Lines of code

192

increased by0.52%

Number of lines in readme file

105

increased by2.94%

Worsened metrics

Total package byte prevSize

15934

decreased by-0.59%

No dependency changes