Merge pull request #19 from pSpitzner/eslint-fix

Fixes ESLint errors and we now read the default config

.github/workflows/eslint.yml

@@ -10,38 +10,30 @@
 name: ESLint
 
 on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    push:
+        branches: ["main"]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: ["main"]
 
 jobs:
-  eslint:
-    name: Run eslint scanning
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      security-events: write
-      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+    eslint:
+        name: Run eslint scanning
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            security-events: write
+            actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
 
-      - name: Install ESLint
-        run: |
-          npm install \
-            eslint@^8.57.0 \
-            eslint-plugin-react@^7.34.1 \
-            eslint-plugin-react-hooks@^4.6.2 \
-            eslint-plugin-react-refresh@^0.4.6 \
-            @typescript-eslint/eslint-plugin@^7.2.0 \
-            @typescript-eslint/parser@^7.2.0 \
-            @tanstack/eslint-plugin-query@^5.35.6
+            - name: Install ESLint
+              run: |
+                  cd ./frontend
+                  npm install
 
-      - name: Run ESLint
-        run: |
-          cd ./frontend
-          npx eslint .
-          --config .eslintrc.js
-          --ext .js,.jsx,.ts,.tsx
+            - name: Run ESLint
+              run: |
+                  cd ./frontend
+                  npm run lint

CHANGELOG.md

@@ -1,2 +1,18 @@
-# 24-05-22 version 0.0.1
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.0.2] - 24-07-16
+
+### Fixed
+- ESLint errors and Github action
+- Now loading the default config
+
+## 0.0.1 - 24-05-22
 - initial commit
+
+[0.0.2]: https://github.com/pSpitzner/beets-flask/compare/v0.0.1...v0.0.2

backend/beets_flask/_version.py

@@ -1 +1 @@
-__version__ = '0.0.1'
+__version__ = '0.0.2'

backend/beets_flask/config.py

@@ -18,7 +18,16 @@
 ```
 """
 
+import confuse
 from beets_flask.utility import log
 from beets import config
-config.set_env(prefix='BF')
 
+config.set_env(prefix="BF")
+
+try:
+    # docker container
+    default_source = confuse.YamlSource("/repo/configs/default.yaml", default=True)
+except confuse.ConfigReadError:
+    # running as module. but we should place the default config where confuse looks for it.
+    default_source = confuse.YamlSource("./configs/default.yaml", default=True)
+config.add(default_source)  # .add inserts with lowest priority

configs/default.yaml

@@ -0,0 +1,36 @@
+# ------------------------------------------------------------------------------------ #
+#                                 DO NOT EDIT THIS FILE                                #
+# ------------------------------------------------------------------------------------ #
+# these are the defaults for the gui.
+# you must provide your own config and map it to /home/beetle/.config/beets/config.yaml
+# to get started, see the example.yaml
+
+gui:
+    num_workers_preview: 4
+
+    library:
+        readonly: no
+        include_paths: yes
+
+    tags:
+        expand_tags: yes
+        recent_days: 14
+        order_by: "name"
+
+    terminal:
+        start_path: "/repo"
+
+    inbox:
+        concat_nested_folders: yes
+        expand_files: no
+
+        # you must set inbox folders and the music directory in *your* beets config!
+        # (we only keep it around so the container can launch when nothing is configured)
+
+        folders:
+            Placeholder:
+                name: "Please configure your inbox!"
+                path: "/music/inbox"
+                autotag: no # no | "preview" | "import"
+
+directory: /music/imported

configs/beets_example.yaml → configs/example.yaml

@@ -10,14 +10,14 @@ gui:
     tags:
         expand_tags: yes # for tag groups, on page load, show tag details?
         recent_days: 14 # Number of days to consider for the "recent" tag group
+        order_by: "name" # how to sort tags within the trag groups: "name" (the album folder basename) | "date_created" | "date_modified"
 
     terminal:
         start_path: "/music/inbox" # the directory where to start new terminal sessions
 
     inbox:
         concat_nested_folders: yes # show multiple folders in one line if they only have one child
         expand_files: no # on page load, show files in (album) folders, or collapse them
-        order_by: "name" # how to sort tags within the trag groups: "name" (the album folder basename) | "date_created" | "date_modified"
 
         folders: # keep in mind to volume-map these folders in your docker-compose.yml
             Lorem:

entrypoint.sh

@@ -4,16 +4,9 @@ id
 
 cd /repo
 
-
-# Check if configs exist and copy if they dont
-if [ ! -f /home/beetle/.config/beets/config.yaml ]; then
-	    mkdir -p /home/beetle/.config/beets
-	        cp /repo/configs/beets_default.yaml /home/beetle/.config/beets/config.yaml
-fi
-
 NUM_WORKERS_PREVIEW=$(yq e '.gui.num_workers_preview' /home/beetle/.config/beets/config.yaml)
 if ! [[ "$NUM_WORKERS_PREVIEW" =~ ^[0-9]+$ ]]; then
-    NUM_WORKERS_PREVIEW=1
+    NUM_WORKERS_PREVIEW=4
 fi
 
 mkdir -p /repo/log

entrypoint_dev.sh

@@ -12,15 +12,9 @@ npm run dev &
 
 cd /repo
 
-# Check if configs exist and copy if they dont
-if [ ! -f /home/beetle/.config/beets/config.yaml ]; then
-	    mkdir -p /home/beetle/.config/beets
-	        cp /repo/configs/beets_default.yaml /home/beetle/.config/beets/config.yaml
-fi
-
 NUM_WORKERS_PREVIEW=$(yq e '.gui.num_workers_preview' /home/beetle/.config/beets/config.yaml)
 if ! [[ "$NUM_WORKERS_PREVIEW" =~ ^[0-9]+$ ]]; then
-    NUM_WORKERS_PREVIEW=1
+    NUM_WORKERS_PREVIEW=4
 fi
 
 mkdir -p /repo/log

entrypoint_test.sh

@@ -8,19 +8,18 @@ cd /repo
 
 redis-server --daemonize yes
 
-# Check if configs exist and copy if they dont
-if [ ! -f /home/beetle/.config/beets/config.yaml ]; then
-	    mkdir -p /home/beetle/.config/beets
-	        cp /repo/configs/beets_default.yaml /home/beetle/.config/beets/config.yaml
+NUM_WORKERS_PREVIEW=$(yq e '.gui.num_workers_preview' /home/beetle/.config/beets/config.yaml)
+if ! [[ "$NUM_WORKERS_PREVIEW" =~ ^[0-9]+$ ]]; then
+    NUM_WORKERS_PREVIEW=4
 fi
 
-
 for i in $(seq 1 $NUM_WORKERS_PREVIEW)
 do
   # also for tests redirect to /dev/null, otherwise, test printout gets scrambled
   rq worker preview --log-format "Preview worker $i: %(message)s" > /dev/null &
 done
 
+NUM_WORKERS_IMPORT=1
 for i in $(seq 1 $NUM_WORKERS_IMPORT)
 do
   rq worker import --log-format "Import worker $i: %(message)s" > /dev/null &

frontend/.eslintrc.cjs

@@ -17,6 +17,12 @@ module.exports = {
         'react-refresh/only-export-components': [
             0,
         ],
+        "@typescript-eslint/no-empty-function": "off",
+    },
+    settings: {
+        react: {
+            version: '18.2',
+        },
     },
     parserOptions: {
         ecmaVersion: "latest",

frontend/package.json

@@ -1,7 +1,7 @@
 {
     "name": "frontend",
     "private": true,
-    "version": "0.0.1",
+    "version": "0.0.2",
     "type": "module",
     "scripts": {
         "dev": "vite --host --cors",

frontend/src/components/common/buttons.tsx

@@ -7,9 +7,6 @@ import { forwardRef, useState } from "react";
 
 
 
-
-
-
 /**
  * Renders an icon button with a mutation option.
  *
@@ -30,8 +27,8 @@ export const IconButtonWithMutation = forwardRef(function IconButtonWithMutation
         children,
         ...props
     }: {
-        mutationOption?: UseMutationOptions<unknown, Error, any, unknown>
-        mutateArgs?: any;
+        mutationOption?: UseMutationOptions<unknown, Error, unknown, unknown>
+        mutateArgs?: unknown;
     } & ButtonProps,
     ref?: React.Ref<HTMLDivElement>
 ) {
@@ -96,8 +93,8 @@ export const IconButtonWithMutationAndFeedback = forwardRef(function IconButtonW
         mutateArgs,
         ...props
     }: {
-        mutationOption: UseMutationOptions<unknown, Error, any, unknown>
-        mutateArgs: any,
+        mutationOption: UseMutationOptions<unknown, Error, unknown, unknown>
+        mutateArgs: unknown,
         confirmTitle: string;
     } & ButtonProps,
     ref?: React.Ref<HTMLDivElement>