Merge pull request #1524 from dermotduffy/dev

Merge `dev` back to `main` in advance of release

.devcontainer/Dockerfile

@@ -7,3 +7,5 @@ ARG HOME="/home/vscode"
 ENV VOLTA_HOME="${HOME}/.volta"
 ENV PATH="${VOLTA_HOME}/bin:${PATH}"
 RUN bash -c "$(curl -fsSL https://get.volta.sh)" -- --skip-setup
+
+CMD ["sleep", "infinity"]

.devcontainer/devcontainer.json

@@ -1,15 +1,16 @@
 // See https://aka.ms/vscode-remote/devcontainer.json for format details.
 {
   "dockerComposeFile": "../docker-compose.yml",
-  "service": "dev",
+  "service": "devcontainer",
   "features": {
     "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {
-      "moby": false,
-      "dockerDashComposeVersion": "v2"
+      "moby": false
     }
   },
+  "updateRemoteUserUID": true,
   "workspaceFolder": "${localWorkspaceFolder}",
-  "shutdownAction": "stopCompose",
+  "initializeCommand": [".devcontainer/initialize.sh"],
+  "postCreateCommand": ["yarn", "install"],
   "forwardPorts": [10001, "hass:8123", "frigate:5000"],
   "portsAttributes": {
     "10001": {
@@ -25,8 +26,6 @@
       "onAutoForward": "silent"
     }
   },
-  "initializeCommand": ".devcontainer/initialize.sh",
-  "postCreateCommand": "yarn install",
   "customizations": {
     "vscode": {
       "extensions": [
@@ -39,9 +38,12 @@
         "davidanson.vscode-markdownlint",
         "redhat.vscode-yaml",
         "lokalise.i18n-ally",
+        "vitest.explorer",
+        "inlang.vs-code-extension",
         "ms-azuretools.vscode-docker"
       ],
       "settings": {
+        "task.allowAutomaticTasks": "on",
         "files.eol": "\n",
         "editor.tabSize": 2,
         "editor.formatOnPaste": false,

.eslintrc.cjs

@@ -1,14 +1,15 @@
 module.exports = {
-    parser: "@typescript-eslint/parser", // Specifies the ESLint parser
-    parserOptions: {
-        ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
-        sourceType: "module" // Allows for the use of imports
-    },
-    extends: [
-        "plugin:@typescript-eslint/recommended" // Uses the recommended rules from the @typescript-eslint/eslint-plugin
-    ],
-    rules: {
-        // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
-        // e.g. "@typescript-eslint/explicit-function-return-type": "off",
-    }
-};
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+  },
+  extends: [
+    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'prettier', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
+  ],
+  rules: {
+    // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
+    // e.g. "@typescript-eslint/explicit-function-return-type": "off",
+  },
+};

.github/dependabot.yml

@@ -1,8 +1,8 @@
-version: 2
-
-updates:
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: daily
-    target-branch: "dev"
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: 'dev'

.github/release-drafter.yml

@@ -1,29 +1,29 @@
 ---
 categories:
-  - title: ":boom: Breaking Changes"
-    label: "breaking"
-  - title: ":rocket: Features"
-    label: "enhancement"
-  - title: ":fire: Removals and Deprecations"
-    label: "removal"
-  - title: ":bug: Fixes"
-    label: "bug"
-  - title: ":racehorse: Performance"
-    label: "performance"
-  - title: ":rotating_light: Testing"
-    label: "testing"
-  - title: ":construction_worker: Continuous Integration"
-    label: "ci"
-  - title: ":books: Documentation"
-    label: "documentation"
-  - title: ":hammer: Refactoring"
-    label: "refactoring"
-  - title: ":lipstick: Style"
-    label: "style"
-  - title: ":package: Dependencies"
+  - title: ':boom: Breaking Changes'
+    label: 'breaking'
+  - title: ':rocket: Features'
+    label: 'enhancement'
+  - title: ':fire: Removals and Deprecations'
+    label: 'removal'
+  - title: ':bug: Fixes'
+    label: 'bug'
+  - title: ':racehorse: Performance'
+    label: 'performance'
+  - title: ':rotating_light: Testing'
+    label: 'testing'
+  - title: ':construction_worker: Continuous Integration'
+    label: 'ci'
+  - title: ':books: Documentation'
+    label: 'documentation'
+  - title: ':hammer: Refactoring'
+    label: 'refactoring'
+  - title: ':lipstick: Style'
+    label: 'style'
+  - title: ':package: Dependencies'
     labels:
-      - "dependencies"
-      - "build"
+      - 'dependencies'
+      - 'build'
 template: |
   ## Changes
 

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
       - dev
   pull_request:
   schedule:
-    - cron: "17 6 * * *"
+    - cron: '17 6 * * *'
   workflow_dispatch:
 
 jobs:
@@ -17,31 +17,48 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node and Yarn
         uses: volta-cli/action@v4
 
       - name: Install dependencies
         run: yarn install --immutable
 
+      - name: Lint
+        run: yarn run lint
+
+      - name: Check formatting
+        run: yarn run format-check
+
+      - name: Test & Coverage
+        run: yarn run coverage
+
       - name: Build
         run: yarn run build
 
-      - name: Test
-        run: yarn run test
-
       - name: HACS build validation
-        uses: "hacs/[email protected]"
+        uses: 'hacs/[email protected]'
         with:
-          category: "plugin"
+          category: 'plugin'
 
           # Don't attempt to load into HACS (as it loads the release, not the
           # build).
-          ignore: "hacs"
+          ignore: 'hacs'
+
+      - name: Verify docs links
+        run: yarn run docs-check-links
 
-      - name: Upload artifact
-        uses: actions/upload-artifact@v3
+      - name: Upload javascript
+        uses: actions/upload-artifact@v4
         with:
           name: frigate-hass-card
           path: dist/*.js
+
+      # When this issue is fixed, it would be useful to upload visualizations:
+      # https://github.com/actions/upload-artifact/issues/14
+      # - name: Upload visualizations
+      #   uses: actions/upload-artifact@v4
+      #   with:
+      #     name: frigate-hass-card
+      #     path: visualizations/*.html

.github/workflows/labeler.yml

@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v4.1.0
+        uses: crazy-max/ghaction-github-labeler@v5.0.0
         with:
           skip-delete: true

.github/workflows/release-drafter.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Run release-drafter
-        uses: release-drafter/release-drafter@v5.23.0
+        uses: release-drafter/release-drafter@v6.0.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node and Yarn
         uses: volta-cli/action@v4
@@ -24,14 +24,14 @@ jobs:
         run: yarn run build
 
       - name: Zip the files
-        uses: thedoctor0/[email protected].1
+        uses: thedoctor0/[email protected].6
         with:
           type: zip
           path: dist
           filename: frigate-hass-card.zip
 
       - name: Upload JS files to release
-        uses: svenstaro/upload-release-action@2.6.1
+        uses: svenstaro/upload-release-action@2.9.0
 
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
@@ -41,7 +41,7 @@ jobs:
           overwrite: true
 
       - name: Upload Zip file to release
-        uses: svenstaro/upload-release-action@2.6.1
+        uses: svenstaro/upload-release-action@2.9.0
 
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,7 +6,7 @@ package-lock.json
 .env
 .envrc
 
-stats.html
+/visualizations/
 /coverage/
 
 # https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored

.prettierignore

@@ -0,0 +1,2 @@
+docs/js/
+.devcontainer/

.vscode/extensions.json

@@ -8,8 +8,8 @@
     "runem.lit-plugin",
     "davidanson.vscode-markdownlint",
     "redhat.vscode-yaml",
-    // "lokalise.i18n-ally",
-    "zixuanchen.vitest-explorer",
-    "inlang.vs-code-extension" // improved i18n DX
+    "lokalise.i18n-ally",
+    "vitest.explorer",
+    "inlang.vs-code-extension"
   ]
 }

.vscode/i18n-ally-custom-framework.yml

@@ -12,14 +12,12 @@ usageMatchRegex:
   # you can ignore it and use your own matching rules as well
   - "[^\\w\\d]localize\\(['\"`]({key})['\"`]"
 
-
 # An array of strings containing refactor templates.
 # The "$1" will be replaced by the keypath specified.
 # Optional: uncomment the following two lines to use
 
 # refactorTemplates:
 #  - i18n.get("$1")
 
-
 # If set to true, only enables this custom framework (will disable all built-in frameworks)
 monopoly: true

.vscode/settings.json

@@ -4,6 +4,5 @@
   "i18n-ally.sortKeys": true,
   "i18n-ally.keepFulfilled": true,
   "i18n-ally.editor.preferEditor": true,
-  "i18n-ally.translate.saveAsCandidates": true,
-  "vitest.commandLine": "npx vitest --root ."
+  "i18n-ally.translate.saveAsCandidates": true
 }

.vscode/tasks.json

@@ -20,7 +20,10 @@
           "endsPattern": "^created"
         }
       },
-      "isBackground": true
+      "isBackground": true,
+      "runOptions": {
+        "runOn": "folderOpen"
+      }
     }
   ]
 }

.yarn/patches/README.md

@@ -0,0 +1,7 @@
+# Patches
+
+## `sass`
+
+`sass` is patched to avoid printing out a noisy deprecation notice on every
+build. `sass` is imported by `rollup-plugin-styler`, in a way that triggers this
+message. The patch simply prevents this console spam.

.yarn/patches/sass-npm-1.77.4-13b6910aea.patch

@@ -0,0 +1,13 @@
+diff --git a/sass.node.mjs b/sass.node.mjs
+index f59a3d8987162a3cbc9787c34f67186fb0f09186..b154f46118ccc03989b9a1c11309954c85515539 100644
+--- a/sass.node.mjs
++++ b/sass.node.mjs
+@@ -40,7 +40,7 @@ export const NodePackageImporter = cjs.NodePackageImporter;
+ export const deprecations = cjs.deprecations;
+ export const Version = cjs.Version;
+
+-let printedDefaultExportDeprecation = false;
++let printedDefaultExportDeprecation = true;
+ function defaultExportDeprecation() {
+   if (printedDefaultExportDeprecation) return;
+   printedDefaultExportDeprecation = true;