refactor(tests): move from jest to japa test runner

Author: jlenon7

LICENSE renamed to LICENSE.md

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "1.8.8",
+  "version": "1.8.9",
   "description": "Utils functions and classes for Node.js",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -19,9 +19,11 @@
     "pagination"
   ],
   "scripts": {
-    "test": "npm run lint:fix && cross-env NODE_OPTIONS=--experimental-vm-modules jest --colors --verbose --runInBand",
-    "test:coverage": "npm run --silent test -- --coverage",
-    "lint:fix": "eslint \"{src,tests}/**/*.js\" --fix"
+    "lint:fix": "eslint \"{src,tests}/**/*.js\" --fix",
+    "test": "npm run --silent lint:fix && node ./tests/index.js",
+    "test:debug": "cross-env DEBUG=api:* && npm run --silent test",
+    "test:coverage": "c8 npm run --silent test",
+    "gen:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --out src/index.js"
   },
   "files": [
     "src/*.js",
@@ -31,8 +33,8 @@
   ],
   "type": "module",
   "main": "./src/index.js",
-  "types": "./src/index.d.ts",
   "exports": "./src/index.js",
+  "types": "./src/index.d.ts",
   "imports": {
     "#src/*": "./src/*.js",
     "#tests/*": "./tests/*.js"
@@ -58,6 +60,12 @@
     "youch-terminal": "2.1.3"
   },
   "devDependencies": {
+    "@japa/assert": "1.3.4",
+    "@japa/run-failed-tests": "1.0.7",
+    "@japa/runner": "2.0.7",
+    "@japa/spec-reporter": "1.1.12",
+    "@otris/jsdoc-tsd": "^2.0.11",
+    "c8": "7.11.2",
     "commitizen": "4.2.4",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",
@@ -69,9 +77,24 @@
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.0.0",
     "husky": "3.0.9",
-    "jest": "27.5.1",
     "lint-staged": "12.4.1",
-    "prettier": "2.6.2"
+    "minimist": "1.2.6",
+    "prettier": "2.6.2",
+    "rimraf": "3.0.2",
+    "tsd-jsdoc": "2.5.0",
+    "typescript": "4.6.4"
+  },
+  "c8": {
+    "all": true,
+    "include": [
+      "src/**/*.js"
+    ],
+    "reporter": [
+      "text-summary",
+      "html"
+    ],
+    "report-dir": "./tests/Coverage",
+    "check-coverage": true
   },
   "husky": {
     "hooks": {
@@ -93,30 +116,6 @@
       "path": "./node_modules/cz-conventional-changelog"
     }
   },
-  "jest": {
-    "rootDir": ".",
-    "testMatch": [
-      "**/tests/**/*Test.js"
-    ],
-    "transform": {},
-    "coverageDirectory": "./tests/Coverage",
-    "testEnvironment": "node",
-    "moduleNameMapper": {
-      "#src/(.*)": "<rootDir>/src/$1",
-      "#tests/(.*)": "<rootDir>/tests/$1",
-      "chalk": "chalk/source/index.js",
-      "#ansi-styles": "chalk/source/vendor/ansi-styles/index.js",
-      "#supports-color": "chalk/source/vendor/supports-color/index.js"
-    },
-    "coverageThreshold": {
-      "global": {
-        "branches": 80,
-        "functions": 80,
-        "lines": 80,
-        "statements": 80
-      }
-    }
-  },
   "prettier": {
     "singleQuote": true,
     "trailingComma": "all",
@@ -136,8 +135,7 @@
   "eslintConfig": {
     "env": {
       "es2021": true,
-      "node": true,
-      "jest": true
+      "node": true
     },
     "plugins": [
       "prettier"

package-lock.json

@@ -16,6 +16,7 @@ export class Debug {
   /**
    * Get the timestamp ms.
    *
+   * @private
    * @return {string}
    */
   static #getTimestamp() {

package.json

@@ -43,7 +43,12 @@ export class File {
    * @param {boolean?} isCopy
    * @return {File}
    */
-  constructor(filePath, content = null, mockedValues = false, isCopy = false) {
+  constructor(
+    filePath,
+    content = undefined,
+    mockedValues = false,
+    isCopy = false,
+  ) {
     const { ext, dir, name, base, mime, path } = File.#parsePath(filePath)
 
     /** @type {string} */
@@ -172,7 +177,9 @@ export class File {
   }
 
   /**
+   * Parse the file path.
    *
+   * @private
    * @param {string} filePath
    * @return {{
    *   ext: string,
@@ -281,7 +288,7 @@ export class File {
     this.fileSize = Parser.sizeToByte(fileStat.size)
 
     if (!options.withContent) {
-      this.content = null
+      this.content = undefined
 
       return this
     }
@@ -322,7 +329,7 @@ export class File {
         writable.write(this.content)
 
         writable.end(() => {
-          this.content = null
+          this.content = undefined
           this.fileExists = true
 
           resolve(this)
@@ -344,7 +351,7 @@ export class File {
     this.fileSize = Parser.sizeToByte(fileStat.size)
 
     if (!options.withContent) {
-      this.content = null
+      this.content = undefined
 
       return this
     }
@@ -382,11 +389,11 @@ export class File {
       throw new NotFoundFileException(this.path)
     }
 
-    this.content = null
-    this.createdAt = null
-    this.accessedAt = null
-    this.modifiedAt = null
-    this.fileSize = null
+    this.content = undefined
+    this.createdAt = undefined
+    this.accessedAt = undefined
+    this.modifiedAt = undefined
+    this.fileSize = undefined
     this.fileExists = false
     this.originalFileExists = false
 
@@ -403,11 +410,11 @@ export class File {
       throw new NotFoundFileException(this.path)
     }
 
-    this.content = null
-    this.createdAt = null
-    this.accessedAt = null
-    this.modifiedAt = null
-    this.fileSize = null
+    this.content = undefined
+    this.createdAt = undefined
+    this.accessedAt = undefined
+    this.modifiedAt = undefined
+    this.fileSize = undefined
     this.fileExists = false
     this.originalFileExists = false
 
@@ -662,6 +669,7 @@ export class File {
   /**
    * Create file values.
    *
+   * @private
    * @param {boolean?} mockedValues
    * @return {void}
    */

src/Helpers/Debug.js

@@ -226,6 +226,7 @@ export class Folder {
   /**
    * Parse the folder path.
    *
+   * @private
    * @param {string} folderPath
    * @return {{path: string, name: string, dir: string}}
    */
@@ -390,10 +391,10 @@ export class Folder {
       throw new NotFoundFolderException(this.name)
     }
 
-    this.createdAt = null
-    this.accessedAt = null
-    this.modifiedAt = null
-    this.folderSize = null
+    this.createdAt = undefined
+    this.accessedAt = undefined
+    this.modifiedAt = undefined
+    this.folderSize = undefined
     this.folderExists = false
     this.originalFolderExists = false
     this.files = []
@@ -412,10 +413,10 @@ export class Folder {
       throw new NotFoundFolderException(this.name)
     }
 
-    this.createdAt = null
-    this.accessedAt = null
-    this.modifiedAt = null
-    this.folderSize = null
+    this.createdAt = undefined
+    this.accessedAt = undefined
+    this.modifiedAt = undefined
+    this.folderSize = undefined
     this.folderExists = false
     this.originalFolderExists = false
     this.files = []

src/Helpers/File.js

@@ -17,6 +17,7 @@ export class Is {
   /**
    * Return the kindOf.
    *
+   * @private
    * @param {any} value
    * @return {any}
    */

src/Helpers/Folder.js

@@ -62,7 +62,8 @@ export class Number {
   }
 
   /**
-   * Extract the first number inside a string.
+   * Extract all numbers inside a string and
+   * return as a unique number.
    *
    * @param {string} string
    * @return {number}

src/Helpers/Is.js

@@ -302,6 +302,7 @@ export class Path {
     const stack = callSite()
     const requester = dirname(stack[stackIndex].getFileName()).replace(
       'file://',
+      '',
     )
 
     const execDir = normalize(requester.concat(sep, normalize(subPath)))

src/Helpers/Number.js

@@ -155,6 +155,34 @@ export declare class Exec {
 }
 
 export declare class File {
+  public originalDir: string
+
+  public originalName: string
+
+  public originalBase: string
+
+  public originalPath: string
+
+  public dir: string
+
+  public name: string
+
+  public base: string
+
+  public path: string
+
+  public isCopy: boolean
+
+  public originalFileExists: boolean
+
+  public fileExists: boolean
+
+  public content: Buffer
+
+  public mime: string
+
+  public extension: string
+
   constructor(
     filePath: string,
     content?: Buffer,
@@ -221,6 +249,24 @@ export declare class File {
 }
 
 export declare class Folder {
+  public originalDir: string
+
+  public originalName: string
+
+  public originalPath: string
+
+  public dir: string
+
+  public name: string
+
+  public path: string
+
+  public isCopy: boolean
+
+  public originalFolderExists: boolean
+
+  public folderExists: boolean
+
   constructor(folderPath: string, mockedValues?: boolean, isCopy?: boolean)
 
   static folderSizeSync(folderPath: string): number