From ee2e82866e9b4d8b7220d457cf0f6e13dac14d60 Mon Sep 17 00:00:00 2001 From: eXhumer Date: Tue, 23 Jul 2024 11:26:21 -0600 Subject: [PATCH] chore: Add information regarding dependency version locks due to compatibility Signed-off-by: eXhumer --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 11f4104..8f7c987 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,13 @@ * [CastLabs' Electron](https://github.com/castlabs/electron-releases) which allows Widevine protected stream playback. * [robvdpol's RaceControl](https://github.com/robvdpol/RaceControl) which provided an open-source desktop client for F1TV content streaming before F1TV used Widevine DRM. +## Dependency version notes +Some dependencies are locked to specific versions due to compatibility issues caused due to the newer versions. + +* `eslint` is locked to `^8.57.0` due to `@typescript-eslint/eslint-plugin`, `@typescript-eslint/parser` & `eslint-plugin-import` not being available for major version 9 yet. [`@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser` have released beta version `rc-v8` to add support for ESLint 9](https://typescript-eslint.io/blog/announcing-typescript-eslint-v8-beta/#as-an-existing-user), however [`eslint-plugin-import` has no support for ESLint 9 yet](https://github.com/import-js/eslint-plugin-import/pull/2996). +* `@vercel/webpack-asset-relocator-loader` is locked to [`1.7.3` due to Electron Forge](https://github.com/electron/forge/issues/3600) +* `sass` is locked to [`1.77.6` due to breaking changes with mixed declarations](https://sass-lang.com/documentation/breaking-changes/mixed-decls/). `1.77.7` & above shows warning regarding this while launching in development mode due to loading SCSS from packages `bootstrap` & `bitmovin-player-ui`. + ## License This package is licensed under the AGPL-3.0-only License. See the [LICENSE](LICENSE.md) file for more information.