Components es6 apply code review fix suggestions

.codespellignore

@@ -2,3 +2,4 @@ Crate
 crate
 InOut
 copyable
+sord

.eslintrc.json

@@ -13,44 +13,56 @@
     "brace-style": ["warn", "1tbs", {
         "allowSingleLine": true
     }],
+    "curly": "warn",
     "camelcase": "warn",
     "comma-spacing": "warn",
     "computed-property-spacing" : ["warn", "never", {
         "enforceForClassMembers": true
     }],
-    "dot-location": "warn",
+    "dot-location": ["warn", "property"],
+    "dot-notation": "warn",
     "eqeqeq": ["error", "always"],
+    "func-call-spacing": "warn",
     "func-style": ["error", "expression", {
         "allowArrowFunctions": true
     }],
     "indent": ["warn", 4],
     "key-spacing": "warn",
     "keyword-spacing": "warn",
     "linebreak-style": ["warn", "unix"],
+    "newline-per-chained-call": "warn",
+    "no-constructor-return": "warn",
+    "no-extra-bind": "warn",
+    "no-sequences": "warn",
+    "no-useless-call": "warn",
+    "no-useless-return": "warn",
     "no-trailing-spaces": "warn",
     "no-unneeded-ternary": ["warn", {
         "defaultAssignment": false
     }],
     "no-unused-vars": ["error", {
         "argsIgnorePattern": "^_"
     }],
+    "no-var": "warn",
     "object-curly-newline" : ["warn", {
         "consistent": true,
         "multiline": true
     }],
     "object-curly-spacing" : "warn",
+    "prefer-const": "warn",
+    "prefer-regex-literals": "warn",
     "quotes": ["warn", "double"],
     "require-atomic-updates": "error",
     "semi": "warn",
     "semi-spacing": "warn",
     "space-before-blocks": ["warn", "always"],
     "space-before-function-paren": ["warn", "never"],
-    "space-in-parens": "warn"
+    "space-in-parens": "warn",
+    "yoda": "warn"
   },
   "globals": {
     "console": "writable",
     "svg": "writable",
-    "print": "readonly",
     "HIDController": "writable",
     "HIDDebug": "writable",
     "HIDPacket": "writable",

.github/workflows/build-checks.yml

@@ -132,6 +132,7 @@ jobs:
       working-directory: build
     - name: "Upload Coverage Report to coveralls.io"
       if: matrix.name == 'coverage'
+      continue-on-error: true
       uses: coverallsapp/github-action@master
       with:
         flag-name: ubuntu-20.04

.github/workflows/build.yml

@@ -53,7 +53,7 @@ jobs:
             qt_qpa_platform: offscreen
           - name: Windows 2019 (MSVC)
             os: windows-2019
-            # TODO: Reenable FFmpeg after licensing issues have been clarified
+            # TODO: Re-enable FFmpeg after licensing issues have been clarified
             # Attention: If you change the cmake_args for the Windows CI build,
             #            also adjust the for the local Windows build setup in
             #            ./tools/windows_buildenv.bat
@@ -94,35 +94,6 @@ jobs:
       artifact-windows-win64: ${{ steps.prepare_deploy.outputs.artifact-windows-win64 }}
     steps:
 
-    - name: "[Windows] Install rsync and openssh"
-      if: runner.os == 'Windows'
-      run: |
-        $Env:PATH="c:\msys64\usr\bin;$Env:PATH"
-        pacman -S --noconfirm coreutils bash rsync openssh
-        # Unfortunately, mixing executables from msys64 and mingw (i.e. Git
-        # Bash) does not work properly and leads to errors like these:
-        #
-        #     0 [main] python3 (5248) C:\msys64\usr\bin\python3.exe: *** fatal error - cygheap base mismatch detected - 0x180347408/0x180352408.
-        #
-        # Even when prepending the MSYS2 binary directory to %PATH%, GitHub
-        # Actions will still pick the Git Bash executable over the MSYS2 one
-        # when using `shell: bash`. Since it's not feasible to set `shell` to
-        # an absolute path in a cross-platform build workflow, we overwrite the
-        # git bash executable with the MSYS2 one.
-        #
-        # Also see related issue:
-        # https://github.com/actions/virtual-environments/issues/594
-        Copy-Item -Path "C:\msys64\usr\bin\bash.exe" -Destination "C:\Program Files\Git\bin\bash.exe" -Force
-        # By default, MSYS2 uses an
-        # /etc/profile file that changes
-        # the current working directory
-        # when bash is started. We don't
-        # want this behavior,so we just
-        # delete it.
-        Remove-Item -Path "C:\msys64\etc\profile"
-        # Add MSYS2's tools to %PATH%.
-        Add-Content -Path "$Env:GITHUB_ENV" -Value "PATH=$Env:PATH"
-
     # sccache's handling of the /fp:fast MSVC compiler option is broken, so use our fork with the fix.
     # https://github.com/mozilla/sccache/issues/950
     - name: "[Windows] Set up cargo cache"
@@ -168,6 +139,11 @@ jobs:
       if: runner.os == 'Windows'
       uses: seanmiddleditch/gha-setup-vsdevenv@v3
 
+    - name: "[macOS] install ccache and make"
+      if: runner.os == 'macOS'
+      run: |
+        brew install ccache ninja
+
     - name: "[macOS/Windows] Get build environment name"
       if: runner.os != 'Linux'
       id: buildenv_name
@@ -223,8 +199,12 @@ jobs:
         BUILDENV_BASEPATH: ${{ matrix.buildenv_basepath }}
 
     - name: "[Ubuntu/macOS] Set compiler cache size limit"
-      # Set size to 2 GiB
-      run: ${{ matrix.compiler_cache }}  -M 2097152
+      # A full build without a cache fills the cache with about 300 MB.
+      # GitHub Actions gives us 5 GB of cache for free.
+      # 3 operating systems * 2 conditions (Qt5 & Qt6) * 512 MB = 3 GB
+      # We use a new cache key for every job, so we would run out of
+      # space frequently if the cache was much bigger.
+      run: ${{ matrix.compiler_cache }} -M 524288
       if: runner.os != 'windows'
 
     - name: "Set up compiler cache"
@@ -362,6 +342,39 @@ jobs:
         --dest-url 'https://downloads.mixxx.org'
         ${{ matrix.artifacts_path }}
 
+    # Warning: do not move this step before restoring caches or it will break caching due to
+    # https://github.com/actions/cache/issues/531
+    - name: "[Windows] Install rsync and openssh"
+      env:
+        SSH_PRIVATE_KEY: ${{ secrets.DOWNLOADS_HOSTGATOR_DOT_MIXXX_DOT_ORG_KEY }}
+      if: runner.os == 'Windows' && github.event_name == 'push' && env.SSH_PRIVATE_KEY != null
+      run: |
+        $Env:PATH="c:\msys64\usr\bin;$Env:PATH"
+        pacman -S --noconfirm coreutils bash rsync openssh
+        # Unfortunately, mixing executables from msys64 and mingw (i.e. Git
+        # Bash) does not work properly and leads to errors like these:
+        #
+        #     0 [main] python3 (5248) C:\msys64\usr\bin\python3.exe: *** fatal error - cygheap base mismatch detected - 0x180347408/0x180352408.
+        #
+        # Even when prepending the MSYS2 binary directory to %PATH%, GitHub
+        # Actions will still pick the Git Bash executable over the MSYS2 one
+        # when using `shell: bash`. Since it's not feasible to set `shell` to
+        # an absolute path in a cross-platform build workflow, we overwrite the
+        # git bash executable with the MSYS2 one.
+        #
+        # Also see related issue:
+        # https://github.com/actions/virtual-environments/issues/594
+        Copy-Item -Path "C:\msys64\usr\bin\bash.exe" -Destination "C:\Program Files\Git\bin\bash.exe" -Force
+        # By default, MSYS2 uses an
+        # /etc/profile file that changes
+        # the current working directory
+        # when bash is started. We don't
+        # want this behavior,so we just
+        # delete it.
+        Remove-Item -Path "C:\msys64\etc\profile"
+        # Add MSYS2's tools to %PATH%.
+        Add-Content -Path "$Env:GITHUB_ENV" -Value "PATH=$Env:PATH"
+
     - name: "Set up SSH Agent"
       if: github.event_name == 'push' && env.SSH_PRIVATE_KEY != null
       shell: bash

.github/workflows/changelog.yml

@@ -0,0 +1,27 @@
+name: Changelog
+
+on:
+  push:
+    branches:
+      - "main"
+      - "[0-9].[0-9]"
+    paths:
+      - "CHANGELOG.md"
+
+jobs:
+  trigger-changelog-update:
+    name: Trigger Changelog update on manual repository
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get current branch name
+      uses: nelonoel/branch-name@v1.0.1
+    - name: Start workflow run on manual repository
+      uses: peter-evans/repository-dispatch@v1
+      if: env.MIXXXBOT_TOKEN != null
+      with:
+        token: ${{ env.MIXXXBOT_TOKEN }}
+        repository: mixxxdj/manual
+        event-type: update-changelog
+        client-payload: '{"branch": "${{ env.BRANCH_NAME }}", "ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+      env:
+        MIXXXBOT_TOKEN: ${{ secrets.MIXXXBOT_CHANGELOG_AUTOUPDATER_PAT }}

.github/workflows/pre-commit.yml

@@ -10,24 +10,24 @@ jobs:
     runs-on: ubuntu-latest
     # The Dockerfile for this container can be found at:
     # https://github.com/Holzhaus/mixxx-ci-docker
-    container: holzhaus/mixxx-ci:20210526
+    container: holzhaus/mixxx-ci:20210923
     steps:
     - name: "Check out repository"
       uses: actions/checkout@v2
       with:
         fetch-depth: 2
 
     - name: "Detect code style issues (push)"
-      uses: pre-commit/action@v2.0.0
+      uses: pre-commit/action@v2.0.3
       if: github.event_name == 'push'
       # There are too many files in the repo that have formatting issues. We'll
       # disable these checks for now when pushing directly (but still run these
       # on Pull Requests!).
       env:
-        SKIP: end-of-file-fixer,trailing-whitespace,clang-format,eslint,no-commit-to-branch
+        SKIP: clang-format,eslint,no-commit-to-branch
 
     - name: "Detect code style issues (pull_request)"
-      uses: pre-commit/action@v2.0.0
+      uses: pre-commit/action@v2.0.3
       if: github.event_name == 'pull_request'
       env:
         SKIP: no-commit-to-branch
@@ -50,3 +50,7 @@ jobs:
       with:
         name: ${{ env.UPLOAD_PATCH_FILE }}
         path: ${{ env.UPLOAD_PATCH_FILE }}
+
+    # AppStream metadata has been generated/updated by a pre-commit hook
+    - name: "Validate AppStream metadata"
+      run: appstreamcli validate res/linux/org.mixxx.Mixxx.metainfo.xml

.gitignore

@@ -26,7 +26,7 @@ compile_commands.json
 /CMakeSettings*.json
 
 # Build and distribution directories for various build configurations
-/build
+/build*
 /install
 
 # Exclude unneeded files from GoogleTest library when updating our bundled

.markdownlint-cli2.yaml

@@ -0,0 +1,38 @@
+#
+# An example .markdownlint-cli2.yaml file
+#
+
+# Disable some built-in rules
+config:
+  default: true
+
+  # The same headline in different nested sections is okay (and necessary for
+  # CHANGELOG.md).
+  no-duplicate-header:
+    allow_different_nesting: true
+
+  # We use ordered lists to make stuff easier to read in a text editor.
+  ol-prefix:
+    style: ordered
+
+  # Not wrapping long lines makes diffs easier to read, especially for prose.
+  # Instead, we should follow the "one sentence per line" pattern.
+  line-length: false
+
+  # Dollar signs are useful to indicate shell commands/type and help
+  # distinguishing wrapped lines from new commands.
+  commands-show-output: false
+
+  # Indented code blocks are easier to read in a text editor, but don't allow
+  # specifying a language for syntax highlighting. Therefore both indented and
+  # fenced code block should be allowed depending on the use case.
+  code-block-style: false
+
+# Fix any fixable errors
+fix: true
+
+# Disable inline config comments
+noInlineConfig: true
+
+# Disable progress on stdout (only valid at root)
+noProgress: true