dir-parser - npm Package Compare versions

Comparing version 1.0.8 to 1.0.9

package.json

 {
   "name": "dir-parser",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Parse a directory and generate it's structure tree.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -35,4 +35,3 @@ # Dir Parser
 
-> $ cd your/demo/app
-
+> $ cd your/demo/app<br>
 > $ parse
@@ -60,4 +59,3 @@ ```
 
-> $ parse -e bin,public -n -s
-
+> $ parse -e bin,public -n -s<br>
 > $ cat dir-info.txt
@@ -94,6 +92,3 @@ ```
   "output": "your/output/dir",
-  "excludes": [
-    ".git",
-    "node_modules"
-  ]
+  "excludes": [ ".git", "node_modules" ]
 }
@@ -105,13 +100,12 @@ ```
 
-> $ npm install dir-parse funclib
-
+> $ npm install dir-parse funclib<br>
 > $ vi test.js
 ```
   const fn = require('funclib');
-  const parse = require('./index');
+  const parse = require('dir-parser');
 
   const target = './';
-  const excludes = ['.git'];
+  let excludes = [ '.git', 'dir-info.txt', 'package-lock.json' ];
 
-  const parsed = parse(target, {
+  let parsed = parse(target, {
     excludes: excludes,
@@ -123,8 +117,18 @@ // dirTree: false,    // Default is true, returns will conatins a string of directory structure truee;
 
-  const BaseInfo = fn.pick(parsed, prop => !['members', 'files', 'dirTree'].includes(prop));
+  const BaseInfo = fn.pick(parsed, prop => prop !== 'dirTree');
 
-  fn.log(BaseInfo, '# Parsed Info');
+  fn.log(BaseInfo, '# Parsed Basic Info');
   fn.log(parsed.dirTree, '# Parsed Dir Tree');
   // fn.log(parsed.files, '# Parsed Dir Files');
   // fn.log(parsed.members, '# Parsed Dir Members');
+
+  excludes = ['.git', 'node_modules', 'dir-info.txt', 'package-lock.json'];
+  parsed = parse(target, {
+    excludes: excludes,
+    dirTree: false,
+    files: true,
+    members: true
+  });
+
+  fn.log(parsed, '# Parsed Info');
 ```
@@ -134,3 +138,3 @@ > $ node test.js
 ==================================================================
-                    [22:10:07] # Parsed Info
+                 [23:39:52] # Parsed Basic Info
 ------------------------------------------------------------------
@@ -141,7 +145,7 @@ {
   "path": "./",
-  "absPath": "E:\\Code\\dir-parser",
+  "absPath": "D:\\Code\\dir-parser",
   "dir": ".",
-  "absDir": "E:\\Code",
+  "absDir": "D:\\Code",
   "dirNum": 8,
-  "fileNum": 31
+  "fileNum": 29
 }
@@ -152,5 +156,5 @@ ==================================================================
 ==================================================================
-                  [22:10:07] # Parsed Dir Tree
+                  [23:39:52] # Parsed Dir Tree
 ------------------------------------------------------------------
-dir-parser ( Directorys: 8, Files: 31 )
+dir-parser ( Directorys: 8, Files: 29 )
  ├─ bin
@@ -188,6 +192,4 @@ │ └─ parser.js
  ├─ .gitignore
- ├─ dir-info.txt
  ├─ dir-parser.png
  ├─ index.js
- ├─ package-lock.json
  ├─ package.json
@@ -197,2 +199,268 @@ ├─ README.md
 ==================================================================
+
+
+==================================================================
+                    [23:39:52] # Parsed Info
+------------------------------------------------------------------
+{
+  "name": "dir-parser",
+  "type": "directory",
+  "size": 174696,
+  "size_kb": "170.6kb",
+  "path": "./",
+  "absPath": "D:\\Code\\dir-parser",
+  "dir": ".",
+  "absDir": "D:\\Code",
+  "dirNum": 2,
+  "fileNum": 6,
+  "members": [
+    {
+      "name": "bin",
+      "type": "directory",
+      "size": 2761,
+      "size_kb": "2.7kb",
+      "path": "bin",
+      "absPath": "D:\\Code\\dir-parser\\bin",
+      "dir": ".",
+      "absDir": "D:\\Code\\dir-parser",
+      "dirNum": 0,
+      "fileNum": 1,
+      "members": [
+        {
+          "name": "parser.js",
+          "base": "parser",
+          "ext": ".js",
+          "type": "file",
+          "size": 2761,
+          "size_kb": "2.7kb",
+          "path": "bin\\parser.js",
+          "absPath": "D:\\Code\\dir-parser\\bin\\parser.js",
+          "dir": "bin",
+          "absDir": "D:\\Code\\dir-parser\\bin"
+        }
+      ]
+    },
+    {
+      "name": "src",
+      "type": "directory",
+      "size": 5465,
+      "size_kb": "5.34kb",
+      "path": "src",
+      "absPath": "D:\\Code\\dir-parser\\src",
+      "dir": ".",
+      "absDir": "D:\\Code\\dir-parser",
+      "dirNum": 0,
+      "fileNum": 2,
+      "members": [
+        {
+          "name": "base.js",
+          "base": "base",
+          "ext": ".js",
+          "type": "file",
+          "size": 1037,
+          "size_kb": "1.01kb",
+          "path": "src\\base.js",
+          "absPath": "D:\\Code\\dir-parser\\src\\base.js",
+          "dir": "src",
+          "absDir": "D:\\Code\\dir-parser\\src"
+        },
+        {
+          "name": "dir-parser.js",
+          "base": "dir-parser",
+          "ext": ".js",
+          "type": "file",
+          "size": 4428,
+          "size_kb": "4.32kb",
+          "path": "src\\dir-parser.js",
+          "absPath": "D:\\Code\\dir-parser\\src\\dir-parser.js",
+          "dir": "src",
+          "absDir": "D:\\Code\\dir-parser\\src"
+        }
+      ]
+    },
+    {
+      "name": ".gitignore",
+      "base": ".gitignore",
+      "ext": "",
+      "type": "file",
+      "size": 34,
+      "size_kb": "0.03kb",
+      "path": ".gitignore",
+      "absPath": "D:\\Code\\dir-parser\\.gitignore",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "dir-parser.png",
+      "base": "dir-parser",
+      "ext": ".png",
+      "type": "file",
+      "size": 76470,
+      "size_kb": "74.68kb",
+      "path": "dir-parser.png",
+      "absPath": "D:\\Code\\dir-parser\\dir-parser.png",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "index.js",
+      "base": "index",
+      "ext": ".js",
+      "type": "file",
+      "size": 45,
+      "size_kb": "0.04kb",
+      "path": "index.js",
+      "absPath": "D:\\Code\\dir-parser\\index.js",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "package.json",
+      "base": "package",
+      "ext": ".json",
+      "type": "file",
+      "size": 732,
+      "size_kb": "0.71kb",
+      "path": "package.json",
+      "absPath": "D:\\Code\\dir-parser\\package.json",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "README.md",
+      "base": "README",
+      "ext": ".md",
+      "type": "file",
+      "size": 4911,
+      "size_kb": "4.8kb",
+      "path": "README.md",
+      "absPath": "D:\\Code\\dir-parser\\README.md",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "test.js",
+      "base": "test",
+      "ext": ".js",
+      "type": "file",
+      "size": 1043,
+      "size_kb": "1.02kb",
+      "path": "test.js",
+      "absPath": "D:\\Code\\dir-parser\\test.js",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    }
+  ],
+  "files": [
+    {
+      "name": "parser.js",
+      "base": "parser",
+      "ext": ".js",
+      "type": "file",
+      "size": 2761,
+      "size_kb": "2.7kb",
+      "path": "bin\\parser.js",
+      "absPath": "D:\\Code\\dir-parser\\bin\\parser.js",
+      "dir": "bin",
+      "absDir": "D:\\Code\\dir-parser\\bin"
+    },
+    {
+      "name": "base.js",
+      "base": "base",
+      "ext": ".js",
+      "type": "file",
+      "size": 1037,
+      "size_kb": "1.01kb",
+      "path": "src\\base.js",
+      "absPath": "D:\\Code\\dir-parser\\src\\base.js",
+      "dir": "src",
+      "absDir": "D:\\Code\\dir-parser\\src"
+    },
+    {
+      "name": "dir-parser.js",
+      "base": "dir-parser",
+      "ext": ".js",
+      "type": "file",
+      "size": 4428,
+      "size_kb": "4.32kb",
+      "path": "src\\dir-parser.js",
+      "absPath": "D:\\Code\\dir-parser\\src\\dir-parser.js",
+      "dir": "src",
+      "absDir": "D:\\Code\\dir-parser\\src"
+    },
+    {
+      "name": ".gitignore",
+      "base": ".gitignore",
+      "ext": "",
+      "type": "file",
+      "size": 34,
+      "size_kb": "0.03kb",
+      "path": ".gitignore",
+      "absPath": "D:\\Code\\dir-parser\\.gitignore",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "dir-parser.png",
+      "base": "dir-parser",
+      "ext": ".png",
+      "type": "file",
+      "size": 76470,
+      "size_kb": "74.68kb",
+      "path": "dir-parser.png",
+      "absPath": "D:\\Code\\dir-parser\\dir-parser.png",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "index.js",
+      "base": "index",
+      "ext": ".js",
+      "type": "file",
+      "size": 45,
+      "size_kb": "0.04kb",
+      "path": "index.js",
+      "absPath": "D:\\Code\\dir-parser\\index.js",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "package.json",
+      "base": "package",
+      "ext": ".json",
+      "type": "file",
+      "size": 732,
+      "size_kb": "0.71kb",
+      "path": "package.json",
+      "absPath": "D:\\Code\\dir-parser\\package.json",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "README.md",
+      "base": "README",
+      "ext": ".md",
+      "type": "file",
+      "size": 4911,
+      "size_kb": "4.8kb",
+      "path": "README.md",
+      "absPath": "D:\\Code\\dir-parser\\README.md",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    },
+    {
+      "name": "test.js",
+      "base": "test",
+      "ext": ".js",
+      "type": "file",
+      "size": 1043,
+      "size_kb": "1.02kb",
+      "path": "test.js",
+      "absPath": "D:\\Code\\dir-parser\\test.js",
+      "dir": "",
+      "absDir": "D:\\Code\\dir-parser"
+    }
+  ]
+}
+==================================================================
 ```

test.js

@@ -5,14 +5,14 @@ const fn = require('funclib');
 const target = './';
-const excludes = ['.git'];
+let excludes = [ '.git', 'dir-info.txt', 'package-lock.json' ];
 
-const parsed = parse(target, {
+let parsed = parse(target, {
   excludes: excludes,
-  // dirTree: false,
-  // files: true,
-  // members: true
+  // dirTree: false,    // Default is true, returns will conatins a string of directory structure truee;
+  // files: true,       // Default is false, If true, parsed will conatins an array of all subfiles's info;
+  // members: true      // Default is false, If true, parsed will conatins an object of all members's info;
 });
 
-const BaseInfo = fn.pick(parsed, prop => !['members', 'files', 'dirTree'].includes(prop));
+const BaseInfo = fn.pick(parsed, prop => prop !== 'dirTree');
 
-fn.log(BaseInfo, '# Parsed Info');
+fn.log(BaseInfo, '# Parsed Basic Info');
 fn.log(parsed.dirTree, '# Parsed Dir Tree');
@@ -22,1 +22,10 @@ // fn.log(parsed.files, '# Parsed Dir Files');
 
+excludes = ['.git', 'node_modules', 'dir-info.txt', 'package-lock.json'];
+parsed = parse(target, {
+  excludes: excludes,
+  dirTree: false,
+  files: true,
+  members: true
+});
+
+fn.log(parsed, '# Parsed Info');

New alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

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

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed 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

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

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

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

99223

8.22%

Lines of code

293

2.81%

Number of lines in readme file

456

142.55%

Number of medium supply chain risk alerts

1

-50%

No dependency changes