build: configure oxfmt formatter (#266)

Author: arkon

.eslintrc.js

@@ -4,42 +4,36 @@ module.exports = {
     browser: true,
     es6: true,
     node: true,
-    webextensions: true
+    webextensions: true,
   },
   parser: '@typescript-eslint/parser',
   extends: 'standard-with-typescript',
   parserOptions: {
     sourceType: 'module',
     project: './tsconfig.json',
-    extraFileExtensions: ['.svelte']
+    extraFileExtensions: ['.svelte'],
   },
-  plugins: [
-    'svelte3',
-    '@typescript-eslint'
-  ],
+  plugins: ['svelte3', '@typescript-eslint'],
   overrides: [
     {
       files: ['*.js', 'utils/*.js'],
       rules: {
         '@typescript-eslint/no-var-requires': 'off',
-      }
+      },
     },
     {
       files: ['*.svelte'],
       processor: 'svelte3/svelte3',
       rules: {
         'import/first': 'off',
-        'no-multiple-empty-lines': [
-          'error',
-          { max: 2 }
-        ],
+        'no-multiple-empty-lines': ['error', { max: 2 }],
         // Causes false positives with reactive and auto subscriptions
         '@typescript-eslint/strict-boolean-expressions': 'off',
         '@typescript-eslint/no-unsafe-argument': 'off',
         'no-sequences': 'off',
         'svelte/missing-declaration': 'off',
-      }
-    }
+      },
+    },
   ],
   rules: {
     // TODO: probably want to enable some of these
@@ -49,27 +43,21 @@ module.exports = {
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-unused-expressions': 'off',
 
-    'linebreak-style': [
-      'error',
-      'unix'
-    ],
-    '@typescript-eslint/semi': [
-      'error',
-      'always'
-    ],
+    'linebreak-style': ['error', 'unix'],
+    '@typescript-eslint/semi': ['error', 'always'],
     '@typescript-eslint/no-extra-semi': 'error',
     '@typescript-eslint/no-unused-vars': [
       'error',
       {
         varsIgnorePattern: '^_',
-        argsIgnorePattern: '^_'
-      }
+        argsIgnorePattern: '^_',
+      },
     ],
     '@typescript-eslint/space-before-function-paren': [
       'error',
       {
-        named: 'never'
-      }
+        named: 'never',
+      },
     ],
     '@typescript-eslint/strict-boolean-expressions': [
       'error',
@@ -80,22 +68,22 @@ module.exports = {
         allowNullableBoolean: false,
         allowNullableString: false,
         allowNullableNumber: false,
-        allowAny: true
-      }
+        allowAny: true,
+      },
     ],
     '@typescript-eslint/prefer-nullish-coalescing': [
       'error',
       {
         ignoreConditionalTests: true,
-        ignoreMixedLogicalExpressions: false
-      }
+        ignoreMixedLogicalExpressions: false,
+      },
     ],
     '@typescript-eslint/member-delimiter-style': [
       'error',
       {
         multiline: { delimiter: 'semi', requireLast: true },
-        singleline: { delimiter: 'comma', requireLast: false }
-      }
+        singleline: { delimiter: 'comma', requireLast: false },
+      },
     ],
   },
   settings: {

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,7 +1,7 @@
 name: Bug Report
 description: File a bug report
-title: "[Bug]: "
-labels: ["bug"]
+title: '[Bug]: '
+labels: ['bug']
 body:
   - type: checkboxes
     attributes:
@@ -12,7 +12,7 @@ body:
           required: true
         - label: This issue is not a matter of opinion. If it is, I will use the feature suggestion issue template.
           required: true
-        - label: I have checked for a duplicate or similar issue. I made sure to check closed issues as well. 
+        - label: I have checked for a duplicate or similar issue. I made sure to check closed issues as well.
           required: true
         - label: I am still able to reproduce the issue after I reinstall the extension.
           required: true
@@ -25,7 +25,7 @@ body:
   - type: textarea
     attributes:
       label: Describe the bug
-      description: A clear and concise description of what the bug is. 
+      description: A clear and concise description of what the bug is.
       placeholder: What's wrong?
     validations:
       required: true
@@ -35,12 +35,12 @@ body:
       description: Step-by-step instructions to reproduce the unexpected behavior
       placeholder: |
         1. Go to '...'  
-        
+
         2. Click on '...'  
-        
+
         3. Scroll down to '...'  
-        
-        4. The error looks like '...'  
+
+        4. The error looks like '...'
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/config.yml

@@ -2,4 +2,4 @@ blank_issues_enabled: false
 contact_links:
   - name: LiveTL Discord
     url: https://discord.gg/BVpdvt7weG
-    about: "Not sure how to use the extension? Not sure if something is a bug? Just want to get some simple tech support? Join our discord server and ask your burning questions in the #bug-reports channel."
+    about: 'Not sure how to use the extension? Not sure if something is a bug? Just want to get some simple tech support? Join our discord server and ask your burning questions in the #bug-reports channel.'

.github/ISSUE_TEMPLATE/suggestion.yml

@@ -1,7 +1,7 @@
 name: Feature request
 description: Suggest an idea for HyperChat
-title: "[Feature]: "
-labels: ["enhancement"]
+title: '[Feature]: '
+labels: ['enhancement']
 body:
   - type: checkboxes
     attributes:
@@ -10,7 +10,7 @@ body:
       options:
         - label: This is an issue for Hyperchat, not LiveTL. I will go to [the LiveTL repo](https://github.com/LiveTL/LiveTL) to report an issue for LiveTL.
           required: true
-        - label: I have checked for a duplicate or similar issue. I made sure to check closed issues as well. 
+        - label: I have checked for a duplicate or similar issue. I made sure to check closed issues as well.
           required: true
         - label: I am not reporting a bug. If I am, I will use the bug report issue template.
           required: true

.github/workflows/build.yml

@@ -19,7 +19,14 @@ jobs:
         with:
           node-version: '24'
 
-      - run: |
-          npm ci
-          npm run lint:check
-          npm run build
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint check
+        run: npm run lint:check
+
+      - name: Format check
+        run: npm run format:check
+
+      - name: Build
+        run: npm run build

.github/workflows/codeql-analysis.yml

@@ -9,14 +9,14 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   analyze:
@@ -30,40 +30,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v6
+      - name: Checkout repository
+        uses: actions/checkout@v6
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

AGENTS.md

@@ -42,11 +42,11 @@
 `src/` depends on three bare globals, declared in `src/ts/typings/vite-env.d.ts`
 and supplied by `vite.config.ts` for our own builds:
 
-| Constant | Emitted literal | Meaning |
-| --- | --- | --- |
-| `__BROWSER__` | string — `"chrome"` / `"firefox"` | target browser |
-| `__VERSION__` | string — `"3.3.0"` | version written into the manifest |
-| `__MV__` | **number** — `2` / `3` | target manifest version |
+| Constant      | Emitted literal                   | Meaning                           |
+| ------------- | --------------------------------- | --------------------------------- |
+| `__BROWSER__` | string — `"chrome"` / `"firefox"` | target browser                    |
+| `__VERSION__` | string — `"3.3.0"`                | version written into the manifest |
+| `__MV__`      | **number** — `2` / `3`            | target manifest version           |
 
 `__MV__` is compared with strict equality (`__MV__ === 2`), so it must emit a
 **number literal**. Defining it as the string `"2"` makes every check silently

README.md

@@ -7,14 +7,12 @@
 [![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)
 
-
 ## Install
 
 HyperChat is available in the Chrome and Firefox stores.
 
 See https://livetl.app/hyperchat/install
 
-
 ## Building from Source
 
 ### Build targets

docs/YOUTUBE_ACTIONS.md

@@ -54,7 +54,7 @@ YouTube reorders context menu items. Never assume "block is item 3".
 Instead:
 
 - request `get_item_context_menu`
-- search the response tree for endpoint *types*
+- search the response tree for endpoint _types_
 - prefer endpoint/type checks over label checks
 
 Examples:

oxfmt.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'oxfmt';
+
+export default defineConfig({
+  singleQuote: true,
+  tabWidth: 2,
+  printWidth: 120,
+  experimentalSortImports: {
+    enabled: true,
+    groups: [['side_effect'], ['builtin'], ['external'], ['subpath', 'internal'], ['parent'], ['sibling']],
+  },
+  jsdoc: {
+    preferCodeFences: true,
+    separateReturnsFromParam: true,
+  },
+});