style: linting

Aetherinox · Aetherinox · commit b4dcd5d16e7e · 2024-07-12T09:24:37.000-07:00
diff --git a/.eslintrc b/.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
+            }
+        ],
     }
 }
diff --git a/README.md b/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 />
 
 ---
diff --git a/example/advanced.js b/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'),
diff --git a/example/forceBallon.js b/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);
     });
diff --git a/example/macInput.js b/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);
 });
diff --git a/example/message.js b/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);
     })
diff --git a/example/toaster-custom-path.js b/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
 });
 
 /*
diff --git a/example/toaster-persistent.js b/example/toaster-persistent.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const path = require('path');
 const toasted = require('../index');
 
diff --git a/example/toaster-with-actions.js b/example/toaster-with-actions.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const path = require('path');
 const toasted = require('../index');
 
diff --git a/example/toaster.js b/example/toaster.js
@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const path = require('path');
 const toasted = require('../index');
 
diff --git a/lib/utils.js b/lib/utils.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 const shellwords = require('shellwords');
 const cp = require('child_process');
 const semver = require('semver');
@@ -54,10 +55,10 @@ const notifySendFlags = {
 
 module.exports.command = function (notifier, options, cb) {
     notifier = shellwords.escape(notifier);
-    if (process.env.DEBUG && process.env.DEBUG.indexOf('notifier') !== -1) {
-        console.info('node-notifier debug info (command):');
-        console.info('[notifier path]', notifier);
-        console.info('[notifier options]', options.join(' '));
+    if (process.env.DEBUG && process.env.DEBUG.indexOf('toasted') !== -1) {
+        console.info('toasted-notifier debug info (command):');
+        console.info('[toast path]', notifier);
+        console.info('[toast options]', options.join(' '));
     }
 
     return cp.exec(notifier + ' ' + options.join(' '), function (error, stdout, stderr) {
@@ -67,10 +68,10 @@ module.exports.command = function (notifier, options, cb) {
 };
 
 module.exports.fileCommand = function (notifier, options, cb) {
-    if (process.env.DEBUG && process.env.DEBUG.indexOf('notifier') !== -1) {
-        console.info('node-notifier debug info (fileCommand):');
-        console.info('[notifier path]', notifier);
-        console.info('[notifier options]', options.join(' '));
+    if (process.env.DEBUG && process.env.DEBUG.indexOf('toasted') !== -1) {
+        console.info('toasted-notifier debug info (fileCommand):');
+        console.info('[toast path]', notifier);
+        console.info('[toast options]', options.join(' '));
     }
 
     return cp.execFile(notifier, options, function (error, stdout, stderr) {
@@ -80,10 +81,10 @@ module.exports.fileCommand = function (notifier, options, cb) {
 };
 
 module.exports.fileCommandJson = function (notifier, options, cb) {
-    if (process.env.DEBUG && process.env.DEBUG.indexOf('notifier') !== -1) {
-        console.info('node-notifier debug info (fileCommandJson):');
-        console.info('[notifier path]', notifier);
-        console.info('[notifier options]', options.join(' '));
+    if (process.env.DEBUG && process.env.DEBUG.indexOf('toasted') !== -1) {
+        console.info('toasted-notifier debug info (fileCommandJson):');
+        console.info('[toast path]', notifier);
+        console.info('[toast options]', options.join(' '));
     }
 
     return cp.execFile(notifier, options, function (error, stdout, stderr) {
@@ -100,9 +101,9 @@ module.exports.fileCommandJson = function (notifier, options, cb) {
 };
 
 module.exports.immediateFileCommand = function (notifier, options, cb) {
-    if (process.env.DEBUG && process.env.DEBUG.indexOf('notifier') !== -1) {
-        console.info('node-notifier debug info (notifier):');
-        console.info('[notifier path]', notifier);
+    if (process.env.DEBUG && process.env.DEBUG.indexOf('toasted') !== -1) {
+        console.info('toasted-notifier debug info (Toast):');
+        console.info('[toast path]', notifier);
     }
 
     notifierExists(notifier, function (_, exists) {
diff --git a/notifiers/balloon.js b/notifiers/balloon.js
@@ -57,7 +57,7 @@ function notifyRaw(options, callback) {
     callback = callback || noop;
 
     if (typeof options === 'string') {
-        options = { title: 'node-notifier', message: options };
+        options = { title: 'toasted-notifier', message: options };
     }
 
     const actionJackedCallback = utils.actionJackerDecorator(this, options, callback, function (data) {
@@ -128,7 +128,7 @@ function doNotification(options, notifierOptions, callback) {
         wrapper: '',
         noEscape: true,
         explicitTrue: true,
-        allowedArguments: allowedArguments
+        allowedArguments
     });
 
     if (options.wait) {
diff --git a/notifiers/growl.js b/notifiers/growl.js
@@ -32,7 +32,7 @@ function notifyRaw(options, callback) {
     options = utils.clone(options || {});
 
     if (typeof options === 'string') {
-        options = { title: 'node-notifier', message: options };
+        options = { title: 'toasted-notifier', message: options };
     }
 
     callback = utils.actionJackerDecorator(this, options, callback, function (data) {
diff --git a/notifiers/notificationcenter.js b/notifiers/notificationcenter.js
@@ -35,7 +35,7 @@ function notifyRaw(options, callback) {
     activeId = id;
 
     if (typeof options === 'string') {
-        options = { title: 'node-notifier', message: options };
+        options = { title: 'toasted-notifier', message: options };
     }
     callback = callback || noop;
 
diff --git a/notifiers/notifysend.js b/notifiers/notifysend.js
@@ -35,7 +35,7 @@ function notifyRaw(options, callback) {
     }
 
     if (typeof options === 'string') {
-        options = { title: 'node-notifier', message: options };
+        options = { title: 'toasted-notifier', message: options };
     }
 
     if (!options.message) {
@@ -87,9 +87,9 @@ function doNotification(options, callback) {
     delete options.message;
 
     const argsList = utils.constructArgumentList(options, {
-        initial: initial,
+        initial,
         keyExtra: '-',
-        allowedArguments: allowedArguments
+        allowedArguments
     });
 
     utils.command(notifier, argsList, callback);
diff --git a/notifiers/toaster.js b/notifiers/toaster.js
@@ -65,7 +65,7 @@ function notifyRaw(options, callback) {
     };
 
     if (typeof options === 'string') {
-        options = { title: 'node-notifier', message: options };
+        options = { title: 'toasted-notifier', message: options };
     }
 
     if (typeof callback !== 'function') {
@@ -102,7 +102,6 @@ function notifyRaw(options, callback) {
         callback(null, result);
 
         /*
-            @ref    : https://github.com/mikaelbr/node-notifier/issues/334
                       Due to an issue with ntfytoast not using stdio and pipe
                       when notifications are disabled, make sure named pipe server
                       is closed before exiting.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/terminal-notifier.js b/test/terminal-notifier.js
diff --git a/test/toaster.js b/test/toaster.js
diff --git a/test/utils.js b/test/utils.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+/* eslint-disable no-console */`
`1`	`2`	`const path = require('path');`
`2`	`3`	`const toasted = require('../index');`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/* eslint-disable no-console */`
	`2`	`+`
`1`	`3`	`const path = require('path');`
`2`	`4`	`const toasted = require('../index');`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ function notifyRaw(options, callback) {`
`32`	`32`	`options = utils.clone(options \|\| {});`
`33`	`33`
`34`	`34`	`if (typeof options === 'string') {`
`35`		`- options = { title: 'node-notifier', message: options };`
	`35`	`+ options = { title: 'toasted-notifier', message: options };`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`callback = utils.actionJackerDecorator(this, options, callback, function (data) {`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ function notifyRaw(options, callback) {`
`35`	`35`	`activeId = id;`
`36`	`36`
`37`	`37`	`if (typeof options === 'string') {`
`38`		`- options = { title: 'node-notifier', message: options };`
	`38`	`+ options = { title: 'toasted-notifier', message: options };`
`39`	`39`	`}`
`40`	`40`	`callback = callback \|\| noop;`
`41`	`41`