Merge pull request #1 from Exhabition/development

Add stabilish stuff to main

Author: Exhabition

additions/Eris/MessageButton.js

@@ -0,0 +1,11 @@
+class MessageButton {
+    constructor() {
+        this.useful = true;
+
+        return this;
+    }
+}
+
+module.exports = Eris => {
+    Eris.MessageButton = MessageButton;
+};

additions/Eris/MessageEmbed.js

@@ -0,0 +1,82 @@
+class MessageEmbed {
+    constructor() {
+        this.fields = [];
+
+        return this;
+    }
+
+    setAuthor(name, icon_url, url) {
+        this.author = { name, icon_url, url };
+
+        return this;
+    }
+
+    setColor(color) {
+        if (color.startsWith("#")) this.color = parseInt(color, 16);
+        else this.color = color;
+
+        return this;
+    }
+
+    setTitle(title) {
+        this.title = title.toString().slice(256);
+
+        return this;
+    }
+
+    setUrl(url) {
+        this.url = url;
+
+        return this;
+    }
+
+    setDescription(description) {
+        this.description = description.toString().slice(2048);
+
+        return this;
+    }
+
+    setThumbnail(url) {
+        this.thumbnail = { url };
+
+        return this;
+    }
+
+    setImage(url) {
+        this.image = { url };
+
+        return this;
+    }
+
+    setTimestamp(time = new Date()) {
+        this.timestamp = time;
+
+        return this;
+    }
+
+    setFooter(text, icon_url) {
+        this.footer = { text: text.toString().slice(2048), icon_url };
+
+        return this;
+    }
+
+    addField(name, value, inline = false) {
+        if (this.fields.length >= 25) {
+            console.warn("Limit of 25 fields exceeded, no field was added");
+            return this;
+        } else if (!name || !value) {
+            console.warn("Both a name & value are needed, no field was addded");
+            return this;
+        }
+
+        this.fields.push({ name: toString().slice(256), value: value.toString().slice(256), inline });
+    }
+
+    clearFields() {
+        this.fields = [];
+    }
+}
+
+module.exports = Eris => {
+    Eris.MessageEmbed = MessageEmbed;
+};

additions/Member/hoistColor.js

@@ -0,0 +1,12 @@
+const { addPrototype } = require("erisify/helper/prototype");
+
+/**
+ * @param {import("eris")} Eris
+ */
+module.exports.init = (Eris) => {
+    addPrototype(Eris, "Member", function hoistColor() {
+        const hoistedRole = this.roles.find(item => item.hoist);
+
+        return hoistedRole?.color || "#FFFF";
+    }, true);
+};

additions/Member/tag.js

@@ -0,0 +1,10 @@
+const { addPrototype } = require("erisify/helper/prototype");
+
+/**
+ * @param {import("eris")} Eris
+ */
+module.exports.init = (Eris) => {
+    addPrototype(Eris, "Member", function tag() {
+        return `${this.username}#${this.discriminator}`;
+    }, true);
+};

additions/Role/higherThan.js

@@ -0,0 +1,13 @@
+const { addPrototype } = require("erisify/helper/prototype");
+
+/**
+ * @param {import("eris")} Eris
+ */
+module.exports.init = (Eris) => {
+    addPrototype(Eris, "Role", function higherThan(roleTwo) {
+        // If both roles have the same position then use id's (the lower the id the older it is, so lets return true if it's older)
+        if (this.position === roleTwo.position) return this.id < roleTwo.id;
+
+        return this.position > roleTwo.position;
+    }, true);
+};

additions/Role/isHighest.js

@@ -0,0 +1,12 @@
+const { addPrototype } = require("erisify/helper/prototype");
+
+/**
+ * @param {import("eris")} Eris
+ */
+module.exports.init = (Eris) => {
+    addPrototype(Eris, "Role", function isHighest() {
+        const highestRole = Math.max.apply(Math, array.map(item => item.position));
+
+        return highestRole.id === this.id;
+    }, true);
+};

additions/User/tag.js

@@ -4,7 +4,7 @@ const { addPrototype } = require("erisify/helper/prototype");
  * @param {import("eris")} Eris
  */
 module.exports.init = (Eris) => {
-    addPrototype(Eris, "User", function guild() {
+    addPrototype(Eris, "User", function tag() {
         return `${this.username}#${this.discriminator}`;
     }, true);
 };

package.json

@@ -6,6 +6,14 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Exhabition/erisify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Exhabition/erisify/issues"
+  },
+  "homepage": "https://github.com/Exhabition/erisify#readme",
   "peerDependencies": {
     "eris": ">=0.15.0"
   },

readme.md

@@ -1,2 +1,61 @@
-# erisify
-dank package which i made just because i am lazy
+# 🌸 erisify 🌸
+
+🌹 uwu eris but a few extwa thingies uwu 🌹
+
+<br>how to use?1!?
+
+```js
+const Eris = require("eris");
+require("erisify")(Eris);
+```
+
+🌺 owo more advanced owo 🌺
+
+```js
+const Eris = require("eris");
+require("erisify")(Eris, { disabled: ["Message.tag"] });
+```
+
+# teh thingies
+
+## Message
+
+🌸 `guild` - Shortcute of `message.channel.guild`
+
+## User
+
+🌸 `tag` - Combines teh `User.username` & `User.discriminator`
+
+# options yay
+
+🏵️ `enabled` - When `enabled` contains 1 or more specific items, only those are enabled, other additions will then be disabled.
+<br>[Default = `"all"`]
+
+🏵️ `disabled` - Disabled specific additions while all other additions stay enabled
+<br>[Default = `"none"`]
+
+🏵️ `logging` - Either `true` or `false`
+<br>[Default = `false`]
+
+## examples
+
+the following example will _only_ enable `Message.tag` and disable all other additions. Also disables logging.
+
+```js
+const Eris = require("eris");
+require("erisify")(Eris, { enabled: ["Message.tag"] }, false);
+```
+
+the following example will _only_ disable `Message.tag` and enable all other additions. Also enables logging.
+
+```js
+const Eris = require("eris");
+require("erisify")(Eris, { disabled: ["Message.tag"] }, true);
+```
+
+## todo
+- [ ] fixy like the entire package owo
+- [ ] add useful stuff
+
+## credits
+package inspired by `bsian03's` [pluris](https://github.com/bsian03/pluris) package