Merge pull request #26 from Sv443-Network/version/1.14.1

Hotfix for `filesystem.exists()`

Author: Sven Fehler

README.md

@@ -8,7 +8,12 @@ Although it is intended for the Sv443 Network's own projects, feel free to use t
 
 <br>
 
-## [Click here to go to the documentation](./docs.md#readme)
+<div align="center" style="text-align:center;">
+
+## >> [Documentation](./docs.md#readme) <<
+#### [Changelog](./changelog.md#readme) • [Discord](https://dc.sv443.net)
+
+</div>
 
 <br><br>
 

SvCoreLib.d.ts

@@ -4,10 +4,10 @@
 
 
     >> If you came here looking for the source code, you're in the wrong file!
-    >> See the file `SvCoreLib.js` instead, it acts as a relay to all of SCLs features.
+    >> See the file `SvCoreLib.js` instead, it acts as a proxy to all of SCLs features.
     >> From there, you can follow the require()'s.
 
-    >> This file is responsible for the In-IDE documentation (usually seen by pressing CTRL+Space or hovering over stuff)
+    >> This file is responsible for the In-IDE documentation and explicit types (usually seen by pressing CTRL+Space or hovering over stuff)
 */
 
 
@@ -47,7 +47,9 @@ declare type PromiseState = "initialized" | "pending" | "fulfilled" | "rejected"
  *   
  * ---
  *   
- * **[Documentation](https://github.com/Sv443/SvCoreLib/blob/master/docs.md#readme) • [GitHub Repo](https://github.com/Sv443-Network/SvCoreLib) • [Discord](https://dc.sv443.net)**
+ * **[Documentation](https://github.com/Sv443-Network/SvCoreLib/blob/master/docs.md#readme) • [GitHub Repo](https://github.com/Sv443-Network/SvCoreLib) • [Discord](https://dc.sv443.net)**
+ *   
+ * [Changelog](https://github.com/Sv443-Network/SvCoreLib/blob/master/changelog.md#readme)
  *   
  * ---
  *   
@@ -537,7 +539,7 @@ declare module "svcorelib" {
 
         /**
          * 🔹 This function checks if a file exists at the given path.  
-         * (Reimplementation of [`fs.exists()`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback) based on `fs.access()`) 🔹
+         * (Reimplementation of the deprecated [`fs.exists()`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback) based on `fs.access()`) 🔹
          * @param path The path to the file - Gets passed through [`path.resolve()`](https://nodejs.org/api/path.html#path_path_resolve_paths)
          * @returns Returned Promise always resolves to a boolean (and never rejects) - true, if the file exists, false if not
          * @throws Throws a TypeError if the `path` argument is not a string or couldn't be resolved to a valid path

SvCoreLib.js

@@ -45,6 +45,7 @@ module.exports = Object.freeze({
         downloadFile:          require("./src/functions/filesystem/downloadFile"),
         ensureDirs:            require("./src/functions/filesystem/ensureDirs"),
         ensureDirsSync:        require("./src/functions/filesystem/ensureDirsSync"),
+        exists:                require("./src/functions/filesystem/exists"),
     },
     sql: {
         sendQuery:  require("./src/functions/sql/sendQuery"),

changelog.md

@@ -1,5 +1,5 @@
 ## SvCoreLib - Changelog
-### Latest version: [1.14.0](#1140)
+### Latest version: [1.14.1](#1141)
 
 <br><br>
 
@@ -33,6 +33,7 @@
 - [1.13.0](#1130)
     - [1.13.1](#1131)
 - [1.14.0](#1140)
+    - [1.14.1](#1141)
 
 </details>
 
@@ -42,6 +43,13 @@
 
 <br><br>
 
+## 1.14.1
+
+- Fixes
+    - `filesystem.exists()` can now actually be used 🤦 ([issue #25](https://github.com/Sv443-Network/SvCoreLib/issues/25))
+
+<br><br>
+
 ## 1.14.0
 
 - Additions

docs.md

@@ -2379,24 +2379,24 @@ Also, all of these classes inherit from [JavaScript's `Error` class.](https://de
 > > **<details><summary>Example Code - Click to view</summary>**
 > > 
 > > ```js
-> > const scl = require("svcorelib");
+> > const { filesystem, Errors } = require("svcorelib");
 > > const fs = require("fs");
 > > const { resolve } = require("path");
 > > 
 > > 
 > > /** @throws InvalidPathError if the provided path doesn't exist */
-> > function pathExists(path)
+> > async function throwIfNotExists(path)
 > > {
 > >     path = resolve(path);
 > > 
-> >     if(!fs.existsSync(path))
-> >         throw new scl.Errors.InvalidPathError(`Path "${path}" doesn't exist.`);
+> >     if(!(await filesystem.exists(path)))
+> >         throw new Errors.InvalidPathError(`Path "${path}" doesn't exist.`);
 > > 
 > >     return;
 > > }
 > > 
-> > pathExists("./src/");                   // no error is thrown
-> > pathExists("./path/that/doesnt/exist"); // error is thrown here
+> > throwIfNotExists("./src/");                   // no error is thrown
+> > throwIfNotExists("./path/that/doesnt/exist"); // error is thrown here
 > > ```
 > > 
 > > </details>

package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "@sv443-network/svcorelib",
-  "version": "1.14.0",
+  "name": "svcorelib",
+  "version": "1.14.1",
   "description": "Core Library used in almost all of my (Sv443's) projects. Feel free to use it if you want to, it contains some very nice features.",
   "main": "SvCoreLib.js",
   "scripts": {
@@ -60,9 +60,5 @@
     "@types/node": "^14.6.0",
     "eslint": "^7.22.0",
     "snyk": "^1.592.0"
-  },
-  "publishConfig": {
-    "cache": "~/.npm",
-    "registry": "https://registry.npmjs.com"
   }
 }