Chrome Extension - GitHub Classroom Helper

Features

• Recognizes all the pages which have the Feedback Pull Request opened
• Allows to send feedback on all the pull requests (feedbacks) at once

This extension is updated with:

• Chrome Extension Manifest V3
• React 18
• Webpack 5
• Webpack Dev Server 4
• React Refresh
• react-refresh-webpack-plugin
• eslint-config-react-app
• Prettier
• TypeScript

Please open up an issue to nudge me to keep the npm packages up-to-date. FYI, it takes time to make different packages with different versions work together nicely.

How to use:

1. Check if your Node.js version is >= 18.
2. Clone this repository.
3. Run npm install to install the dependencies.
4. Run npm run build
5. Load your extension on Chrome following:
   1. Access chrome://extensions/
   2. Check Developer mode
   3. Click on Load unpacked extension
   4. Select the build folder.
6. Happy reviewing.

Developing

Structure

All your extension's code must be placed in the src folder.

The extension is already prepared to have a popup, an options page, a background page, and a new tab page (which replaces the new tab page of your browser). But feel free to customize these.

Running in dev mode

To make your workflow much more efficient this extension uses the webpack server to development (started with npm start) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.

You can run the dev mode on other port if you want. Just specify the env var port like this:

$ PORT=6002 npm run start

Content Scripts

Although this extension uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as content scripts, but you need to exclude these entry points from hot reloading (why?). To do so you need to expose which entry points are content scripts on the webpack.config.js using the chromeExtensionGitHubCRHelper -> notHotReload config. Look the example below.

Let's say that you want use the myContentScript entry point as content script, so on your webpack.config.js you will configure the entry point and exclude it from hot reloading, like this:

{
  …
  entry: {
    myContentScript: "./src/js/myContentScript.js"
  },
  chromeExtensionGitHubCRHelper: {
    notHotReload: ["myContentScript"]
  }
  …
}

and on your src/manifest.json:

{
  "content_scripts": [
    {
      "matches": ["https://www.google.com/*"],
      "js": ["myContentScript.bundle.js"]
    }
  ]
}

Intelligent Code Completion

Thanks to @hudidit's kind suggestions, this extension supports chrome-specific intelligent code completion using @types/chrome.

Packing

After the development of your extension run the command

$ NODE_ENV=production npm run build

Now, the content of build folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the official guide to more infos about publishing.

Secrets (just for info, we don't use any)

If you are developing an extension that talks with some API you probably are using different keys for testing and production. Is a good practice you not commit your secret keys and expose to anyone that have access to the repository.

To this task this extension import the file ./secrets.<THE-NODE_ENV>.js on your modules through the module named as secrets, so you can do things like this:

./secrets.development.js

export default { key: '123' };

./src/popup.js

import secrets from 'secrets';
ApiCall({ key: secrets.key });

👉 The files with name secrets.*.js already are ignored on the repository.

Resources:

• Webpack documentation
• Chrome Extension documentation

---

Maintained by @AhsanAyaz | Website