Skip to content

Commit

Permalink
Updating readme for release, housekeeping
Browse files Browse the repository at this point in the history
* Updated Readme, and other docs
* Linting
* Formatting
* Complexity Reports
* Doc Coverage Reports
* Doc Generation
* Small fixes
  • Loading branch information
confused-Techie committed Mar 12, 2022
1 parent ba8695e commit f1a6efd
Show file tree
Hide file tree
Showing 19 changed files with 68,866 additions and 70,752 deletions.
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"i18n_generatedUploadSuccessSnackbar": "readonly",
"i18n_generatedRemoveImageSuccess": "readonly",
"i18n_returnValueLogging": "readonly",
"i18n_returnValueRobots": "readonly"
"i18n_returnValueRobots": "readonly",
"i18n_validatePlugiinLocation": "readonly"
}
}
24 changes: 9 additions & 15 deletions assets/js/home.js
Original file line number Diff line number Diff line change
Expand Up @@ -293,15 +293,11 @@ class LinkItemDOM {

emptyPlugins() {
while (document.getElementsByClassName("add-plugin-link").length > 1) {
try {
document
.getElementsByClassName("add-plugin-link")
[
document.getElementsByClassName("add-plugin-link").length - 1
].parentNode.remove();
} catch (err) {
throw err;
}
document
.getElementsByClassName("add-plugin-link")
[
document.getElementsByClassName("add-plugin-link").length - 1
].parentNode.remove();
}
// ^^ The above while loop, will run until only 1 elemenet remains for the add-plugin-link dom element
// each loop gets the HTMLCollection of the element, grabbing only the last one, then selects its parentNode (form-text)
Expand Down Expand Up @@ -437,6 +433,7 @@ function disablePluginLocation(element) {
.setAttribute("disabled", "");
}

/*eslint-disable-next-line no-unused-vars*/
function addPluginOptions(element) {
var pluginContainerParent = element.parentElement.parentElement.parentElement;
var pluginChosen = element.value;
Expand All @@ -460,6 +457,7 @@ function addPluginOptions(element) {
});
}

/*eslint-disable-next-line no-unused-vars*/
function addPluginOptionsHeader(element) {
var pluginContainerParent = element.parentElement.parentElement.parentElement;
var pluginChosen = element.value;
Expand Down Expand Up @@ -502,6 +500,7 @@ function initInstalledPluginListToForm() {
});
}

/*eslint-disable-next-line no-unused-vars*/
function newItemModal() {
clearLinkItemForm();
universe.ShowModal("link-item-modal");
Expand Down Expand Up @@ -544,6 +543,7 @@ function newItemModal() {
};
}

/*eslint-disable-next-line no-unused-vars*/
function editItemModal(
oldID,
oldFriendlyName,
Expand Down Expand Up @@ -728,12 +728,6 @@ function modalDelete(id) {
modalNotDeleteBtn.onclick = function () {
universe.CloseModal("deleteModal");
};

window.onclick = function (event) {
if (event.target == modal) {
universe.CloseModal("deleteModal");
}
};
}

function headerPlugins() {
Expand Down
Binary file added docs/assets/homepage-utilized-0.5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/link-item-closeup-0.5.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/searchbar-0.5.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 22 additions & 2 deletions docs/devDocs/JavaScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<dd><p>JavaScript file loaded with every single page for Universal Functions</p>
</dd>
<dt><a href="#UniverseJS">UniverseJS</a> : <code>File</code></dt>
<dd><p>Namespace of functions for easy access to repeatable actions.</p>
<dd><p>Namespace of functions for easy access to repeatable actions. Aimed at reducing complexity, and duplicity.</p>
</dd>
<dt><a href="#UploadImageJS">UploadImageJS</a> : <code>File</code></dt>
<dd><p>The JavaScript file loaded with the Upload Image Page.</p>
Expand Down Expand Up @@ -208,7 +208,7 @@ Queries GoPage APIs to determine and set a background image if needed, injecting
<a name="UniverseJS"></a>

## UniverseJS : <code>File</code>
Namespace of functions for easy access to repeatable actions.
Namespace of functions for easy access to repeatable actions. Aimed at reducing complexity, and duplicity.

**Kind**: global variable

Expand All @@ -226,6 +226,7 @@ Namespace of functions for easy access to repeatable actions.
* [.FindReturnsString(action, status)](#UniverseJS.universe.FindReturnsString) ⇒ <code>string</code>
* [.HotReload(elementID, url, callback, callbackArg)](#UniverseJS.universe.HotReload)
* [.Loader(shouldShow)](#UniverseJS.universe.Loader)
* [.ChangeLangAPI(chosenLang)](#UniverseJS.universe.ChangeLangAPI)

<a name="UniverseJS.universe"></a>

Expand All @@ -247,6 +248,7 @@ The namespace to access all internal functions.
* [.FindReturnsString(action, status)](#UniverseJS.universe.FindReturnsString) ⇒ <code>string</code>
* [.HotReload(elementID, url, callback, callbackArg)](#UniverseJS.universe.HotReload)
* [.Loader(shouldShow)](#UniverseJS.universe.Loader)
* [.ChangeLangAPI(chosenLang)](#UniverseJS.universe.ChangeLangAPI)

<a name="UniverseJS.universe.SnackbarCommon"></a>

Expand Down Expand Up @@ -420,6 +422,17 @@ Simple method of injecting a Loading animation onto the center of the page.
| --- | --- | --- |
| shouldShow | <code>boolean</code> | indicates if the loader is being turned off or on. True being on, and False being off. |

<a name="UniverseJS.universe.ChangeLangAPI"></a>

#### universe.ChangeLangAPI(chosenLang)
Allowing easy universal access to the ChangeLangAPI, by just submitting the chosenLang

**Kind**: static method of [<code>universe</code>](#UniverseJS.universe)

| Param | Type | Description |
| --- | --- | --- |
| chosenLang | <code>string</code> | The two digit language code that the server should save |

<a name="UploadImageJS"></a>

## UploadImageJS : <code>File</code>
Expand All @@ -432,6 +445,7 @@ The JavaScript file loaded with the Upload Image Page.
* [.insertImg(imageLoc)](#UploadImageJS.insertImg) ⇒ <code>string</code>
* [.setImage(name)](#UploadImageJS.setImage)
* [.unsetImage()](#UploadImageJS.unsetImage)
* [.writeUserSettings()](#UploadImageJS.writeUserSettings)

<a name="UploadImageJS.loadAvailableImages"></a>

Expand Down Expand Up @@ -472,3 +486,9 @@ Will attempt to save the specified image as the Users background image.
Will query GoPage API's to remove whatever is currently set as the User Image

**Kind**: static method of [<code>UploadImageJS</code>](#UploadImageJS)
<a name="UploadImageJS.writeUserSettings"></a>

### UploadImageJS.writeUserSettings()
Will allow an easy way of writing to user settings and setting up an error callback

**Kind**: static method of [<code>UploadImageJS</code>](#UploadImageJS)
Loading

0 comments on commit f1a6efd

Please sign in to comment.