Merge pull request #36 from Sv443-Network/version/1.15.0

.github/FUNDING.yml

@@ -2,7 +2,7 @@
 
 github: [Sv443]
 patreon: Sv443
-open_collective: sv443
+open_collective: #sv443
 ko_fi: Sv443_
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

.github/ISSUE_TEMPLATE/config.yml

@@ -3,7 +3,7 @@ blank_issues_enabled: true
 contact_links:
   -
     name: "Documentation"
-    about: "Please read the documentation before opening a new issue"
+    about: "Please refer to the documentation before opening a new issue"
     url: "https://github.com/Sv443-Network/SvCoreLib/blob/master/docs.md#readme"
   -
     name: "Discord"

.github/SECURITY.md

@@ -1,11 +1,11 @@
 # Security Policy
 
 ## Reporting a Vulnerability:
-To report a vulnerability or security issue, please directly contact me via [Email](mailto:[email protected]) or [a Discord private message](https://discordapp.com/users/415597358752071693)  
+To report a vulnerability or security issue, please directly contact us via [E-Mail](mailto:%63%6F%6E%74%61%63%74%40%73%76%34%34%33%2E%6E%65%74?subject=SvCoreLib%20security%20issue) or [Discord](https://dc.sv443.net/)  
 Please **do not** create a GitHub issue!
 
 ## Supported Versions:
 Only the latest minor version is supported and will be receiving security updates  
 For example, if the current version is v1.12.5, all versions from v1.12.0 up to v1.12.5 will receive security updates  
-In case a security vulnerability was found and is patched, a new patch will be released. In the above example that would be v1.12.6  
-NPM should update SvCoreLib once a new patch is released. If not, simply use the command `npm update`
+In case a security vulnerability was found and is patched, the affected versions will be marked as deprecated and a new patch will be released. In the above example that would be v1.12.6  
+When using the install or update command, NPM should automatically update SvCoreLib. If not, simply use the command `npm i svcorelib@latest` (or substitute `latest` with the desired version number)

.github/workflows/build.yml

@@ -24,9 +24,7 @@ jobs:
       env:
         CI: "true"
     - name: Install ESLint # installs ESLint - idk why it doesn't pull this out of the devDependencies but whatever
-      run: |
-        npm i -g eslint
-        npm i -D eslint
+      run: npm i -D eslint
       env:
         CI: "true"
     - name: Run ESLint # Runs ESLint on the project
@@ -41,16 +39,3 @@ jobs:
     #   env:
     #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     #   run: npx nyc --reporter=lcov npm run test && npx codecov -t $CODECOV_TOKEN
-    - name: Discord success notification # sends a Discord notification
-      env:
-        DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-      uses: Ilshidur/action-discord@master
-      with:
-        args: '✅ **SvCoreLib CI** (triggered by `{{GITHUB_ACTOR}}` on `{{GITHUB_REF}}`) was successful (see https://github.com/Sv443-Network/SvCoreLib/commit/{{GITHUB_SHA}}/checks)' 
-    - name: Discord failure notification # sends a Discord notification
-      env:
-        DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-      uses: Ilshidur/action-discord@master
-      with:
-        args: '🚫 **SvCoreLib CI** (triggered by `{{GITHUB_ACTOR}}` on `{{GITHUB_REF}}`) has failed (see https://github.com/Sv443-Network/SvCoreLib/commit/{{GITHUB_SHA}}/checks)'
-      if: failure()

.gitignore

@@ -36,3 +36,4 @@ typings/
 # dev test files
 test.js
 test.ts
+test.d.ts

.npmignore

@@ -9,4 +9,5 @@ package-npm.json
 .editorconfig
 test.js
 test.ts
-docs.md
+test.d.ts
+tsconfig.json

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Sv443 Network
+Copyright (c) 2020-2022 Sv443 Network
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,52 +1,65 @@
+<div align="center" style="text-align:center;">
+
 # SvCoreLib
 [![MIT License](https://img.shields.io/npm/l/svcorelib)](https://sv443.net/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/Sv443-Network/SvCoreLib)](https://github.com/Sv443-Network/SvCoreLib/issues) [![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/svcorelib)](https://snyk.io/)
 
 <br>
 
-### This is a core dependency of almost all projects of the Sv443 Network and a continuation of https://github.com/Sv443/JSLib-npm
-Although it is intended for the Sv443 Network's own projects, feel free to use this library (make sure to follow [the license terms](./LICENSE.txt) though)
+### Core Library used in the projects of Sv443 and the Sv443 Network,<br>containing tons of miscellaneous quality of life features
+Contains builtin TypeScript definitions
 
 <br>
 
-<div align="center" style="text-align:center;">
-
 ## >> [Documentation](./docs.md#readme) <<
-#### [Changelog](./changelog.md#readme) • [Discord](https://dc.sv443.net)
+#### [Discord](https://dc.sv443.net) • [Changelog](./changelog.md#readme)
 
 </div>
 
-<br><br>
+<br>
+
+## Most notable features:
+- Interactive CLI tools like a menu and a progress bar
+- Networking tools like downloading files and pinging URLs or efficiently serving data to a connecting client
+- File system tools like reading a directory recursively, downloading a file or supervising a directory for changes
+- Randomization tools like generating UUIDs or a seeded RNG
+- Misc tools involving array manipulation
+
+<br>
 
 ## Install:
 Use this command in a terminal window inside your Node.js project:
 ```
 npm i svcorelib
 ```
 
-<br><br>
+If you don't intend on using SQL functions, use `npm i svcorelib --no-optional`
 
-## Most notable features:
-- Interactive CLI tools like a menu and a progress bar
-- Networking tools like downloading files and pinging URLs or efficiently serving data to a connecting client
-- File system tools like reading a directory recursively, downloading a file or supervising a directory for changes
-- Randomization tools like generating UUIDs or a seeded RNG
-- Misc tools like relatively complex mathematics and array manipulation
-
-<br><br>
+<br>
 
 ## Contributors:
-Thank you very, very much to these contributors for improving SvCoreLib ❤️
-| Contributor | Their Contribution(s) |
+Thank you very much to these contributors for improving SvCoreLib ❤️
+| Name | Contributions |
 | --- | --- |
-| [canarado](https://github.com/canarado) | TypeScript type declarations, fixed grammar |
+| [canarado](https://github.com/canarado) | Added TypeScript declarations, fixed grammar |
 | [ThatCopy](https://github.com/ThatCopy) | Fixed documentation, tested the code |
 
-<br><br>
+<br>
 
 ## Dependencies:
 I made SvCoreLib so it needs as few dependencies as possible, but in order to ensure quality and stability, these dependencies are needed:
 - [deep-diff](https://npmjs.com/package/deep-diff)
 - [fs-extra](https://npmjs.com/package/fs-extra)
 - [keypress](https://npmjs.com/package/keypress)
 - [minimatch](https://npmjs.com/package/minimatch)
-- [mysql](https://npmjs.com/package/mysql)
+- [mysql](https://npmjs.com/package/mysql) *
+
+\*<sup> = optional, see [installation](#install)</sup>
+
+<br><br><br>
+
+<div align="center" style="text-align:center">
+
+Made with ❤️ by [Sv443](https://github.com/Sv443) and [others](https://github.com/Sv443-Network/SvCoreLib/graphs/contributors)  
+Like SvCoreLib? Please consider [supporting our development](https://github.com/sponsors/Sv443)
+
+</div>