Merge pull request #22 from MattIPv4/0.1.0

0.1.0

Author: MattIPv4

.babelrc

@@ -6,7 +6,7 @@
         "forceAllTransforms": true,
         "useBuiltIns": "entry",
         "exclude": ["transform-regenerator", "transform-async-to-generator"],
-        "debug": true,
+        "debug": false,
         "loose": true
       }
     ]

.github/FUNDING.yml

@@ -0,0 +1,8 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: IPv4
+open_collective: # Replace with a single Open Collective username
+ko_fi: MattIPv4
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+custom: https://paypal.me/MattIPv4Cowley

.github/ISSUE_TEMPLATE/help.md

@@ -0,0 +1,32 @@
+---
+name: Help ❓
+about: Encountered a problem with macOSNotifJS? Not sure how to fix it?
+
+---
+
+<!-- Don't write inside the arrows as they will be hidden when you post your issue.
+
+1.  Fill out the template.
+      This will help us understand what problem you've encountered and help us
+      find a solution.
+
+2.  Delete this line and all above lines before posting your issue! -->
+
+## Information
+
+### Version
+<!-- Please place the version of macOSNotifJS that you are using (commit hash if applicable) -->
+
+### Development environment
+<!-- Please replace this with the exact (full) version of the browser you are using -->
+
+## Help request
+
+### Problem
+<!-- What problem did you encounter? -->
+
+### What I have tried
+<!-- What have you tried so far? -->
+
+### Screenshots
+<!-- If relevant, include any screenshots here. -->

.github/ISSUE_TEMPLATE/report-a-bug.md

@@ -0,0 +1,41 @@
+---
+name: Report a bug 🐛
+about: Report a bug with macOSNotifJS. Only use this if you're 100% sure there's something wrong, otherwise, try "Help".
+
+---
+
+<!-- Don't put anything inside this block, as it won't be included in the issue.
+
+If you are reporting a bug, please follow the following steps:
+
+1.  Fill out the template in full.
+      This will help us understand the situation in which the bug occurred.
+
+2.  If you are reporting a visual bug, please include screenshots (or photos of
+     your screen if during the capture process) to help us diagnose the problem.
+
+3.  Make sure not to write between the arrows, as anything there will be hidden.
+
+4.  Delete this line and all above lines before posting your issue! -->
+
+## Information
+
+### Version
+<!-- Please place the version of macOSNotifJS that you are using (commit hash if applicable) -->
+
+### Development environment
+<!-- Please replace this with the exact (full) version of the browser you are using -->
+
+## Details
+
+### Description 
+<!-- Replace this with a brief summary of the bug. -->
+
+### Steps to reproduce
+<!-- Replace this with exactly what you did to cause the bug. -->
+
+#### Expected behaviour
+<!-- Replace this with what you expected to happen. -->
+
+### Screenshots
+<!-- Replace this with screenshots, if necessary. -->

.github/ISSUE_TEMPLATE/request-a-feature.md

@@ -0,0 +1,38 @@
+---
+name: Request a feature 🆕
+about: Suggest a new feature that you would like in macOSNotifJS!
+
+---
+
+<!-- Fill out the template. Don't write inside the arrows as they will be hidden
+when you post your issue.
+
+If you have a feature suggestion for macOSNotifJS, read through the following steps:
+
+1.  Fill out the template.
+      This will help us understand what you're requesting and why you want us
+      to add it.
+
+2.  Keep it simple.
+      Make sure it's easy to understand what you're requesting. A good way is
+      to keep it to one request per GitHub issue, as we can then easily track
+      feature requests.
+
+3.  Check whether it has already been asked or added.
+      You can search the GitHub issues to see if your feature has already been
+      requested at https://github.com/MattIPv4/macOSNotifJS/issues.
+
+4.  Ask yourself: "Does this idea/feature belong as part of macOSNotifJS?"
+      Whilst we'd love to be able to add every feature that every user wants,
+      we want to keep the plugin as small and as fast as possible by limiting how
+      much code we have.
+
+5.  Delete this line and all above lines before posting your issue! -->
+
+## Feature request
+
+### Feature description
+<!-- What feature are you suggesting? -->
+
+### How the feature is useful
+<!-- How is the feature useful to macOSNotifJS users? -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!-- Don't put anything inside this block, as it won't be included in the pull request.
+
+If you are wanting to submit a PR for your changes, please follow the following steps:
+
+1.  Fill out the template in full.
+      This will help us understand exactly what you are contributing to the plugin.
+
+2.  If you are making visual changes, please makre sure you provide screenshots
+     for comparison of any changes made.
+     
+3.  If you have made any changes to the codebase, please ensure it passes a scan of
+     ESLint and that you have put sufficient comments with your code!
+
+4.  Make sure not to write between the arrows, as anything there will be hidden.
+
+5.  Delete this line and all above lines before posting your issue! -->
+
+## Proposed changes
+<!-- Replace this with a list of changes this pull request makes,
+both "internal" (code style etc.) and "external" (UI/UX, features etc.). -->
+
+## Additional comments
+<!-- Please let us know anything else about this PR, known issues etc. -->
+
+## Screenshots
+<!-- Include any screenshots of visual changes to the plugin. -->

ISSUE_TEMPLATE.md

@@ -1,17 +1,48 @@
+/**
+ *  macOSNotifJS: A simple Javascript plugin to create simulated macOS notifications on your website.
+ *  <https://github.com/MattIPv4/macOSNotifJS/>
+ *  Copyright (C) 2019 Matt Cowley (MattIPv4) (me@mattcowley.co.uk)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published
+ *   by the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *  This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *  You should have received a copy of the GNU Affero General Public License
+ *   along with this program. If not, please see
+ *   <https://github.com/MattIPv4/macOSNotifJS/blob/master/LICENSE> or <http://www.gnu.org/licenses/>.
+ */
+
+const chalk = require("chalk");
 const Fontmin = require("fontmin");
 
-const fonts = new Fontmin()
-    .src("src/fonts/src/*.otf")
-    .use(Fontmin.otf2ttf())
-    .use(Fontmin.ttf2eot())
-    .use(Fontmin.ttf2woff({ deflate: true }))
-    .dest("src/fonts/build");
+const buildFonts = () => {
+    return new Promise((resolve, reject) => {
+        const fonts = new Fontmin()
+            .src("src/fonts/src/*.otf")
+            .use(Fontmin.otf2ttf())
+            .use(Fontmin.ttf2eot())
+            .use(Fontmin.ttf2woff({ deflate: true }))
+            .dest("src/fonts/build");
 
-fonts.run((err, files) => {
-    if (err) throw err;
-    files.forEach(file => {
-        console.info("\x1b[36m%s\x1b[0m", "\n" + file.history.slice(-1)[0]);
-        console.log("\t" + file.history.slice(-1)[0].replace(/^.*[\\/]/, ""));
+        fonts.run((err, files) => {
+            if (err) {
+                console.error(chalk.red.bold("Failed to build fonts"));
+                reject();
+                throw err;
+            }
+            files.forEach(file => {
+                console.info(chalk.cyan("\n" + file.history.slice(-1)[0]));
+                console.log("\t" + file.history.slice(-1)[0].replace(/^.*[\\/]/, ""));
+            });
+            console.log(chalk.green("\nSuccessfully built " + files.length.toString() + " font files."));
+            resolve();
+        });
     });
-    console.log("\x1b[32m%s\x1b[0m", "\nSuccessfully built " + files.length.toString() + " font files.");
-});
+};
+
+// Run
+buildFonts();