Merge pull request #194 from Sv443/wip/2.3.0

Author: Sven Fehler

.github/Contributing.md

@@ -12,8 +12,8 @@ So please read this guide before contributing. Thanks :)
 <br><br><br><br>
 
 ## Submitting or editing jokes:
-To submit a joke manually, you can use the form on [this page.](https://sv443.net/jokeapi/v2/#submit)  
-To submit it through code, you can make use of the ["submit" endpoint.](https://sv443.net/jokeapi/v2/#submit-endpoint)  
+To submit a joke manually, you can use the form on [this page.](https://v2.jokeapi.dev/#submit)  
+To submit it through code, you can make use of the ["submit" endpoint.](https://v2.jokeapi.dev/#submit-endpoint)  
 
 If you instead want to *edit* a joke, you can find them in the `jokes-xy.json` files in [`data/jokes/`](../data/jokes/)  
 Please then follow the [code contribution section](#submitting-code) as well.  
@@ -27,10 +27,13 @@ Keep in mind, though, that I will not remove jokes based on opinions as that wou
 1. [Read the Code_of_Conduct.md file](./Code_of_Conduct.md) (TLDR: just behave in a friendly manner).
 2. [Click here](https://github.com/Sv443/JokeAPI/fork) to fork the repository. Afterwards, clone or download it and locate the folder where it is contained.
 3. Make the changes you want to make to the code.
-4. Run the script `npm run all` which will run these three commands:
+4. Run the script `npm run all` which will run these four commands:
     - `npm run validate-jokes` to make sure all jokes are formatted correctly.
     - `npm run validate-ids` to verify that all jokes have the correct ID.
     - `npm run lint` to check the code for any warnings or errors.
+    - `npm run dep-graph` to generate a new dependency graph.
+    - `npm run generate-changelog` to generate a Markdown changelog out of the plaintext one.
+    - `npm run test`, which runs the unit tests for JokeAPI. If you are colorblind, you can run the command `npm run test-colorblind` (will turn green into cyan and red into magenta).
 5. Run JokeAPI locally by running the command `node JokeAPI`, request some jokes and test the areas you modified / added to make sure everything still works.
 6. Add yourself to the `contributors` object in the [`package.json`](../package.json) file :)
     <!-- - **If it doesn't exist or is empty** please add it using the second format on [this website](https://flaviocopes.com/package-json/#contributors) -->
@@ -56,7 +59,7 @@ If you want to submit a translation, please follow these steps:
 ## Other nice-to-know stuff:
 - I really recommend using [Visual Studio Code](https://code.visualstudio.com/) with the extension [`fabiospampinato.vscode-highlight`](https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-highlight) - it will add custom styling to the syntax highlighting in the editor and make the code easier to read and work with.  
 - If you want to generate a dependency graph, you need to install [Graphviz](https://graphviz.gitlab.io/download/) and add the path to the `bin` folder to your `%PATH%` / `$PATH` environment vaiable. Then, run the command `npm run dependency-graph` and open the file [`dev/dependency-graph.html`](../dev/dependency-graph.html) in a browser.  
-- If you need to add an authorization token, you can generate one or multiple tokens with the command `npm run add-token [amount]`. If you omit the "amount" parameter, the script will generate a single token. After you run the command, the tokens will be listed in the console and you can now (after restarting JokeAPI) use it in the `Authorization` header to gain unlimited access to JokeAPI.  
+- If you need to add an authorization token, you can generate one or multiple tokens with the command `npm run add-token [amount]`. If you omit the "amount" parameter, the script will generate a single token. After you run the command, the tokens will be listed in the console and you can now (after restarting JokeAPI) use it in the `Authorization` header to gain unlimited access to JokeAPI [(better explanation here).](https://jokeapi.dev/#api-tokens)  
 
 <br><br>
 

.github/ISSUE_TEMPLATE/add_dependent.md

@@ -0,0 +1,52 @@
+---
+name: Dependent
+about: Request your project to be added to the dependent lists in the readme and documentation or suggest an edit to a dependent
+title: 'New dependent: '
+labels: ⚙️ dependent
+assignees: Sv443
+
+---
+
+<!--
+    If this issue is approved, your project will be added to these dependent lists:
+    - https://jokeapi.dev/#dependents
+    - https://github.com/Sv443/JokeAPI#readme    (scroll down all the way)
+-->
+
+## Link to the project:
+<!-- Add a single URL to the dependent project here -->
+```
+https://github.com/example/My_Project
+```
+
+
+<br><br>
+
+## Link to my personal website / GitHub page (optional):
+<!-- Add a single URL to your website or GitHub page (or something similar) here -->
+```
+https://github.com/example
+```
+
+
+<br><br>
+
+## Is your project explicit or unsafe for minors to view?
+<!-- Please check the option that fits your project (add an x between the square brackets or submit the issue, then click the checkbox) -->
+- [ ] **Yes**, it contains explicit material
+- [ ] **No**, it doesn't contain explicit material
+
+
+<br><br>
+
+## Notes:
+<!-- If you only want your project to show up on one of the dependent lists or you have some other thing you need the developer(s) to know, put it in this section -->
+
+
+
+<br><br>
+
+## Checklist:
+- [ ] I have added my project's name to the title of this issue
+- [ ] I have filled out at least the first URL (second one is optional)
+- [ ] I have specified whether or not my project is explicit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a bug report to help improve JokeAPI
 title: ''
-labels: 🕷 bug
+labels: bug
 assignees: Sv443
 
 ---

.github/ISSUE_TEMPLATE/config.yml

@@ -4,7 +4,7 @@ contact_links:
   -
     name: "Documentation"
     about: "Please read the documentation before opening a new issue"
-    url: "https://sv443.net/jokeapi/v2"
+    url: "https://jokeapi.dev/"
   -
     name: "Chat"
     about: "If you have any non-issue-worthy questions, join my Discord server and I'll try to help you"

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,10 +18,12 @@
 <!-- Add some screenshots here, if applicable -->
 
 ## Checklist
-- [ ] I have read the [Contributing Guide](https://github.com/Sv443/JokeAPI/blob/master/.github/Contributing.md)
-- [ ] I read and accept the [Code of Conduct](https://github.com/Sv443/JokeAPI/blob/master/.github/Code_of_Conduct.md) (TLDR: just behave in a friendly manner)
+- [ ] I have read and followed the [Contributing Guide](https://github.com/Sv443/JokeAPI/blob/master/.github/Contributing.md)
+- [ ] I have read and accept the [Code of Conduct](https://github.com/Sv443/JokeAPI/blob/master/.github/Code_of_Conduct.md) (TLDR: just behave in a friendly manner)
 - [ ] My code follows the general style of this project
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation (if applicable)
 - [ ] I ensured that the automated checks that ran on this PR have completed successfully
-- [ ] I added myself to the `package.json` file (optional)
+- [ ] I added myself to the `package.json` file (optional but highly encouraged :)
+
+**^ Not completing the checklist or ignoring what it says will invalidate your contribution and may even ban you from contributing altogether ^**

.github/SECURITY.md

@@ -1,15 +1,17 @@
 # Security Policy
 
 ## Reporting a Vulnerability
-To report a vulnerability or security issue, please directly contact me via [Email](mailto:sven.fehler@web.de) or [Discord](https://sv443.net/discord).  
+To report a vulnerability or security issue, please directly contact me via [Email](mailto:contact@sv443.net) or [Discord](https://sv443.net/discord).  
 Please **do not** create a GitHub issue!
 
 ## Supported Versions
 These versions are still supported and will be receiving security updates:
-| Version | Supported | Status |
-| --- | --- | --- |
-| [v1.0](https://github.com/Sv443/JokeAPI/releases/tag/v1.0.0) | ❌ | deprecated |
-| [v1.1](https://github.com/Sv443/JokeAPI/releases/tag/v1.1.3) | ❌ | deprecated |
-| [v2.0](https://github.com/Sv443/JokeAPI/releases/tag/v2.0.1) | ❌ | outdated |
-| [v2.1](https://github.com/Sv443/JokeAPI/releases/tag/v2.1.5) | ❌ | outdated |
-| [v2.2](https://github.com/Sv443/JokeAPI/releases/tag/v2.2.0) | ✅ | active |
+| Version | Supported | Location | Status |
+| --- | --- | --- | --- |
+| [v1.0](https://github.com/Sv443/JokeAPI/releases/tag/v1.0.0) | ❌ | `/` | deprecated |
+| [v1.1](https://github.com/Sv443/JokeAPI/releases/tag/v1.1.3) | ❌ | `/` | deprecated |
+| [v2.0](https://github.com/Sv443/JokeAPI/releases/tag/v2.0.1) | ❌ | `v2` | outdated |
+| [v2.1](https://github.com/Sv443/JokeAPI/releases/tag/v2.1.5) | ❌ | `v2` | outdated |
+| [v2.2](https://github.com/Sv443/JokeAPI/releases/tag/v2.2.1) | ✅ | `v2` | active |
+
+Location = subdomain or part of the URL path (eg. `/jokeapi/v2/` or `v2.jokeapi.dev`)

.gitignore

@@ -23,6 +23,9 @@ docs/documentation.html
 docs/compiled
 
 # Joke submissions:
+data/submissions
+data/submissions/**
+data/submissions/*/**
 data/submissions/*/*.json
 
 # Auth Tokens:

.vscode/launch.json

@@ -5,8 +5,20 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "program": "${workspaceFolder}/tools/add-joke.js",
-            "name": "Tools/xy",
+            "type": "node",
+            "request": "launch",
+            "name": "Debug JokeAPI",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/JokeAPI.js",
+            "args": [
+                "--trace-deprecation"
+            ]
+        },
+        {
+            "program": "${workspaceFolder}/tools/test.js",
+            "name": "Unit Tests",
             "request": "launch",
             "type": "node",
             "skipFiles": [
@@ -18,16 +30,17 @@
             "console": "integratedTerminal"
         },
         {
-            "type": "node",
+            "program": "${workspaceFolder}/tools/submissions.js",
+            "name": "Tools/xy",
             "request": "launch",
-            "name": "Debug JokeAPI",
+            "type": "node",
             "skipFiles": [
                 "<node_internals>/**"
             ],
-            "program": "${workspaceFolder}/JokeAPI.js",
             "args": [
                 "--trace-deprecation"
-            ]
+            ],
+            "console": "externalTerminal"
         }
     ],
     "debug.javascript.usePreview": true

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "highlight.regexes": { // REQUIRES EXTENSION: fabiospampinato.vscode-highlight
-        "(jsl\\.unused\\([a-zA-Z_,\\[\\]\\s]+\\);*)": [ // jsl.unused([some_var, some_other_var]);
+        "(((jsl|scl)\\.)?unused\\([a-zA-Z_,\\[\\]\\s\\-\":.]+\\);*)": [ // jsl.unused([some_var, some_other_var]); or scl.unused(xy);
             {
                 "backgroundColor": "rgba(0, 0, 0, 0.2)",
                 "color": "#f88"
@@ -14,7 +14,7 @@
                 "overviewRulerColor": "#f41"
             }
         ],
-        "(#SECTION ([^\\S\\r\\n]*\\w+)*[:]*)": [ // #SECTION test
+        "(#SECTION ([^\\S\\r\\n]*[\\w,.\\-_]+)*[:]*)": [ // #SECTION test, 123
             {
                 "backgroundColor": "#44f",
                 "color": "white",
@@ -27,52 +27,21 @@
                 "color": "blue",
                 "overviewRulerColor": "#ff0"
             }
-        ]
+        ],
+        "(<!--%#INSERT:[a-zA-Z0-9\\-]+#%-->|<!--%#INJECT:[a-zA-Z0-9\\-]+#%-->)": [ // <!--%#INSERT:TEST#%--> / <!--%#INJECT:TEST#%-->
+            {
+                "color": "orange",
+                "fontStyle": "italic",
+                "outline": "1px solid orange"
+            }
+        ],
     },
-    // "highlight.regexes": { // REQUIRES EXTENSION: fabiospampinato.vscode-highlight
-    //     "(<!--%#INSERT:[a-zA-Z0-9\\-]+#%-->|<!--%#INJECT:[a-zA-Z0-9\\-]+#%-->)": [ // <!--%#INSERT:TEST#%--> / <!--%#INJECT:TEST#%-->
-    //         {
-    //             "color": "orange",
-    //             "fontStyle": "italic",
-    //             "outline": "1px solid orange"
-    //         }
-    //     ],
-    //     "(jsl\\.unused\\([a-zA-Z_\\\",\\[\\]\\s]+\\);*)": [ // jsl.unused([some_var, some_other_var]);
-    //         {
-    //             "backgroundColor": "rgba(0, 0, 0, 0.2)",
-    //             "color": "#f88"
-    //         }
-    //     ],
-    //     "(#MARKER)": [ //#MARKER test
-    //         {
-    //             "backgroundColor": "#f41",
-    //             "color": "#fff",
-    //             "isWholeLine": true,
-    //             "overviewRulerColor": "#f41"
-    //         }
-    //     ],
-    //     "(#SECTION [a-zA-Z0-9_-,]+)": [ //#SECTION test, foo bar
-    //         {
-    //             "backgroundColor": "#44f",
-    //             "color": "white",
-    //             "overviewRulerColor": "#44f"
-    //         }
-    //     ],
-    //     "(#DEBUG)": [ //#DEBUG
-    //         {
-    //             "backgroundColor": "#ff0",
-    //             "color": "blue",
-    //             "overviewRulerColor": "#ff0"
-    //         }
-    //     ],
-    //     "(?<!\\w)(#[a-f0-9]{3,4}|#[a-f0-9]{6}|#[a-f0-9]{8}|rgba?\\s*\\([^)]*?\\)|hsla?\\s*\\([^)]*?\\)|aliceblue|antiquewhite|aqua|aquamarine|azure|beige|bisque|black|blanchedalmond|blue|blueviolet|brown|burlywood|cadetblue|chartreuse|chocolate|coral|cornflowerblue|cornsilk|crimson|cyanaqua|darkblue|darkcyan|darkgoldenrod|darkgray|darkgreen|darkgrey|darkkhaki|darkmagenta|darkolivegreen|darkorange|darkorchid|darkred|darksalmon|darkseagreen|darkslateblue|darkslategray|darkslategrey|darkturquoise|darkviolet|deeppink|deepskyblue|dimgray|dimgrey|dodgerblue|firebrick|floralwhite|forestgreen|fuchsia|gainsboro|ghostwhite|gold|goldenrod|gray|green|greenyellow|grey|honeydew|hotpink|indianred|indigo|ivory|khaki|lavender|lavenderblush|lawngreen|lemonchiffon|lightblue|lightcoral|lightcyan|lightgoldenrodyellow|lightgray|lightgreen|lightgrey|lightpink|lightsalmon|lightseagreen|lightskyblue|lightslategray|lightslategrey|lightsteelblue|lightyellow|lime|limegreen|linen|magenta|maroon|mediumaquamarine|mediumblue|mediumorchid|mediumpurple|mediumseagreen|mediumslateblue|mediumspringgreen|mediumturquoise|mediumvioletred|midnightblue|mintcream|mistyrose|moccasin|navajowhite|navy|oldlace|olive|olivedrab|orange|orangered|orchid|palegoldenrod|palegreen|paleturquoise|palevioletred|papayawhip|peachpuff|peru|pink|plum|powderblue|purple|rebeccapurple|red|rosybrown|royalblue|saddlebrown|salmon|sandybrown|seagreen|seashell|sienna|silver|skyblue|slateblue|slategray|slategrey|snow|springgreen|tan|teal|thistle|turquoise|violet|wheat|white|whitesmoke|yellow|yellowgreen)(?!\\w)": [
-    //         {
-    //           "rangeBehavior": 1,
-    //           "borderWidth": "1px",
-    //           "borderColor": "$1",
-    //           "borderStyle": "solid"
-    //         }
-    //     ]
-    // },
-    "npm-scripts.showStartNotification": false
+    "npm-scripts.showStartNotification": false,
+
+    // JokeAPI-specific:
+
+    "files.exclude": {         // hide files so they can't be opened in the IDE
+        "docs/compiled": true, // to prevent accidentally changing the compiled documentation to only have it be overridden after the next compile
+        "dev/madge": true,     // the files don't need to be modified, they only serve as a distraction
+    }
 }

JokeAPI.js

@@ -1,7 +1,7 @@
 // 🔹 JokeAPI by Sv443 🔹
 //
 // GitHub:    https://github.com/Sv443/JokeAPI
-// API Docs:  https://sv443.net/jokeapi/v2
+// API Docs:  https://jokeapi.dev/
 // ️
 // ⚠️ Please read the LICENSE.txt file before modifying, redistributing or even selling JokeAPI.
 // ⚠️ Thanks :)
@@ -17,7 +17,7 @@ function initJokeAPI()
 {
     if(settings.debug.verboseLogging)
         console.log("\n\n");
-    debug("PreInit", "Called InitJokeAPI");
+    debug("PreInit", `Initializing ${settings.info.name}`);
     // the debugger and child processes don't get along together so only wrap JokeAPI if the debugger is not active:
     if(!jsl.inDebugger() && !settings.wrapper.skipWrapping)
         return wrap(settings.wrapper.mainFilePath, settings.wrapper.wrapperSettings);