Skip to content

mozilla-extensions/mozilla-vpn-extension

Repository files navigation

Mozilla VPN Extension

A Firefox extension for the Mozilla VPN client

Requirements


Building the Extension

  1. Clone the source code
        git clone https://github.com/mozilla-extensions/mozilla-vpn-extension
        cd mozilla-vpn-extension
  1. Initialize the submodules
        git submodule update --init --recursive
  1. Install node modules
        npm install
  1. Build
        npm run build
        # Extension is now ready:
        sha256sum dist/mozilla-vpn-extension.xpi

Development

  1. Clone the source code

     git clone https://github.com/mozilla-extensions/mozilla-vpn-extension
     cd mozilla-vpn-extension
    
  2. Initialize the submodules

     git submodule update --init --recursive
    
  3. Install node modules

     npm install
    
  4. Run

     npm run start
    

Debugging build grief

# For more verbose output when extension is starting up
web-ext run -s src/ --verbose
# For identifying errors in the extension or other source code files.
cd src
web-ext lint

Restoring src/_locales

You might see the _locales submodule touched after running npm run start.

$ git status
  (...)
  modified:   src/_locales

This is a side effect of web-ext, just restore the status with npm run restore-locales-github