style: linting

Author: Aetherinox

.eslintrc

@@ -1,14 +1,37 @@
 {
-    "extends": "semistandard",
+    "plugins": ["prettier"],
+    "extends": [
+      "semistandard"
+    ],
     "env": {
         "node": true,
         "jest": true
     },
     "rules": {
         "space-before-function-paren": 0,
         "no-control-regex": 0,
+        "no-console": 1,
+        "no-var": 2,
+        "prefer-const": 1,
         "no-prototype-builtins": 0,
+        "no-useless-escape": 1,
         "comma-dangle": 0,
-        "indent": "off"
+        "keyword-spacing": ["error", { "before": true, "after": true }],
+        "comma-spacing": ["error", { "before": false, "after": true }],
+        "indent": 0,
+        "prefer-spread": 1,
+        "no-mixed-operators": 1,
+        "prettier/prettier": 1,
+        "camelcase": ["error", {
+            "allow": ["^UNSAFE_"],
+            "properties": "never",
+            "ignoreGlobals": true
+        }],
+        "quotes": [
+            "error", "single", {
+                "avoidEscape": true,
+                "allowTemplateLiterals": true
+            }
+        ],
     }
 }

README.md

@@ -286,7 +286,7 @@ toasted.notify(
 
 <br />
 
-There is a default timeout set of `10` to ensure that the application closes properly. To remove the timeout and have a notification instantly close _(does not support actions)_, set `timeout: false`. If you are using an `action:`; it is recommended to set timeout to a high value to ensure the user has time to respond to the notification.
+Default timeout is `10` to ensure that the application closes properly. To remove the timeout and have notifications instantly close _(does not support actions)_, set `timeout: false`. If you are using an `action:` declaration; it is recommended to set the timeout to a high value to ensure the user has time to respond to the notification.
 
 > [!NOTE]
 > **Exception**: If `reply: true` is defined, set timeout to a high value, or to nothing at all.
@@ -376,7 +376,7 @@ If you do not see notifications from Toasted-Notifier, click windows **Start** a
 
 Locate `NtfyToast`, or your `customPath` / `appID` program in the list.
 
-<sup>`Note`: <a href="https://github.com/Aetherinox/ntfy-toast">NtfyToast</a> is the library used in Toasted-Notifier for Windows notifications</sup>
+<sup>`Note`: <a href="https://github.com/Aetherinox/ntfy-toast">NtfyToast</a> is the library used by Toasted-Notifier for Windows notifications</sup>
 
 <div align="center">
 
@@ -709,7 +709,6 @@ For instructions on accomplishing this, read the section [appID support](#appid-
 ### Can't use Windows Toast notifications in WSL2
 Ntfy makes use of a 3rd party package for Windows notifications to work. You must change the permissions on the Ntfy vendor .exe in order for it to work properly.
 
-
 ```shell
 chmod +x node_modules/toasted-notifier/vendor/ntfyToast/ntfytoast.exe
 ```
@@ -812,8 +811,6 @@ When using toasted-notifier within a tmux session, it can cause the system to ab
     set -g default-command "which reattach-to-user-namespace > /dev/null && reattach-to-user-namespace -l $SHELL || $SHELL -l"
     ```
 
-
-
 <br />
 
 ---

example/advanced.js

@@ -1,14 +1,15 @@
-const notifier = require('../');
-const nc = new notifier.NotificationCenter();
+/* eslint-disable no-console */
+
+const toasted = require('../');
+const nc = new toasted.NotificationCenter();
 const path = require('path');
 
 nc.notify(
     {
-        title: 'Phil Coulson',
-        subtitle: 'Agent of S.H.I.E.L.D.',
-        message: "If I come out, will you shoot me? 'Cause then I won't come out.",
+        title: 'Test Notification',
+        subtitle: 'This is a subtitle',
+        message: 'This is an advanced test message',
         sound: 'Funk',
-        // case sensitive
         wait: true,
         icon: path.join(__dirname, 'example_1.png'),
         contentImage: path.join(__dirname, 'example_1.png'),

example/forceBallon.js

@@ -1,9 +1,12 @@
+/* eslint-disable no-console */
 const toasted = require('../index');
+
 const balloon = toasted.WindowsBalloon();
 balloon
     .notify({ message: 'Hello' }, function (err, data) {
         console.log(err, data);
     })
+
     .on('click', function () {
         console.log(arguments);
     });

example/macInput.js

@@ -1,31 +1,35 @@
+/* eslint-disable no-console */
+
 const notifier = require('../');
 const nc = new notifier.NotificationCenter();
 
-const trueAnswer = 'Most def.';
+const trueAnswer = 'Yessir.';
+
+/*
+    @note       : closeLabel is case sensitive
+*/
 
 nc.notify(
     {
         title: 'Notifications',
-        message: 'Are they cool?',
+        message: 'Do you like them?',
         sound: 'Funk',
-        // case sensitive
-        closeLabel: 'Absolutely not',
+        closeLabel: 'Nope',
         actions: trueAnswer
     },
     function (err, response, metadata) {
         if (err) throw err;
         console.log(metadata);
 
         if (metadata.activationValue !== trueAnswer) {
-            return; // No need to continue
+            return; // Do not continue
         }
 
         nc.notify(
             {
                 title: 'Notifications',
-                message: 'Do you want to reply to them?',
+                message: 'Do you wish to reply to them?',
                 sound: 'Funk',
-                // case sensitive
                 reply: true
             },
             function (err, response, metadata) {
@@ -37,5 +41,5 @@ nc.notify(
 );
 
 nc.on('replied', function (obj, options, metadata) {
-    console.log('User replied', metadata);
+    console.log('User has replied', metadata);
 });

example/message.js

@@ -1,8 +1,10 @@
+/* eslint-disable no-console */
+
 const toasted = require('../index');
 
 toasted
     .notify({ message: 'Hello', wait: true }, function (err, data) {
-        // Will also wait until notification is closed.
+        // wait until notification is closed.
         console.log('Waited');
         console.log(err, data);
     })

example/toaster-custom-path.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const path = require('path');
 
 /*
@@ -17,7 +19,7 @@ const { WindowsToaster } = require('../');
 const customPath = path.join('vendor', 'ntfyToast', 'ntfytoast.exe');
 const toasted = new WindowsToaster({
     withFallback: false,
-    customPath: customPath
+    customPath
 });
 
 /*

example/toaster-persistent.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const path = require('path');
 const toasted = require('../index');
 

example/toaster-with-actions.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const path = require('path');
 const toasted = require('../index');
 

example/toaster.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const path = require('path');
 const toasted = require('../index');