safename - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

bower.json

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

docs/api.md

@@ -8,5 +8,6 @@ safename API
 - [middle](#middle)
+- [dot](#dot)
 
 <a name="safename"></a>
-safename( filename, space )
+safename( name, space )
 ------------------------------------------------------------
@@ -18,3 +19,3 @@
 
-- **filename** *String*: string to transform
+- **name** *String*: string to transform
 - **space** *String*: replace for spaces. Optional, low dash (&#x27;_&#x27;) by default
@@ -50,2 +51,14 @@ - **Return** *String*: safe name
 
+<a name="dot"></a>
+dot(  )
+------------------------------------------------------------
 
+Safe name with dots '.'.
+
+**Parameters:**
+
+
+
+Same as `safename('your file name.txt', '.');`
+
+

docs/readme.md

@@ -6,2 +6,3 @@ safename
 
+![tests badge](https://travis-ci.org/jacoborus/safename.svg?branch=master)
 
@@ -26,2 +27,5 @@
 // => my-file-name.txt
+
+safename.dot('my file name.txt', '.');
+// => my.file.name.txt
 ```
@@ -28,0 +32,0 @@

package.json

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

README.md

@@ -6,2 +6,3 @@ safename
 
+![tests badge](https://travis-ci.org/jacoborus/safename.svg?branch=master)
 
@@ -26,2 +27,5 @@
 // => my-file-name.txt
+
+safename.dot('my file name.txt', '.');
+// => my.file.name.txt
 ```
@@ -51,5 +55,6 @@
 - [middle](#middle)
+- [dot](#dot)
 
 <a name="safename"></a>
-safename( filename, space )
+safename( name, space )
 ------------------------------------------------------------
@@ -61,3 +66,3 @@
 
-- **filename** *String*: string to transform
+- **name** *String*: string to transform
 - **space** *String*: replace for spaces. Optional, low dash (&#x27;_&#x27;) by default
@@ -74,6 +79,9 @@ - **Return** *String*: safe name
 Safe name with low dash '_'.
-Same as `safename('your file name.txt', '_');`
 
+**Parameters:**
 
 
+
+Same as `safename('your file name.txt', '_');`
+
 <a name="middle"></a>
@@ -84,7 +92,24 @@ middle(  )
 Safe name with middle dash '-'.
+
+**Parameters:**
+
+
+
 Same as `safename('your file name.txt', '-');`
 
+<a name="dot"></a>
+dot(  )
+------------------------------------------------------------
 
+Safe name with dots '.'.
 
+**Parameters:**
 
+
+
+Same as `safename('your file name.txt', '.');`
+
+
+
+
 Tests
@@ -91,0 +116,0 @@ -----

safename.js

@@ -148,2 +148,11 @@ 'use strict';
 
+	/**
+	 * Safe name with dots '.'.
+	 *
+	 * Same as `safename('your file name.txt', '.');`
+	 */
+	safename.dot = function (name) {
+		return transformName( name, '.');
+	};
+
 	// node.js
@@ -150,0 +159,0 @@ if((typeof module !== 'undefined') && (typeof module.exports !== 'undefined')) {

test/safename-test.js

@@ -24,2 +24,8 @@ var expect = require('chai').expect,
 
+describe('safename#dot', function () {
+	it('return safe file name', function() {
+		expect( safename.dot('My file name 1234 Ñáëîò~') ).to.equal( 'My.file.name.1234.Naeio' );
+	});
+});
 
+

No alert changes

Improved metrics

Total package byte prevSize

17019

increased by6.81%

Number of package files

13

increased by8.33%

Lines of code

205

increased by6.77%

Number of lines in readme file

130

increased by23.81%

No dependency changes