Prettifying and adding Codacy

Also, badges.

Author: GwynethLlewelyn

.editorconfig

@@ -22,6 +22,10 @@ trim_trailing_whitespace = false
 indent_style = space
 indent_size = 2
 
+[*.yml]
+indent_style = space
+indent_size = 2
+
 # Linden Scripting Language abhors tabs
 [*.lsl]
 max_line_length = 108

.github/workflows/codacy.yml

@@ -1 +1,61 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
 
+# This workflow checks out code, performs a Codacy security scan
+# and integrates the results with the
+# GitHub Advanced Security code scanning feature.  For more information on
+# the Codacy security scan action usage and parameters, see
+# https://github.com/codacy/codacy-analysis-cli-action.
+# For more information on Codacy Analysis CLI in general, see
+# https://github.com/codacy/codacy-analysis-cli.
+
+name: Codacy Security Scan
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '31 3 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  codacy-security-scan:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: Codacy Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
+      - name: Run Codacy Analysis CLI
+        uses: codacy/codacy-analysis-cli-action@d840f886c4bd4edc059706d09c6a1586111c540b
+        with:
+          # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
+          # You can also omit the token and run the tools that support default configurations
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          verbose: true
+          output: results.sarif
+          format: sarif
+          # Adjust severity of non-security issues
+          gh-code-scanning-compat: true
+          # Force 0 exit code to allow SARIF file generation
+          # This will handover control about PR rejection to the GitHub side
+          max-allowed-issues: 2147483647
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif

README.md

@@ -3,5 +3,6 @@
 
 A very simple phpBB3 extension to locally store the content of a post being written, to avoid losing everything after a crash or session expiration.
 
-Logo designed by DALL·E 2.
+Logo designed by [DALL·E 2](https://openai.com/product/dall-e-2).
 
+![phpBB3 Logo](https://img.shields.io/badge/phpBB-3.3-blue) [![CodeQL](https://github.com/GwynethLlewelyn/post-local-storage/actions/workflows/codeql.yml/badge.svg)](https://github.com/GwynethLlewelyn/post-local-storage/actions/workflows/codeql.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/83a20d04433341baa65c78d29fc3410a)](https://www.codacy.com/gh/GwynethLlewelyn/post-local-storage/dashboard?utm_source=github.com&utm_medium=referral&utm_content=GwynethLlewelyn/post-local-storage&utm_campaign=Badge_Grade)

gwynethllewelyn/postlocalstorage/styles/prosilver/template/custom_functions.js

@@ -2,16 +2,16 @@
 	// Cut the mustard.
 	if (!message.localStorage) return;
 	// You should probably use a more specific selector than this.
-	var textarea = doc.querySelector('textarea');
+	var textarea = doc.querySelector("textarea");
 	// The key for the key/value pair in localStorage is the current URL.
 	var key = message.location.href;
 	var item = null;
 	// Use the 'pagehide' event in modern browsers or 'beforeunload' in older browsers.
 	var unloadEvent;
-	if ('onpagehide' in message) {
-		unloadEvent = 'pagehide';
+	if ("onpagehide" in message) {
+		unloadEvent = "pagehide";
 	} else {
-		unloadEvent = 'beforeunload';
+		unloadEvent = "beforeunload";
 	}
 	// If there's a localStorage entry for the current URL, update the textarea with the saved value.
 	item = message.localStorage.getItem(key);
@@ -22,7 +22,7 @@
 	// This function will store the current value of the textarea in localStorage (or delete it if the textarea is blank).
 	function updateStorage() {
 		if (textarea.value) {
-			item = JSON.stringify({'content': textarea.value});
+			item = JSON.stringify({ content: textarea.value });
 			message.localStorage.setItem(key, item);
 		} else {
 			message.localStorage.removeItem(key);
@@ -31,13 +31,17 @@
 		message.removeEventListener(unloadEvent, updateStorage);
 	}
 	// When the user presses a key just *once* inside the textarea, run the storage function when the page is unloaded.
-	textarea.addEventListener('keyup', function() {
-		message.addEventListener(unloadEvent, updateStorage);
-		message.setInterval(updateStorage, 10000);
-	}, {'once': true});
+	textarea.addEventListener(
+		"keyup",
+		function () {
+			message.addEventListener(unloadEvent, updateStorage);
+			message.setInterval(updateStorage, 10000);
+		},
+		{ once: true }
+	);
 	// When the form is submitted, delete the localStorage key/value pair.
-	textarea.form.addEventListener('submit', function() {
+	textarea.form.addEventListener("submit", function () {
 		message.localStorage.removeItem(key);
 		message.removeEventListener(unloadEvent, updateStorage);
 	});
-}(this, this.document));
+})(this, this.document);