njfs - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

package.json

 {
     "name": "njfs",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "keywords": [
+        "es6",
         "util",
-        "functional",
-        "server",
         "node",
-        "fs",
+        "filesystem",
+        "directory",
+        "path",
         "file",
         "folder",
+        "unix",
+        "root",
         "move",
@@ -16,3 +19,3 @@ "copy",
     ],
-    "description": "A small, quick and user friendly async filesystem functions for Node js",
+    "description": "A small collection of sync & async filesystem functions for use in node js.",
     "author": "Orçun Saltık",
@@ -22,3 +25,4 @@ "email": "[e-mail]",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "lint": "eslint main.js -o error.log",
+        "test": "npm run lint"
     },
@@ -34,3 +38,16 @@ "contributors": [],
     },
-    "homepage": "https://github.com/orcunsaltik/njfs#readme"
+    "homepage": "https://github.com/orcunsaltik/njfs#readme",
+    "devDependencies": {
+        "eslint": "^7.10.0"
+    },
+    "eslintConfig": {
+        "env": {
+            "browser": false,
+               "node": true,
+                "es6": true
+        },
+        "parserOptions": {
+            "ecmaVersion": 2018
+        }
+    }
 }

README.md

@@ -1,5 +0,12 @@
-# njfs
-Node Js File System
+# Node Js File System
+[![Build Status](https://travis-ci.com/orcunsaltik/njfs.svg?branch=master)](https://travis-ci.com/orcunsaltik/njfs)
+[![Dependency Status](https://david-dm.org/orcunsaltik/njfs.svg)](https://david-dm.org/orcunsaltik/njfs)
+[![devDependencies Status](https://david-dm.org/orcunsaltik/njfs/dev-status.svg)](https://david-dm.org/orcunsaltik/njfs?type=dev)
+[![Maintainability](https://api.codeclimate.com/v1/badges/035ff3499e767eb6b552/maintainability)](https://codeclimate.com/github/orcunsaltik/njfs/maintainability)
+![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/orcunsaltik/njfs)
+![npm](https://img.shields.io/npm/dt/njfs)
+[![NPM Version](https://badge.fury.io/js/njfs.svg?style=flat)](https://npmjs.org/package/njfs)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/orcunsaltik/njfs/issues)
 
-A small, quick and user friendly async filesystem functions for Node js. 
+A small collection of sync & async filesystem functions for Node Js. 
 
@@ -9,5 +16,15 @@ ## Install
 ``` bash
-npm install --save-dev njfs
+npm install njfs
 ```
 
+## Methods
+
+1. unix(path): Synchronous. Returns path with unix-like directory separators.
+2. root(path): Synchronous. Returns the root directory of the package.
+3. list(path): Asynchronous. Returns the list of files and folders of the given path.
+4. move(path, dest): Asynchronous. Moves files or folders.
+5. copy(path, dest): Asynchronous. Copies files or folders.
+6. isFile(path): Synchronous. Checks whether the specified path is an existing file or not.
+7. isDir(path): Synchronous. Checks whether the specified path is an existing directory or not.
+
 ## Usage
@@ -14,0 +31,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6685

increased by37.58%

Number of package files

5

increased by25%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

56

increased by43.59%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes