safename - npm Package Compare versions

Comparing version 1.0.2 to 2.0.0

package.json

 {
   "name": "safename",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Get safe file name from a given string.",
-  "main": "./safename.js",
+  "main": "lib/safename.js",
+  "types": "lib/safename.d.ts",
   "scripts": {
-    "test": "node ./node_modules/mocha/bin/mocha",
-    "build-docs": "node ./docs/createdocs.js && cat ./docs/readme.md ./docs/api.md ./docs/footer.md > ./README.md"
+    "linter": "eslint 'src/*.ts'",
+    "test": "jest",
+    "prepublish": "rm -rf lib && tsc",
+    "build": "rm -rf lib && tsc"
   },
@@ -17,5 +20,7 @@ "repository": {
     "filename",
-    "diacritics"
+    "diacritics",
+    "normalize-string",
+    "string-manipulation"
   ],
-  "author": "Jacobo Tabernero",
+  "author": "Jacobo Tabernero Rey <[e-mail]>",
   "contributors": [
@@ -30,6 +35,28 @@ "Pavel Lysenko aka Ohar <[e-mail]> (http://ohar.name)"
   "devDependencies": {
-    "chai": "^1.10.0",
-    "mocha": "^1.21.5",
-    "updox": "0.0.5"
+    "@types/jest": "^26.0.21",
+    "@typescript-eslint/eslint-plugin": "^4.19.0",
+    "@typescript-eslint/parser": "^4.19.0",
+    "eslint": "^7.22.0",
+    "eslint-config-standard": "^16.0.2",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.3.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-standard": "^5.0.0",
+    "jest": "^26.6.3",
+    "ts-jest": "^26.5.4",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.2.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "ts",
+      "json"
+    ],
+    "transform": {
+      ".+\\.tsx?$": "ts-jest"
+    },
+    "testURL": "http://localhost"
   }
 }

README.md

 safename
 ========
 
-Get safe file name from a given string.
+Normalize diacritics and dashes, and transform spaces from strings
 
@@ -12,51 +12,17 @@ [![Build Status](https://travis-ci.org/jacoborus/safename.svg?branch=master)](https://travis-ci.org/jacoborus/safename)
 ```js
-// require only in node/browserify
-var safename = require( 'safename' );
+import { safename } from 'safename'
 
-safename('my file name.txt');
-// => my_file_name.txt
+safename('My file name 1234 Ñáëîò~')
+// => My_file_name_1234_Naeio
 
-safename('my file name.txt', '-');
-// => my-file-name.txt
-
-safename.low('my file name.txt');
-// => my_file_name.txt
-
-safename.middle('my file name.txt');
-// => my-file-name.txt
-
-safename.dot('my file name.txt');
-// => my.file.name.txt
+safename('My file name 1234 Ñáëîò~', '.')
+// => My.file.name.1234.Naeio
 ```
 
+## Usage
 
-
-## Installation
-
-Install with npm
 ```
-$ npm install safename
+safename( name, space )
 ```
 
-Install with Bower
-```
-$ bower install safename
-```
-
-
-safename API
-============
-
-
-- [safename](#safename)
-- [low](#low)
-- [middle](#middle)
-- [dot](#dot)
-
-<a name="safename"></a>
-safename( name, space )
-------------------------------------------------------------
-
-Get safe name for files
-
 **Parameters:**
@@ -70,42 +36,15 @@
 
+## Installation
 
-<a name="low"></a>
-low(  )
-------------------------------------------------------------
+Install with npm
+```
+$ npm install safename
+```
 
-Safe name with low dash '_'.
+Install with Yarn
+```
+$ yarn add safename
+```
 
-**Parameters:**
 
-
-
-Same as `safename('your file name.txt', '_');`
-
-<a name="middle"></a>
-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
@@ -118,10 +57,2 @@ -----
 
-Build API docs
---------------
-
-```
-npm install && npm run build-docs
-```
-
-
 <br><br>
@@ -131,4 +62,4 @@
 
-© 2014 [jacoborus](https://github.com/jacoborus)
+© 2014-2021 [Jacobo Tabernero Rey](https://github.com/jacoborus)
 
-Released under [MIT License](https://raw.github.com/jacoborus/safename/master/LICENSE)
+Released under [MIT License](https://raw.github.com/jacoborus/safename/master/LICENSE)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

13212

decreased by-23.98%

Dev dependency count

14

increased by366.67%

Number of package files

6

decreased by-53.85%

Lines of code

154

decreased by-27.7%

Number of lines in readme file

62

decreased by-52.31%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes