A chrome extension that removes generated files from GitHub's line counts.

How does this work?

The extension uses the Github API to load information about your PR then recalculates the diff, subtracting generated files listed in the repo's .gitattributes file.

pnpm-lock.yaml  linguist-generated
vendor/**/*     linguist-generated
*.gen.html      linguist-generated

Roadmap

• v1.0.0 Subtract a hardcoded list of generated files from PR diffs as POC
• v1.1.0 Support private repos via GitHub PAT
• v1.2.0 Make the list based off your .gitattributes
• v1.3.0 Show the number of generated lines next to additions and subtractions
• Recalculate the 5 diff boxes next to the count
• Add a dropdown that lists the files that were counted in the generated line count

That's it. Very simple, targeted extension for fixing 1 problem with GitHub.

Development

You must use PNPM with this repo. To install it, run corepack enable or npm i -g pnpm.

Then instal dependencies:

pnpm i

Scripts

This extension is bundled via WXT.

• pnpm dev: Launchs Chrome with the dev version of the extension installed.
• pnpm build: Builds the extension for production. Outputs to the dist directory.
• pnpm zip: Zips up the dist directory into an installable ZIP file.

Add :firefox suffix to some commands to target firefox instead of Chrome.

• pnpm build:firefox
• pnpm dev:firefox

Running Tests

Unit tests are written with Vitest.

pnpm test

Release an Update

Eventually, I'll create a GitHub action for this. But for now, you can release an update by:

1. Create a file, .env.submit, with the following content:

   # Follow: https://developer.chrome.com/docs/webstore/using_webstore_api/
   CHROME_EXTENSION_ID="..."
   CHROME_CLIENT_ID="..."
   CHROME_CLIENT_SECRET="..."
   CHROME_REFRESH_TOKEN="..."
   
   # Follow: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign
   FIREFOX_EXTENSION_ID="..."
   FIREFOX_JWT_ISSUER="..."
   FIREFOX_JWT_SECRET="..."
   
   # Follow: https://learn.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/api/using-addons-api#before-you-begin
   EDGE_PRODUCT_ID="..."
   EDGE_CLIENT_ID="..."
   EDGE_CLIENT_SECRET="..."
   EDGE_ACCESS_TOKEN_URL="..."

2. Optional: Run pnpm submit:dry to test if your config is correct.

3. Run pnpm submit to submit new versions to the stores.