Merge remote-tracking branch 'hc/main'

Author: KentoNishi

.eslintignore

@@ -1,4 +1,5 @@
 module.exports = {
+  root: true,
   env: {
     browser: true,
     es6: true,
@@ -22,42 +23,41 @@ module.exports = {
       processor: 'svelte3/svelte3',
       rules: {
         'import/first': 'off',
-        'import/no-duplicates': 'off',
-        'import/no-mutable-exports': 'off',
         'no-multiple-empty-lines': [
           'error',
           { max: 2 }
         ],
-        '@typescript-eslint/prefer-nullish-coalescing': 'off',
         // Causes false positives with reactive and auto subscriptions
         '@typescript-eslint/strict-boolean-expressions': 'off',
         'no-sequences': 'off',
-        'no-unused-expressions': 'off',
+        'svelte/missing-declaration': "off",
       }
     }
   ],
   rules: {
+    // TODO: probably want to enable some of these
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-confusing-void-expression': 'off',
+    '@typescript-eslint/no-floating-promises': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-unused-expressions': 'off',
+
     'linebreak-style': [
       'error',
       'unix'
     ],
-    semi: 'off',
     '@typescript-eslint/semi': [
       'error',
       'always'
     ],
-    'no-extra-semi': 'off',
     '@typescript-eslint/no-extra-semi': 'error',
-    '@typescript-eslint/no-floating-promises': 'off',
-    'no-unused-vars': 'off',
     '@typescript-eslint/no-unused-vars': [
       'error',
       {
         varsIgnorePattern: '^_',
         argsIgnorePattern: '^_'
       }
     ],
-    'space-before-function-paren': 'off',
     '@typescript-eslint/space-before-function-paren': [
       'error',
       {
@@ -97,7 +97,18 @@ module.exports = {
   globals: {
     Ytc: 'readonly',
     Chat: 'readonly',
-    YtcF: 'readonly'
+    YtcF: 'readonly',
+    'svelte3/typescript': () => require('typescript'),
+    'svelte3/ignore-warnings': (warning) => {
+      if (warning.code === 'a11y-click-events-have-key-events') {
+        return true;
+      }
+
+      if (warning.code === 'missing-declaration' && warning.message === "'__VERSION__' is not defined") {
+        return true;
+      }
+
+      return false;
+    },
   },
-  root: true
 };

.eslintrc.js

@@ -3,6 +3,10 @@ on:
   push:
   pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -14,10 +18,8 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '22'
-          cache: 'yarn'
-
-      - name: Install modules
-        run: yarn
 
-      - name: Build
-        run: yarn build
+      - run: |
+          npm install
+          npm run lint:check
+          npm run build

.github/workflows/build.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   analyze:

.github/workflows/codeql-analysis.yml

@@ -18,22 +18,15 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '22'
-          cache: 'yarn'
 
-      - name: Install modules
-        run: |
-          sudo apt install jq
-          yarn
-          VERSION=$(echo -n "${{ github.ref }}" | sed 's/[refs\/tagv]//g' | sed 's/-.*//')
-          jq --arg version $VERSION '.version = $version' src/manifest.json > src/manifest.json.tmp
-          mv src/manifest.json.tmp src/manifest.json
+      - run: |
+          npm install
+          npm run lint:check
 
-      - name: Build Chrome
-        run: |
           # Extract version number from the tag
           VERSION=$(echo -n "${{ github.ref }}" | sed 's/[refs\/tagv]//g' | sed 's/-.*//')
-          yarn build:chrome
-          yarn package
+
+          npm run build
 
       - name: Upload Chrome package to release
         uses: svenstaro/upload-release-action@v2
@@ -44,13 +37,6 @@ jobs:
           tag: ${{ github.ref }}
           overwrite: true
 
-      - name: Build Firefox
-        run: |
-          # Extract version number from the tag
-          VERSION=$(echo -n "${{ github.ref }}" | sed 's/[refs\/tagv]//g' | sed 's/-.*//')
-          yarn build:firefox
-          yarn package
-
       - name: Upload Firefox package to release
         uses: svenstaro/upload-release-action@v2
         with:

.github/workflows/release.yml

@@ -1,18 +1,15 @@
 .DS_Store
 node_modules
 build
-dist
 package-lock.json
+.eslintcache
 
 # local env files
 .env.local
 .env.*.local
 
 # Log files
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
 
 # Editor directories and files
 .idea
@@ -22,10 +19,3 @@ pnpm-debug.log*
 *.njsproj
 *.sln
 *.sw?
-
-# Vue Browser Extension Output
-*.pem
-*.pub
-*.zip
-artifacts
-.eslintcache

.gitignore

@@ -1,10 +1,8 @@
 # YtcFilter | YouTube Chat Filter 
 <!-- 
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
-[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/standard/semistandard)
 [![Contributors](https://img.shields.io/github/contributors/LiveTL/HyperChat)](https://github.com/LiveTL/HyperChat/contributors)
 [![Issues](https://img.shields.io/github/issues/LiveTL/HyperChat)](https://github.com/LiveTL/HyperChat/issues)
-![Total Lines](https://img.shields.io/tokei/lines/github/LiveTL/HyperChat)
 ![Size](https://img.shields.io/github/repo-size/LiveTL/HyperChat)
 [![Commit Activity](https://img.shields.io/github/commit-activity/w/LiveTL/HyperChat)](https://github.com/LiveTL/HyperChat/commits/)
 [![Discord](https://img.shields.io/discord/780938154437640232.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/uJrV3tmthg) -->
@@ -16,11 +14,19 @@
 
 Release packages are also available [on GitHub](https://github.com/LiveTL/ytcfilter/releases).
 
+
+<!-- ## Install
+
+HyperChat is available in the Chrome and Firefox stores.
+
+See https://livetl.app/hyperchat/install -->
+
+
 ## Building from Source
 
-<!-- ### ⚠️ WARNING ⚠️
+<!-- ### ⚠️ WARNING ⚠️ -->
 
-Due to unreliable Manifest v3 feature support in Firefox, we maintain both MV2 and MV3 versions of HyperChat in parallel. The MV2 variant sits in the `master` branch, while the MV3 variant sits on the `mv3` branch. When contributing, please ensure that you check out to the `master` branch to implement the features in MV2 first. Once the feature is stable, please open a separate PR to the `mv3` branch to port the feature to MV3. -->
+For legacy reasons, we have a `mv2` branch used by [the LiveTL extension](https://github.com/LiveTL/LiveTL)'s Manifest V2 Firefox variant, while the `main` branch houses the main Manifest V3 version that's published to stores.
 
 ### Development
 
@@ -39,17 +45,26 @@ cd ytcfilter
 yarn # install dependencies
 ```
 
-Build or serve the extension:
+Serve the extension for local development:
 
 ```bash
-yarn dev:firefox # devserver for firefox extension
-yarn dev:chrome # devserver for chrome extension
-yarn start # alias to yarn dev:chrome for backwards compat
-yarn start:none # alias to yarn dev:chrome for backwards compat
-yarn start:firefox # devserver + open extension in firefox
-yarn start:chrome # devserver + open extension in chrome
-yarn build # production mode (chrome)
-yarn build:chrome # production mode (chrome)
-yarn build:firefox # production mode (firefox)
-VERSION=x.x.x yarn build
+npm run dev:chrome    # devserver for Chrome extension
+npm run dev:firefox   # devserver for Firefox extension
+
+npm run start:chrome  # devserver + open extension in Chrome
+npm run start:firefox # devserver + open extension in Firefox
 ```
+
+### Building for Production
+
+Our build script is [an automated GitHub action](.github/workflows/release.yml), where `${{ github.ref }}` should evaluate to a tag in the format `vX.Y.Z` (where `X.Y.Z` is the version number).
+
+To simulate the build:
+
+```bash
+VERSION=X.Y.Z npm run build         # Chrome & Firefox
+VERSION=X.Y.Z npm run build:chrome  # just Chrome
+VERSION=X.Y.Z npm run build:firefox # just Firefox
+```
+
+The built ZIP files can be found in the `build` directory.