Skip to content

Major: port to WXT framework #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
danitt wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Major: port to WXT framework #71

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e865ecb
port to WXT
danitt Aug 28, 2025
6a9c90d
formatting and version
danitt Aug 28, 2025
13affaa
fix lockfile
danitt Aug 28, 2025
9c7d0b3
fix linter config path
danitt Aug 28, 2025
50447f8
add manifest permissions, swap to cross-browser APIs
danitt Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions entrypoints/background.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ import { extractPageImageURL } from '../components/utils';
let lastURL: string | undefined;

export default defineBackground(() => {
console.log('Hello background!', { id: browser.runtime.id });
// Action API is conditionally available based on manifest v2 vs v3
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
const actionAPI = browser.action || browser.browserAction;

// Move message listener setup to top level so it persists through service worker wake/sleep cycles
browser.runtime.onMessage.addListener((request: ScraperMessage, _sender, sendResponse) => {
Expand Down Expand Up @@ -42,23 +44,29 @@ export default defineBackground(() => {
console.error('Error updating page action:', e);
});

browser.declarativeContent.onPageChanged.removeRules(undefined, () => {
browser.declarativeContent.onPageChanged.addRules([
{
conditions: [
...sites.map(
(site) =>
new browser.declarativeContent.PageStateMatcher({
pageUrl: site.readerDomain,
}),
),
],
actions: [new browser.declarativeContent.ShowAction()],
},
]);
browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
if (changeInfo.status === 'complete' && tab.url) {
const url = new URL(tab.url);
const enabledSites = new Set(
sites.map((site) =>
typeof site.readerDomain === 'string'
? site.readerDomain
: site.readerDomain.hostEquals || site.readerDomain.hostContains,
),
);
const shouldShow =
enabledSites.has(url.hostname) ||
Array.from(enabledSites).some((domain) => domain && url.hostname.includes(domain));

if (shouldShow) {
actionAPI.enable(tabId).catch((e) => console.error('Error enabling action', e));
} else {
actionAPI.disable(tabId).catch((e) => console.error('Error disabling action', e));
}
}
});

browser.action.setBadgeBackgroundColor({ color: '#f45752' }).catch((e) => {
actionAPI.setBadgeBackgroundColor({ color: '#f45752' }).catch((e) => {
console.error('Error setting badge background color:', e);
});
});
Expand Down Expand Up @@ -110,7 +118,7 @@ export default defineBackground(() => {
updatePageAction().catch((e) => {
console.error('Error updating page action on tab update:', e);
});
browser.action.setBadgeBackgroundColor({ color: '#f45752' }).catch((e) => {
actionAPI.setBadgeBackgroundColor({ color: '#f45752' }).catch((e) => {
console.error('Error setting badge background color on tab update:', e);
});
}
Expand Down
12 changes: 11 additions & 1 deletion wxt.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,18 @@ export default defineConfig({
__APP_VERSION__: JSON.stringify(version),
},
}),
manifest: () => {
manifest: ({ browser }) => {
const permissions: string[] = ['storage', 'scripting', 'tabs', 'webRequest', 'webRequestBlocking'];
switch (browser) {
case 'chrome':
permissions.push('declarativeContent');
break;
Comment on lines +18 to +20
Copy link
Owner

@janbaykara janbaykara Sep 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this cover other chrome-like browsers? Arc, Zen, etc.

Copy link
Collaborator Author

@danitt danitt Sep 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

afaik yes because they use the same engine

case 'firefox':
permissions.push('declarativeNetRequest');
break;
}
return {
permissions,
host_permissions: sites.map((site) => site.urlScope),
};
},
Expand Down