+# Chrome Extension (MV3) Boilerplate with React and Webpack
-# Chrome Extension (MV3) Boilerplate with React 18 and Webpack 5
+
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
-[](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
+[![License][license-image]][license-url]
-## Announcements
+## Manifest v3
-- Recently updated from **[React](https://reactjs.org)** ~~17~~ to **18**!
-- **_This boilerplate adopts [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)!_**
- - For V2 users, please check out the [manifest-v2](https://github.com/lxieyang/chrome-extension-boilerplate-react/tree/manifest-v2) branch, or use version [3.x](https://www.npmjs.com/package/chrome-extension-boilerplate-react/v/3.3.0).
- - Check out the [Manifest V3 Migration Guide](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/).
-- Recently added [devtools](https://developer.chrome.com/docs/extensions/mv3/devtools/) Support! Thanks [GeekaholicLin](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/17)!
-- Recently updated from **[Webpack Dev Server](https://webpack.js.org/configuration/dev-server/)** ~~3.x~~ to **4.x** and **[Webpack](https://webpack.js.org/)** ~~4~~ to **5**!
-- Recently added [TypeScript](https://www.typescriptlang.org/) Support!
+**_This boilerplate adopts [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)!_**
+
+- For Manifest v2 users, check out the [MV3 Migration Guide](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/).
+- This project does not support Manifest v2. But, if absolutely necessary,
+ the upstream repository has a [manifest-v2](https://github.com/lxieyang/chrome-extension-boilerplate-react/tree/manifest-v2)
+ branch they recommend using.
## Features
-This is a basic Chrome Extensions boilerplate to help you write modular and modern Javascript code, load CSS easily and [automatic reload the browser on code changes](https://webpack.github.io/docs/webpack-dev-server.html#automatic-refresh).
+This is a basic OS-agnostic Chrome Extensions boilerplate to help you write modular
+and modern JavaScript code, load CSS easily and
+[automatically reload the browser on code changes](https://webpack.github.io/docs/webpack-dev-server.html#automatic-refresh).
This boilerplate is updated with:
- [Chrome Extension Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)
-- [React 18](https://reactjs.org)
+- [React 19](https://reactjs.org)
- [Webpack 5](https://webpack.js.org/)
- [Webpack Dev Server 4](https://webpack.js.org/configuration/dev-server/)
- [React Refresh](https://www.npmjs.com/package/react-refresh)
@@ -31,14 +30,17 @@ This boilerplate is updated with:
- [eslint-config-react-app](https://www.npmjs.com/package/eslint-config-react-app)
- [Prettier](https://prettier.io/)
- [TypeScript](https://www.typescriptlang.org/)
+- [webhint](https://webhint.io/)
+- [markdownlint](https://github.com/DavidAnson/markdownlint)
-This boilerplate is heavily inspired by and adapted from [https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate), with additional support for React 18 features, Webpack 5, and Webpack Dev Server 4.
-
-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.
+This boilerplate is heavily inspired by and adapted from
+[https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate),
+with additional support for React 18 features, Webpack 5,
+and Webpack Dev Server 4.
## Installing and Running
-### Procedures:
+### Procedures
1. Check if your [Node.js](https://nodejs.org/) version is >= **18**.
2. Clone this repository.
@@ -57,94 +59,145 @@ Please open up an issue to nudge me to keep the npm packages up-to-date. FYI, it
All your extension's code must be placed in the `src` folder.
-The boilerplate 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.
+The boilerplate 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.
## TypeScript
-This boilerplate now supports TypeScript! The `Options` Page is implemented using TypeScript. Please refer to `src/pages/Options/` for example usages.
+This boilerplate now supports TypeScript! The `Options` Page is implemented
+using TypeScript. Please refer to `src/pages/Options/` for example usages.
## Webpack auto-reload and HRM
-To make your workflow much more efficient this boilerplate uses the [webpack server](https://webpack.github.io/docs/webpack-dev-server.html) 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.
+To make your workflow much more efficient this boilerplate uses the
+[webpack server](https://webpack.github.io/docs/webpack-dev-server.html) 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:
-You can run the dev mode on other port if you want. Just specify the env var `port` like this:
+Linux:
+```shell
+PORT=6002 npm start
```
-$ PORT=6002 npm run start
+
+Windows:
+
+```shell
+set PORT=6002 && npm start
```
-## Content Scripts
+MacOS:
-Although this boilerplate 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](https://developer.chrome.com/extensions/content_scripts), but you need to exclude these entry points from hot reloading [(why?)](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/issues/4#issuecomment-261788690). To do so you need to expose which entry points are content scripts on the `webpack.config.js` using the `chromeExtensionBoilerplate -> notHotReload` config. Look the example below.
+```shell
+export PORT=6002 && npm start
+```
-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:
+## Content Scripts
+Although this boilerplate 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](https://developer.chrome.com/extensions/content_scripts),
+but you need to exclude these entry points from hot reloading
+[(why?)](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/issues/4#issuecomment-261788690).
+To do so you need to expose which entry points are content scripts in
+[`webpack.config.ts`](./webpack/webpack.config.ts)
+using the `options.notHotReload` config. See the example below.
+
+Let's say that you want use the `myContentScript` entry point as a content
+script, so in your `webpack.config.ts` you will configure the entry point and
+exclude it from hot reloading, like so:
+
+
```js
-{
- …
- entry: {
- myContentScript: "./src/js/myContentScript.js"
- },
- chromeExtensionBoilerplate: {
+const config: webpack.Config = {
+ // …
+ entry: {
+ myContentScript: "./src/js/myContentScript.ts"
+ },
+ // …
+};
+
+export const options = {
notHotReload: ["myContentScript"]
- }
- …
-}
+};
```
-and on your `src/manifest.json`:
+and in your `src/manifest.json`:
-```json
+
+```jsonc
{
- "content_scripts": [
- {
- "matches": ["https://www.google.com/*"],
- "js": ["myContentScript.bundle.js"]
- }
- ]
+ // ...
+ "content_scripts": [
+ {
+ "matches": ["https://www.google.com/*"],
+ "js": ["myContentScript.bundle.js"]
+ }
+ ]
+ // ...
}
```
-## Intelligent Code Completion
-
-Thanks to [@hudidit](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/4)'s kind suggestions, this boilerplate supports chrome-specific intelligent code completion using [@types/chrome](https://www.npmjs.com/package/@types/chrome).
-
## Packing
After the development of your extension run the command
-```
-$ NODE_ENV=production npm run build
+```bash
+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](https://developer.chrome.com/webstore/publish) to more infos about publishing.
+Now, the content of the `zip` folder will be the extension ready to be submitted
+to the Chrome Web Store. See the [official guide](https://developer.chrome.com/webstore/publish)
+for more info about publishing.
## Secrets
-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.
+If you are developing an extension that talks with some API, you're probably
+using different keys for testing and production. It's good practice to not
+commit your secrets and expose to anyone that have access to the repository.
+
+To manage your secrets appropriately, create the file `./secrets.
- 
-
- );
- }
-}
-
-export default GreetingComponent;
diff --git a/src/manifest.json b/src/manifest.json
index 9a7ba9080..cac760e91 100755
--- a/src/manifest.json
+++ b/src/manifest.json
@@ -1,31 +1,43 @@
{
- "manifest_version": 3,
- "name": "Chrome Extension with React & Webpack",
- "description": "A chrome extension boilerplate built with React 17, Webpack 5, and Webpack Dev Server 4",
- "options_page": "options.html",
- "background": { "service_worker": "background.bundle.js" },
- "action": {
- "default_popup": "popup.html",
- "default_icon": "icon-34.png"
- },
- "chrome_url_overrides": {
- "newtab": "newtab.html"
- },
- "icons": {
- "128": "icon-128.png"
- },
- "content_scripts": [
- {
- "matches": ["http://*/*", "https://*/*", "Hello, {this.state.name}!
-Chromium Extension Boilerplate DevTools
+ diff --git a/src/pages/Devtools/index.js b/src/pages/Devtools/index.js deleted file mode 100644 index 647319a1f..000000000 --- a/src/pages/Devtools/index.js +++ /dev/null @@ -1,5 +0,0 @@ -chrome.devtools.panels.create( - 'Dev Tools from chrome-extension-boilerplate-react', - 'icon-34.png', - 'panel.html' -); diff --git a/src/pages/Devtools/index.ts b/src/pages/Devtools/index.ts new file mode 100644 index 000000000..575c7c0f1 --- /dev/null +++ b/src/pages/Devtools/index.ts @@ -0,0 +1,5 @@ +chrome.devtools.panels.create( + 'Dev Tools from chromium-extension-boilerplate', + 'icon-34.png', + 'panel.html' +); diff --git a/src/pages/Newtab/Newtab.css b/src/pages/Newtab/Newtab.css index 74b5e0534..dcb8f54fa 100644 --- a/src/pages/Newtab/Newtab.css +++ b/src/pages/Newtab/Newtab.css @@ -1,38 +1,39 @@ .App { - text-align: center; + text-align: center; } .App-logo { - height: 40vmin; - pointer-events: none; + height: 40vmin; + pointer-events: none; } @media (prefers-reduced-motion: no-preference) { - .App-logo { - animation: App-logo-spin infinite 20s linear; - } + .App-logo { + animation: App-logo-spin infinite 20s linear; + } } .App-header { - background-color: #282c34; - min-height: 100vh; - display: flex; - flex-direction: column; - align-items: center; - justify-content: center; - font-size: calc(10px + 2vmin); - color: white; + background-color: #282c34; + min-height: 100vh; + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + font-size: calc(10px + 2vmin); + color: white; } .App-link { - color: #61dafb; + color: #61dafb; } @keyframes App-logo-spin { - from { - transform: rotate(0deg); - } - to { - transform: rotate(360deg); - } + from { + transform: rotate(0deg); + } + + to { + transform: rotate(360deg); + } } diff --git a/src/pages/Newtab/Newtab.jsx b/src/pages/Newtab/Newtab.jsx deleted file mode 100644 index 6ed464fb6..000000000 --- a/src/pages/Newtab/Newtab.jsx +++ /dev/null @@ -1,28 +0,0 @@ -import React from 'react'; -import logo from '../../assets/img/logo.svg'; -import './Newtab.css'; -import './Newtab.scss'; - -const Newtab = () => { - return ( -
-
- 
-
-
- );
-};
-
-export default Newtab;
diff --git a/src/pages/Newtab/Newtab.scss b/src/pages/Newtab/Newtab.scss
index 158c8df5f..85d01892c 100644
--- a/src/pages/Newtab/Newtab.scss
+++ b/src/pages/Newtab/Newtab.scss
@@ -6,5 +6,5 @@ h3,
h4,
h5,
h6 {
- color: $myColor;
+ color: $myColor;
}
diff --git a/src/pages/Newtab/Newtab.tsx b/src/pages/Newtab/Newtab.tsx
new file mode 100644
index 000000000..15f260ee5
--- /dev/null
+++ b/src/pages/Newtab/Newtab.tsx
@@ -0,0 +1,29 @@
+import React from 'react';
+import logo from '../../assets/img/logo.svg';
+import './Newtab.css';
+import './Newtab.scss';
+
+const Newtab: React.FC = () => {
+ return (
+
- Edit src/pages/Newtab/Newtab.js and save to reload.
-
The color of this paragraph is defined using SASS.
-
+
+ 
+
+
+ );
+};
+
+export default Newtab;
diff --git a/src/pages/Newtab/index.css b/src/pages/Newtab/index.css
index ec2585e8c..ef154c697 100644
--- a/src/pages/Newtab/index.css
+++ b/src/pages/Newtab/index.css
@@ -1,13 +1,14 @@
body {
- margin: 0;
- font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
- 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
- sans-serif;
- -webkit-font-smoothing: antialiased;
- -moz-osx-font-smoothing: grayscale;
+ margin: 0;
+ font-family:
+ -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+ 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+ sans-serif;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
}
code {
- font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
- monospace;
+ font-family:
+ source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
}
diff --git a/src/pages/Newtab/index.html b/src/pages/Newtab/index.html
index 06e0231f1..4e67ed10d 100644
--- a/src/pages/Newtab/index.html
+++ b/src/pages/Newtab/index.html
@@ -1,12 +1,12 @@
-
+
-
-
-
-
+ Edit src/pages/Newtab/Newtab.js and save to
+ reload.
+
The color of this paragraph is defined using SASS.
+{title} Page
;
+const Options: React.FC{title} Page
;
};
export default Options;
diff --git a/src/pages/Options/index.html b/src/pages/Options/index.html
index 2200adb7a..0b8dc7502 100644
--- a/src/pages/Options/index.html
+++ b/src/pages/Options/index.html
@@ -1,12 +1,12 @@
-
+
-
-
-
-
-
- );
+ return (
+ Dev Tools Panel
-
+
+ );
};
export default Panel;
diff --git a/src/pages/Panel/index.html b/src/pages/Panel/index.html
index 97ea9c5b2..42bb84f4e 100644
--- a/src/pages/Panel/index.html
+++ b/src/pages/Panel/index.html
@@ -1,12 +1,12 @@
-
+
-
-
-
- Dev Tools Panel
+
-
-
-
-
- );
-};
-
-export default Popup;
diff --git a/src/pages/Popup/Popup.tsx b/src/pages/Popup/Popup.tsx
new file mode 100644
index 000000000..5384ea81a
--- /dev/null
+++ b/src/pages/Popup/Popup.tsx
@@ -0,0 +1,27 @@
+import React from 'react';
+import logo from '../../assets/img/logo.svg';
+import './Popup.css';
+
+const Popup: React.FC = () => {
+ return (
+
- Edit src/pages/Popup/Popup.jsx and save to reload.
-
+
+
+
+
+ );
+};
+
+export default Popup;
diff --git a/src/pages/Popup/index.css b/src/pages/Popup/index.css
index 800a9cb82..a2141392b 100644
--- a/src/pages/Popup/index.css
+++ b/src/pages/Popup/index.css
@@ -1,17 +1,18 @@
body {
- width: 300px;
- height: 260px;
- margin: 0;
- font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
- 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
- sans-serif;
- -webkit-font-smoothing: antialiased;
- -moz-osx-font-smoothing: grayscale;
+ width: 300px;
+ height: 260px;
+ margin: 0;
+ font-family:
+ -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+ 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+ sans-serif;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
- position: relative;
+ position: relative;
}
code {
- font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
- monospace;
+ font-family:
+ source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
}
diff --git a/src/pages/Popup/index.html b/src/pages/Popup/index.html
index c322cec3d..27fa87123 100644
--- a/src/pages/Popup/index.html
+++ b/src/pages/Popup/index.html
@@ -1,12 +1,12 @@
-
+
-
-
-
-
+ Edit src/pages/Popup/Popup.jsx and save to
+ reload.
+