Conversation
Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add JSDoc comments for module-level constants in background.js
docs: add JSDoc to undocumented module-level constants in background.js
Mar 11, 2026
ormidales
approved these changes
Mar 11, 2026
3 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves readability of the extension’s background script by adding clarifying JSDoc/comments around request tracking, storage keys, and Accept-Language defaults, plus a minor constant formatting tweak.
Changes:
- Added JSDoc/type annotations and explanatory comments for key globals (
initialHostByRequest,exceptionDomains, etc.). - Clarified constant intent (TTL meaning, storage key purpose, Accept-Language fallback).
- Reformatted the TTL constant to use numeric separators (
60 * 1_000).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The six module-level constants at the top of
background.jshad no documentation, forcing developers to infer purpose, units, and impact from usage context alone — increasing misconfiguration risk.Changes
initialHostByRequest— multi-line JSDoc with@type {Map<string, {host: string, trackedAt: number}>}and lifecycle notes (cleared on completion, error, or TTL expiry)MAX_TRACKED_REQUESTS— inline doc noting LRU eviction triggerREQUEST_TRACK_TTL_MS— inline doc with explicit millisecond unit;1000→1_000for readabilitySTORAGE_KEY— inline doc identifying thebrowser.storage.synckeyexceptionDomains— multi-line JSDoc with@type {Set<string>}, startup population, andstorage.onChangedsyncDEFAULT_ACCEPT_LANGUAGE— multi-line JSDoc noting fallback role and RFC 4647 syntaxAll comments follow the existing style established by
ACCEPT_LANGUAGE_BY_TLD(no dash in@param, consistent block formatting).Original prompt
background.jslack JSDoc comments #142💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.