fregante / browser-extension-template Goto Github PK

There is a limitation of workflow: An action in a workflow run can't trigger a new workflow run.

I would suggest you use your own PAT when creating tags. You can store your PAT in secrets and use ${{ secrets.PATNAME } in your actions.

env:
  GITHUB_TOKEN: ${{ secrets.PATNAME }}

From: https://github.community/t5/GitHub-Actions/Github-actions-workflow-not-triggering-with-tag-push/m-p/39772#M3959

You can see this in Refined GitHub’s Actions. "Auto-tagger" ran but "Deployment" didn't follow it. Now I had to re-create the tag

I think this only needs to be updated with instructions to use a custom personal token instead of the provided one.

Hello!

Thank you so much for this project, it has been a boon while developing my first web extension. ❤️

While setting up a new repository from the template, I've noticed that the "Release" workflow needs write permissions to the repository for git push, but its need is not documented anywhere. Specifically, the following setting needs toggleing:

The default is: "Read repository contents and packages permissions"

Hey! Thanks for the sweet boilerplate! Its been working really well so far.

Just letting you know that I was rejected from CWS using this boilerplate yesterday for obfuscated code.

Hi there,

We regret to inform you that the most recent submission of your item was rejected. Please find the details below.

Item name: Snippets

Item ID: eoeooehafnjjbkbnlbgfimnjchmadbap

Violation(s):

Code Readability Requirements

Violation reference ID: Red Titanium
Violation: Having obfuscated code in the package.
Violating content:
Code snippet: options.c1ff580f.js:null:null: function $56fca9218aa06700$var$isCurrentPathname(path) {...
How to rectify: Replace the obfuscated code with human-readable code and resubmit the item.
Relevant section of the program policy:
Developers must not obfuscate code or conceal functionality of their extension. (learn more)

I had seen this issue you submitted parcel-bundler/parcel#6092

I didnt have any luck applying your suggestions. However, Im pending another review with --no-scope-hoist which seems to have removed the hexi from all the functions. Ill see if that works and report back...

Filing an issue incase others run into the same thing from CWS.

Currently, the repository description found in the About section on the right sidebar still reads:

📕 Barebones boilerplate with webpack, options handler and auto-publishing

I suggest changing this to reflect that the template uses parcel now. Thanks!

Hey, many thanks for the template, it's a very nice learning resource :)

What we are struggling with is having folders inside the /src directory, e.g. having a /src/options folder for all the options-related files. Is this possible?

I guess the title is trivial,
📕 Barebones boilerplate with webpack, options handler, and auto-publishing
to
📕 Barebones boilerplate with parcel, options handler, and auto-publishing
and I posted a question in here I would be glad if sb read that and tell me can this repo help me out with that or not.

It looks like @parcel/config-webextension does not cover chrome.scripting API.

What if I need to inject scripts and styles dynamically like in the code below?

chrome.scripting
    .executeScript({
      target : {tabId},
      files : [ "checker/index.js" ],
    })

chrome.scripting
    .insertCSS({
      target : {tabId},
      files : [ "checker/index.css" ],
    })

Following #44

• Don't minify the CSS
• include webext-base-css via @import 'webext-base-css';
• Flat output parcel-bundler/parcel#5858
• Somehow extract webext-options-sync to its own "vendor" entry so it's not bundled 3 times separately parcel-bundler/parcel#5859
• Automatically include the browser global

The last one is feasible via:

https://github.com/pixiebrix/webext-messenger/blob/35961df965d1a75da941187ddcb67acdaeb82aec/test/demo-extension/manifest.json#L7

And

https://github.com/pixiebrix/webext-messenger/blob/35961df965d1a75da941187ddcb67acdaeb82aec/.parcelrc#L4-L9

Related to refined-github/refined-github#14.

Instructions for converting browser extension on Apple developer documentation mentions that anyone can convert extension and basically sideload it into Safari.

I do not yet know how Apple intends to publish their extensions (maybe through App Store). Also I do not have an Apple developer account, even if I did, I'm sure that Apple would not want this extension on their store, even for testing.

Opening this issue to explore options on automating publishing (to App Store?), document any additional setup instructions on doing the same.

/cc @fregante.

Sometimes deployments fail and nobody notices. There are 2 ways to make them more visible:

• use GitHub deployments, somehow, they appear in their own section on GitHub
• include a badge somewhere in the readme

Travis should be enabled so the linting is applied to this template, to ensure that the code works.

You could even set up the extension and publish it "privately" (unlisted) on the stores, to ensure that everything works.

Using the default "watch" task and editing & saving CSS files works perfectly, except it cramms files in the /distribution directory as such

The default template is throwing this error SyntaxError: import declarations may only appear at top level of a module when attempting to access a page that should trigger the content.js script. Upon searching a bit, I found that the issue was a limitation of the files that can be included through content_scripts due to needing the type="module" attribute needing to be set on the script https://stackoverflow.com/questions/48104433/how-to-import-es6-modules-in-content-script-for-chrome-extension. Is there a version of this template that has this working properly? Does a transpolar need to be configured in order to maintain syntax when dealing with content?

It would be great to be able to config parcel to also compile other files in the "/source"-dir such as other used .html/.js files

In this example would be redirect.html and redirect.js but they are not compiled to /distribution, only the main files (options.../background...)

This workflow creates a version and then attempts to submit it all at once: https://github.com/fregante/ghatemplates/blob/main/webext/release.yml

It should probably take workflow_dispatch parameter to:

• use the latest release instead of creating a new one
• submit only to a specific store

Hello, I've found this template github repository through the MDN Web Docs :)

When I tried generating a project and viewing it under "Load Unpacked" under the Google Chrome extensions, I see the following error

Context, discussion and some code available in refined-github/refined-github#3545

Rather than defaulting to <all_urls>, which may cause the extension to get rejected by the Chrome Web Store anyway, if possible we should default to the usual block explorers etc. while ensuring that the user can also apply it to any other site they want.

If I add console.log('foo'); to my content.ts, I see:

but clicking on the content.js:159 reveals a transpiled file rather than the original content.js. This is presumably related to the warning immediately below it, which states that the content.js.map source map could not be loaded. But why not? What's the cause of the ERR_BLOCKED_BY_CLIENT, and can we fix it in the extension config?

I trawled the internet for answers, but it's full of useless suggestions, such as disabling source maps or removing the browser extension which causes the error. Belatedly I found https://parceljs.org/recipes/web-extension/#hmr which says

Source maps don't work unless inlined in web extensions

It doesn't explain why they don't work unless inlined, so I'm guessing it's a fundamental browser thing, e.g. a security restriction on extensions.

But anyway, I added this to package.json:

    "targets": {
        "webext-dev": {
            "sourceMap": {
                "inline": true,
                "inlineSources": true
            }
        },
        "webext-prod": {}
    },

and also modified the build and watch scripts to include --target webext-prod and --target webext-dev respectively.

However this didn't seem to work until I eventually noticed that this actually changes the location of the generated content.js from distribution/ to distribution/webext-dev, which means that the web-ext run command needs an extra option -s distribution/webext-dev. And indeed distribution/webext-dev/content.js does have a source map inlined at the end of the file, and this not only gets rid of the ERR_BLOCKED_BY_CLIENT message, but gives correct mappings back to the true original source files.

If the above enhancement makes sense to you, I would propose including it so that source maps work by default. It works for Typescript too.

BTW, even after all that, the results do not seem perfect. For example, here's a stack trace from my extension:

You can see that there are still references to content.js as well as the references to .ts files. But perhaps that's because there are extra stack frames generated by the transpilation whose source code simply doesn't exist in the original Typescript. So I guess I can't complain about those too much.

Firefox doesn't yet support Manifest v3 background workers (update March 2023)_ but this build works exclusively on that. You can use this issue to discuss alternative methods of supporting both Firefox and Chrome.

Refer to these links for official MV3 support in Firefox:

• latest update: https://blog.mozilla.org/addons/2022/05/18/manifest-v3-in-firefox-recap-next-steps/

• provisional migration guide: https://extensionworkshop.com/documentation/develop/manifest-v3-migration-guide/

• tracking bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1578284

• complete roadmap: https://bugzilla.mozilla.org/showdependencytree.cgi?id=1578284&hide_resolved=1

ca17fe4 (#44) can now be reverted wholly, it just needs to be tested.

Add support to auto-release extension on Git tags and use that Git tag as version.

If I follow the instructions for converting to TypeScript (including using @sindresorhus/tsconfig), npm run lint results in a load of errors:

  source/content.ts:4:8
  ✖   4:8   Unsafe assignment of an any value.                                                                                                                                 @typescript-eslint/no-unsafe-assignment
  ✖   4:24  Unsafe call of an any typed value.                                                                                                                                 @typescript-eslint/no-unsafe-call
  ✖   5:16  Operands of + operation with any is possible only with string, number, bigint or any                                                                               @typescript-eslint/restrict-plus-operands
  ✖   5:16  Operands of + operation with any is possible only with string, number, bigint or any                                                                               @typescript-eslint/restrict-plus-operands
  ✖   5:16  Operands of + operation with any is possible only with string, number, bigint or any                                                                               @typescript-eslint/restrict-plus-operands
  ✖   6:8   Unsafe assignment of an any value.                                                                                                                                 @typescript-eslint/no-unsafe-assignment
  ✖   8:2   Unsafe assignment of an any value.                                                                                                                                 @typescript-eslint/no-unsafe-assignment
  ✖  15:1   Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the void operator.  @typescript-eslint/no-floating-promises

  source/options.ts:2:8
  ✖   2:8   browser is defined but never used.                                                                                                                                 @typescript-eslint/no-unused-vars
  ✖   6:1   Unsafe call of an any typed value.                                                                                                                                 @typescript-eslint/no-unsafe-call
  ✖  13:40  Invalid type "any" of template literal expression.                                                                                                                 @typescript-eslint/restrict-template-expressions
  ✖  13:65  Invalid type "any" of template literal expression.                                                                                                                 @typescript-eslint/restrict-template-expressions
  ✖  13:90  Invalid type "any" of template literal expression.                                                                                                                 @typescript-eslint/restrict-template-expressions
  ✖  17:2   Unsafe assignment of an any value.                                                                                                                                 @typescript-eslint/no-unsafe-assignment

  source/options-storage.ts:undefined:undefined
  ✖   0:0   Parsing error: File @sindresorhus/tsconfig/tsconfig.json not found.                                                                                                

  15 errors
ERROR: "lint:js" exited with 1.

Some of these are trivial to fix, but I'm struggling to figure out how to address @typescript-eslint/no-unsafe-assignment and eslint/no-unsafe-call other than disabling those rules. BTW I notice those are similar to the title of issue #69.

One very odd error is the last one (Parsing error: File @sindresorhus/tsconfig/tsconfig.json not found). I have no idea what's going on here. Even weirder - I thought I'd accidentally fixed it by changing xo.envs in package.json from browser to webextensions (which seems to be a more logical choice anyway, right?) ... But then when I changed it back to browser, the parsing error didn't come back. 🤷‍♂️

Anyway, you should be able to reproduce the exact list of errors above via this branch in my fork:

main...aspiers:typescript

MIT means that users will have to include your license file:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

But you don't have one. Perhaps this could use WTFPL or CC0 instead.

https://tldrlegal.com/license/do-wtf-you-want-to-public-license-v2-(wtfpl-2.0)
https://tldrlegal.com/license/creative-commons-cc0-1.0-universal

Seems many (most?) browser extensions include a "popup" i.e. a small panel that appears when the icon is clicked:

I don't see mention of this browsing the code of this repo. Have you considered providing this by default or making it an option?

In most extensions I've browsed the code of I see popup.css and popup.html (example).

When I make a change to a content script, I need to restart $ web-ext run -t chromium to see the changes.

repro repo
https://github.com/goldylucks/web-ext-reload-not-working

Thanks again for this project

https://stackoverflow.com/a/77463012/288906

See linked bugs in:

https://stackoverflow.com/a/62270410/288906

Currently I think sourcemaps are inlined, which bloat the bundles during development and slow loading down.

There have been a few issues regarding TypeScript, I think it makes sense to either add a conversion script to properly test it or at least add more information about what that entails.

With https://github.com/notlmn/release-with-changelog

Follows fregante/release-with-changelog#3 or refined-github/refined-github#3421

I cloned the repo, ran npm i, then npm run watch, and it exits with this error:

CopyPlugin Invalid Options

options.0 should be string
options.0.ignore should be array
options.0 should match some schema in anyOf

It's not clear what it's validating or what the steps to resolve this would be.

@notlmn Could you follow the instructions in the failed action? The new terms must be approved.

Dear Maintainer(s),

I've got the following error trying to build the extension:

$ npm run build

> build
> parcel build source/manifest.json --no-content-hash --no-source-maps --dist-dir distribution --no-cache --detailed-report 0

🚨 Build failed.
@parcel/transformer-js: Browser scripts cannot have imports or exports. Use a <script type="module"> instead.
/Volumes/Dev/ProBrain/BrowserExtensionTemplate/source/options.js:4:1
  3 | 
> 4 | import optionsStorage from './options-storage.js';
>   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  5 | 
  6 | optionsStorage.syncForm('#options-form');
@parcel/transformer-js: The environment was originally created here:
/Volumes/Dev/ProBrain/BrowserExtensionTemplate/source/options.html:31:1
  30 | 
> 31 | <script src="options.js"></script>
>    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  32 | 

I thought I probably doing something wrong and made a GitHub clone but clicking "Use this template" button as README.md recommends, but got the same issue.

What am I doing wrong?

I'm getting this linting error in options-storage.ts. I want to use typescript and I just changed the files extensions to .ts like indicated. I also added @sindresorhus/tsconfig and eslint-config-xo-typescript. It's strange because if I hover over the error I get the type information. And if I assign the result of the call to new OptionsSync({...}) to a variable and I hover over it I get the type information:

const options: OptionsSync<{
    colorRed: number;
    colorGreen: number;
    colorBlue: number;
    text: string;
}>

I don't know why it keeps saying that it is of type any

Hello,

Would it be a good idea providing a brief description + example of each script in the package.json file. For example in my case, I'm trying to load the unpacked extension in chrome (after doing npm run watch) but doesn't seem to be working ( Could not load background script 'browser-polyfill.min.js'. Could not load manifest.). Maybe it's not the right way of doing it 🤷‍♂️

Thank you in advance.

I've just started experimenting with browser extensions and came across this from OctoPrint - Open in Bundle Viewer which was based on your template.

Do you have plans to update this template or rather recreate this template for version 3 of the manifest.json?

Chrome Developers - Intro to Manifest v3

Once GitHub Actions comes out of beta it would be interesting to see if it's easier to setup.

https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file

It looks like GitHub Actions also supports cronjob directly in the configuration so no extra steps would be necessary to enable it.

How can I get the files in the folder onboarding/ to be included in the build?

Background

I'm trying to build a an onboarding according this to:
https://extensionworkshop.com/documentation/develop/onboard-upboard-offboard-users/#onboarding

For that I've included this in the background.ts:

const url = browser.runtime.getURL("onboarding/onboarding.html");
await browser.tabs.create({ url });

This works fine if the file is found. But for some reason, parcel build/ parcel watch are not including the onboarding.html file into the distribution/ folder automatically.

I've tried finding a solution in parcel, but the only way I found is a copy. So for now I've worked around that by copy the files manually before the watch:

"copy-onboarding": "xcopy source\\onboarding\\ distribution\\onboarding\\ /y",
"watch": "npm run copy-onboarding && parcel watch source/manifest.json --dist-dir distribution --no-cache --no-hmr"

However that leads to other problems, because now I can't add a onboarding.ts file as it won't be build to onboarding.js and have it's dependencies bundled.

Do you have an idea how to get parcel to include the files?

I just used this template, and the "template cleanup" action failed. Not a big deal obviously, but a potential build improvement nonetheless.

https://github.com/losnappas/firefox-split-view/actions/runs/4562743709/jobs/8050344918

Originally posted by @losnappas in #48 (comment)

I cloned the repo, made no modifications and loaded the extenstion into my browser, by loading it from the /distribution folder manually.
However the icon is greyed out and no default functionality can be seen (like the console output or rgb panel)

GitHub recently add the ability to manually trigger a workflow. This should allow us to have an action handle this trigger in deployment action. This is similar to what Travis calls "Trigger Build" (that we used before to handle on-demand deployments). This feature request would allow us to do the same with GitHub actions.

Read more about this on https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/

Loosely related to request made at RGH: refined-github/refined-github#3113

Don't know if it's an issue in the configuration or in parcel, but doing this doesn't work:

// source/react/OnBoarding/OnBoarding.jsx
import logo from "../../images/logo.png"

export default function OnBoarding() {
  return <img src={logo} className="logo-2" alt="Apollo Logo 2" />
}

it results in this:

however this does work:

const logo = browser.runtime.getURL("../../logo.f18a6316.png")

interestingly, this does work from an html page of the extension which I open upon installation of the extension:

// background.js
import browser from "webextension-polyfill"

browser.runtime.onInstalled.addListener(({ reason }) => {
	if (reason === browser.runtime.OnInstalledReason.INSTALL) {
		browser.tabs.create({
			url: browser.runtime.getURL("on-install/index.html"),
		})
	}
})

// source/on-install/App/App.jsx
import logo from "../../images/logo.png"

export default function OnBoardingApp() {
  return <img src={logo} />
}

my manifest:

{
	"name": "Apollo",
	"version": "0.0.0",
	"description": "An awesome new browser extension",
	"homepage_url": "https://github.com/fregante/browser-extension-template",
	"manifest_version": 2,
	"minimum_chrome_version": "80",
	"applications": {
		"gecko": {
			"id": "[email protected]",
			"strict_min_version": "80.0"
		}
	},
	"icons": {
		"128": "icon.png"
	},
	"permissions": [
		"https://github.com/fregante/browser-extension-template/*",
		"tabs",
		"storage"
	],
	"content_scripts": [
		{
			"matches": [
				"<all_urls>",
				"https://*.zendesk.com/agent*",
				"https://*.zendesk.com/admin*"
			],
			"js": ["content.js"],
			"css": ["content.css"],
			"run_at": "document_end"
		}
	],
	"options_ui": {
		"chrome_style": true,
		"page": "options/options.html"
	},
	"background": {
		"persistent": false,
		"scripts": ["background.js"]
	},
	"web_accessible_resources": [
		"on-install/index.html",
		"logo.*.png",
		"images/logo.png",
		"images/logo.*.png",
		"images/*",
		"images/*.png"
	]
}

any ideas what I'm missing here?

Thanks for the awesome project!! 💜

Hi there, I had few bumps using the Actions. I manage to get around them by commenting stuff, but I though I should mention.

Also, when the addon was published to the Firefox developer hub, it got duplicated, because I had previously uploaded it manually. I imagine there is some instruction missing related to the geck.id?

Hi there,
I wonder how does this template handle the _locales files?

Webpack. Enough said.

https://github.com/notlmn/browser-extension-template/blob/master/webpack.config.js
https://github.com/notlmn/browser-extension-template#configuration

Versus:

https://github.com/tanmayrajani/notifications-preview-github/blob/35accac48e28da78e0a5b86bc45c44c20f5f0d98/package.json#L6-L7

Here's a PR to take inspiration from: https://github.com/tanmayrajani/notifications-preview-github/pull/88/files

Issues:

• Works with Parcel v1, but Parcel 2 doesn't support web extensions the same way yet, but it's not even out yet
• I haven't figured out how to keep the polyfill separate and unchanged, I'm not sure it's possible: https://github.com/notlmn/browser-extension-template/blob/e6a5ae569d931214fc5e822c097ccb011c745a0f/webpack.config.js#L26