feat: added the ability to skip artists automatically. Takes precedence over muting. fixes #175

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Move the quit command from the system sub-menu to the main menu
 - Added single click focus/show on the tray icon
   - Doesn't work on all platforms. Nothing I can do about that unfortunately!
+- Added a list of artists to automatically skip.
+  - I don't like the vast majority of dutch music so I added one of them to my list to test: [./docs/no-dutch-music.mp4](./docs/no-dutch-music.mp4)
 
 ## 4.3.1
 

src/constants/settings.js

@@ -15,6 +15,8 @@ const settings = {
   playBackControl: "playBackControl",
   muteArtists: "muteArtists",
   mutedArtists: "mutedArtists",
+  skipArtists: "skipArtists",
+  skippedArtists: "skippedArtists",
   disableBackgroundThrottle: "disableBackgroundThrottle",
   apiSettings: {
     root: "apiSettings",

src/pages/settings/preload.js

@@ -4,12 +4,14 @@ let trayIcon,
   enableCustomHotkeys,
   enableDiscord,
   muteArtists,
+  skipArtists,
   notifications,
   playBackControl,
   api,
   port,
   menuBar,
   mutedArtists,
+  skippedArtists,
   disableBackgroundThrottle,
   singleInstance,
   disableHardwareMediaKeys,
@@ -36,6 +38,8 @@ function refreshSettings() {
   minimizeOnClose.checked = store.get(settings.minimizeOnClose);
   muteArtists.checked = store.get(settings.muteArtists);
   mutedArtists.value = store.get(settings.mutedArtists).join("\n");
+  skipArtists.checked = store.get(settings.skipArtists);
+  skippedArtists.value = store.get(settings.skippedArtists).join("\n");
   singleInstance.checked = store.get(settings.singleInstance);
   disableHardwareMediaKeys.checked = store.get(settings.flags.disableHardwareMediaKeys);
   gpuRasterization.checked = store.get(settings.flags.gpuRasterization);
@@ -119,6 +123,8 @@ window.addEventListener("DOMContentLoaded", () => {
   enableDiscord = get("enableDiscord");
   muteArtists = get("muteArtists");
   mutedArtists = get("mutedArtists");
+  skipArtists = get("skipArtists");
+  skippedArtists = get("skippedArtists");
   disableBackgroundThrottle = get("disableBackgroundThrottle");
   singleInstance = get("singleInstance");
   disableHardwareMediaKeys = get("disableHardwareMediaKeys");
@@ -138,6 +144,8 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(minimizeOnClose, settings.minimizeOnClose);
   addInputListener(muteArtists, settings.muteArtists);
   addTextAreaListener(mutedArtists, settings.mutedArtists);
+  addInputListener(skipArtists, settings.skipArtists);
+  addTextAreaListener(skippedArtists, settings.skippedArtists);
   addInputListener(disableBackgroundThrottle, settings.disableBackgroundThrottle);
   addInputListener(singleInstance, settings.singleInstance);
   addInputListener(disableHardwareMediaKeys, settings.flags.disableHardwareMediaKeys);

src/pages/settings/settings.html

@@ -63,6 +63,18 @@
               </label>
             </div>
             <textarea id="mutedArtists" class="textarea" cols="40" rows="5" spellcheck="false"></textarea>
+            <div class="group__option">
+              <div class="group__description">
+                <h4>Skip Artists automatically</h4>
+                <p>The following list of artists (1 per line) will be skipped automatically.</p>
+              </div>
+              <label class="switch">
+                <input id="skipArtists" type="checkbox">
+                <span class="switch__slider"></span>
+              </label>
+            </div>
+            <textarea id="skippedArtists" class="textarea" cols="40" rows="5" spellcheck="false"></textarea>
+
           </div>
           <div class="group">
             <p class="group__title">UI</p>

src/preload.js

@@ -7,6 +7,7 @@ const { downloadFile } = require("./scripts/download");
 const statuses = require("./constants/statuses");
 const hotkeys = require("./scripts/hotkeys");
 const globalEvents = require("./constants/globalEvents");
+const { skipArtists } = require("./constants/settings");
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 const appName = "Tidal Hifi";
 let currentSong = "";
@@ -327,7 +328,8 @@ function getTrackURL() {
 setInterval(function () {
   const title = elements.getText("title");
   const artists = elements.getArtists();
-  muteArtistIfFoundInMutedArtistsList(); // doing this here so that nothing can possibly fail before we call this function
+  skipArtistsIfFoundInSkippedArtistsList(artists);
+  muteArtistIfFoundInMutedArtistsList(artists); // doing this here so that nothing can possibly fail before we call this function
 
   const album = elements.getAlbumName();
   const current = elements.getText("current");
@@ -382,7 +384,7 @@ setInterval(function () {
   /**
    * Checks whether the current artist is included in the "muted artists" list and if so it will automatically mute the player
    */
-  function muteArtistIfFoundInMutedArtistsList() {
+  function muteArtistIfFoundInMutedArtistsList(artists) {
     if (store.get(settings.muteArtists)) {
       const mutedArtists = store.get(settings.mutedArtists);
       if (mutedArtists.find((artist) => artist === artists) !== undefined) {
@@ -396,6 +398,19 @@ setInterval(function () {
       }
     }
   }
+
+  /**
+   * automatically skip a song if the artists are found in the list of artists to skip
+   * @param {*} artists list of artists to skip
+   */
+  function skipArtistsIfFoundInSkippedArtistsList(artists) {
+    if (store.get(skipArtists)) {
+      const skippedArtists = store.get(settings.skippedArtists);
+      if (skippedArtists.find((artist) => artist === artists) !== undefined) {
+        elements.click("next");
+      }
+    }
+  }
 }, 1000);
 
 if (process.platform === "linux" && store.get(settings.mpris)) {

src/scripts/settings.js

@@ -12,6 +12,8 @@ const store = new Store({
     playBackControl: true,
     muteArtists: false,
     mutedArtists: ["TIDAL"],
+    skipArtists: false,
+    skippedArtists: [""],
     disableBackgroundThrottle: true,
     menuBar: true,
     apiSettings: {