npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

webpack-webextension-background-logger

v1.0.2

Published

Centralize console logs in background page (web/chrome extensions)

Downloads

10

Readme

Web Extension Background Logger

What

Log centralization for you Web/Chrome Extension. Compatible with every browser extension : Chrome, Firefox, Safari, Edge.

Why

When you develop your Web Extension, you have to keep an eye on multiple consoles and logs from :

  • Background script.
  • Content script.
  • Popup page (either page action or browser action).
  • Option page.

This webpack plugin allows you to centralize all logs in the background page console.

Get Started

First, install Web Extension Background Logger :

# npm
npm i -D webpack-webextension-background-logger

# yarn
yarn add -D webpack-webextension-background-logger

Add to your Webpack config :

const BackgroundLogger = require('webpack-webextension-background-logger')

module.exports = {
  // your webpack config
  // ...

  plugins: [new BackgroundLogger()],
}

Web Extension Background Logger will look for an entry named background by default, but you can customize this :

new BackgroundLogger({ backgroundEntry: 'main' })

Usage

Now, instead of using good old console.log, simply use console.bg :

console.bg('loggy-log-log', foo)

This will print your log in the background page console.

Types for console.bg

If you use TypeScript, or type check your JavaScript (like this project does), you might want to tell the compiler that console.bg exists.

To do this, include in a declaration file (typings.d.ts for example) at the root of your project :

/// <reference types="webpack-webextension-background-logger/console" />

Or you can add to your tsonfig.json :

{
  "compilerOptions": {
    "typeRoots": ["node_modules/@types", "node_modules/webpack-webextension-background-logger"]
  }
}

Production build

For production builds, you can opt out of background logger and revert to plain console.log statements :

new BackgroundLogger({ revertToLog: true })

This will simply remove Background Logger from your build and rewrite every console.bg statement into console.log statement.