Merge pull request #243 from plexidev/dev

[Version update] 9.1.0

Author: Zelak312

.eslintrc.js

@@ -12,6 +12,7 @@ module.exports = {
     ],
     rules: {
         "@typescript-eslint/no-explicit-any": 0,
+        "@typescript-eslint/explicit-function-return-type": 1,
         "@typescript-eslint/no-non-null-assertion": 0,
         "no-console": 2,
     },

.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "dev" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "dev" ]
+  schedule:
+    - cron: '15 9 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/docgen-static.yml

@@ -0,0 +1,52 @@
+# Simple workflow for deploying static content to GitHub Pages
+# Modified to build with node
+name: Deploy built static content to Pages
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["dev"]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run docgen
+      
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./docs
+      
+  # Single deploy job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+    push:
+        branches: ["dev"]
+    pull_request:
+        branches: ["dev"]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [18.x]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: "npm"
+            - run: npm ci
+            - run: npm run build --if-present
+            - run: npm test
+            - run: npm run lint

.gitignore

@@ -45,6 +45,7 @@ build/Release
 
 # Dependency directories
 node_modules/
+package-lock.json
 jspm_packages/
 pnpm-lock.yaml
 
@@ -133,4 +134,6 @@ dist
 .svelte-kit
 
 # End of https://www.toptal.com/developers/gitignore/api/node
-out
+out
+
+.tool-versions

.husky/pre-commit

@@ -1,3 +1,7 @@
 {
-    "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+    "recommendations": [
+        "esbenp.prettier-vscode",
+        "dbaeumer.vscode-eslint",
+        "Gruntfuggly.todo-tree"
+    ]
 }

.vscode/extensions.json

@@ -1,4 +1,7 @@
 {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.tabSize": 4
+    "editor.tabSize": 4,
+    "[typescript]": {
+        "editor.defaultFormatter": "vscode.typescript-language-features"
+    }
 }

.vscode/settings.json

@@ -1,16 +1,15 @@
-> Need a powerful, low-cost VPS for hosting your applications & bots 24/7? Check out our partner, [Contabo](https://www.tkqlhce.com/click-8950879-15301134)! 🎉
-
-## Quick.db
+## ![Quick.db Logo](https://www.plexidev.org/quickdb.png)
 
+> Need a powerful, low-cost VPS for hosting your applications & bots 24/7? Check out our partner, [Contabo](https://www.tkqlhce.com/click-8950879-15301134)! 🎉
 
 **Documentation:** [quickdb.js.org](https://quickdb.js.org) [[Migration Guide](https://quickdb.js.org/overview/migration-guide)] <br>
 **Support:** [discord.gg/plexidev](https://discord.gg/plexidev) <br>
 **NPM:** [npmjs.com/quick.db](https://www.npmjs.com/package/quick.db)
 
-Quick.db is an open-source package meant to provide an easy way for beginners and people of all levels to access & store data in a low to medium volume environment. All data is stored persistently via either [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) or [promise-mysql](https://www.npmjs.com/package/promise-mysql) and comes way various other quality-of-life features.
+Quick.db is an open-source package meant to provide an easy way for beginners and people of all levels to access & store data in a low to medium volume environment. All data is stored persistently via either [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) or [mysql2](https://www.npmjs.com/package/mysql2) and comes way various other quality-of-life features.
 
 -   **Persistent Storage** - Data doesn't disappear through restarts
--   **Multiple Drivers** - You can use either better-sqlite3 or promise-mysql
+-   **Multiple Drivers** - You can use either better-sqlite3 or mysql2
 -   **Works out of the box** - No need to set up a database server, all the data is stored locally in the same project
 -   **Beginner Friendly** - Originally created for use in tutorials, the documentation is straightforward and jargon-free
 -   & more...
@@ -31,7 +30,7 @@ Quick.db is an open-source package meant to provide an easy way for beginners an
 
 ```python
 npm i quick.db better-sqlite3   # (Default) Local SQLite3 File
-npm i quick.db promise-mysql    # (Alternative) MySQL Server Connection
+npm i quick.db mysql2    # (Alternative) MySQL Server Connection
 ```
 
 > If you're having troubles installing, please follow [this troubleshooting guide](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/troubleshooting.md).
@@ -56,7 +55,7 @@ const db = new QuickDB(); // will make a json.sqlite in the root folder
     // -> { difficulty: 'Easy' }
 
     // Getting an object property from the database:
-    await db.set("userInfo.difficulty");
+    await db.get("userInfo.difficulty");
     // -> 'Easy'
 
     // Setting an object in the database:
@@ -85,7 +84,7 @@ const db = new QuickDB(); // will make a json.sqlite in the root folder
 
 ## Example With MySQLDriver
 
-> **NOTE:** In order to use this driver, install `npm i promise-mysql` separately.
+> **NOTE:** In order to use this driver, install `npm i mysql2` separately.
 
 ```js
 const { QuickDB, MySQLDriver } = require("quick.db");
@@ -107,6 +106,52 @@ const { QuickDB, MySQLDriver } = require("quick.db");
 })();
 ```
 
+## Example With MongoDriver
+
+> **NOTE:** In order to use this driver, install `npm i mongoose` separately.
+
+```js
+const { QuickDB, MongoDriver } = require("quick.db");
+(async () => {
+    const mongoDriver = new MongoDriver("mongodb://localhost/quickdb");
+
+    await mongoDriver.connect();
+
+    const db = new QuickDB({ driver: mongoDriver });
+    // Now you can use quick.db as normal
+
+    await db.set("userInfo", { difficulty: "Easy" });
+    // -> { difficulty: 'Easy' }
+
+    await driver.close();
+    // disconnect from the database
+})();
+```
+
+## Example With JSONDriver
+
+> **NOTE:** In order to use this driver, install `npm i write-file-atomic` separately.
+
+```js
+const { QuickDB, JSONDriver } = require("quick.db");
+const jsonDriver = new JSONDriver();
+const db = new QuickDB({ driver: jsonDriver });
+
+await db.set("userInfo", { difficulty: "Easy" });
+```
+
+## Example With MemoryDriver
+
+> **Note:** In-memory database is not persistent and is suitable for temporary caching.
+
+```js
+const { QuickDB, MemoryDriver } = require("quick.db");
+const memoryDriver = new MemoryDriver();
+const db = new QuickDB({ driver: memoryDriver });
+
+await db.set("userInfo", { difficulty: "Easy" });
+```
+
 ## Changes in 9.0.x
 
 -   Added two new database options: **driver** and **filePath**