fregante/browser-extension-template

Document the package.json scripts

sangimed opened this issue · 5 comments

sangimed commented

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.

fregante commented

in the package.json file

This is not possible, but documentation can be added to the readme

janmechtel commented

Maybe I can help. Do you mean to explain how/when to use the "npm run watch" "web-ext run" for Chrome and FIrefox in the readme?

fregante commented

Yes, but web-ext only needs a mention because it’s not used here directly and it’s not technically required.

It’d be great to add a “getting started” section to replace “how to use this template”, with all the steps to start, e.g. “use template”, check out newly-created repo, npm install, npm run watch, how to open the extension in the browser (Refined GitHub’s contributing.md) has some text you can copy for this.

Also separately we’d also need a “publishing” section that explains the GitHub Actions setup.

janmechtel commented

(Refined GitHub’s contributing.md) has some text you can copy for this.
what do you mean with this?

I've started on a branch on my fork, please let me know if this should be done differently.

If you can please have a look and:

  1. guide me if you think it should go in a different direction.
  2. have a look at some todos and share knowledge if you have on them

I've taken an opinion and would recommend web-ext. If you want me to make the manual loading the default and move web-ext to optional, let me know.

Thanks for all the work, i hope i can contribute some back!

fregante commented

For discussion you can open a draft PR