├── .gitignore ├── README.md ├── build-script.js ├── config-overrides.js ├── package.json ├── public ├── background.js ├── favicon.ico ├── index.html └── manifest.json ├── src ├── App.css ├── App.js ├── App.test.js ├── index.css ├── index.js ├── logo.svg └── registerServiceWorker.js └── yarn.lock /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/ignore-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | 6 | # testing 7 | /coverage 8 | 9 | # production 10 | /build 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | npm-debug.log* 20 | yarn-debug.log* 21 | yarn-error.log* 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Demo extension in React 2 | 3 | This is a demo project for [this blog post](http://rubberduck.io/blog/browser-extensions-react). At the end of the post, we will have a browser extension that is: 4 | 5 | - Built on create-react-app, without [ejecting](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject) 6 | - Development mode with near-hot reloading on `npm start` 7 | - Production builds with `npm run build` 8 | -------------------------------------------------------------------------------- /build-script.js: -------------------------------------------------------------------------------- 1 | const fs = require("fs-extra"); 2 | 3 | const updateBackgroundFile = buildPath => { 4 | const backgroundJS = `${buildPath}/background.js`; 5 | const assetManifest = `${buildPath}/asset-manifest.json`; 6 | const assetContents = JSON.parse(fs.readFileSync(assetManifest, "utf8")); 7 | 8 | const jsPlaceholder = 'const jsLocation = "./static/js/bundle.js";'; 9 | const cssPlaceholder = "const cssLocation = null;"; 10 | 11 | const jsLocation = `const jsLocation = "./${assetContents["main.js"]}";`; 12 | const cssLocation = `const cssLocation = "./${assetContents["main.css"]}";`; 13 | 14 | let backgroundContents = fs.readFileSync(backgroundJS, "utf8"); 15 | backgroundContents = backgroundContents.replace(jsPlaceholder, jsLocation); 16 | backgroundContents = backgroundContents.replace(cssPlaceholder, cssLocation); 17 | 18 | // Write back the corrected script 19 | fs.writeFile(backgroundJS, backgroundContents, function(err) { 20 | if (err) { 21 | return console.log(err); 22 | } 23 | console.log("background.js updated."); 24 | }); 25 | }; 26 | 27 | module.exports = { 28 | updateBackgroundFile: updateBackgroundFile 29 | }; 30 | 31 | if (require.main === module) { 32 | const buildPath = "./build"; 33 | updateBackgroundFile(buildPath); 34 | } 35 | -------------------------------------------------------------------------------- /config-overrides.js: -------------------------------------------------------------------------------- 1 | /* 2 | Overiding webpack config for create-react-app, to run our custom 3 | helpers and also force the dev server to save the served files to 4 | disk, so that Chrome can serve them. 5 | 6 | Related: https://github.com/facebook/create-react-app/issues/1070 7 | https://github.com/gajus/write-file-webpack-plugin 8 | */ 9 | const path = require("path"); 10 | const WriteFilePlugin = require("write-file-webpack-plugin"); 11 | const fs = require("fs-extra"); 12 | 13 | module.exports = function override(config, env) { 14 | let buildPath = "./build"; 15 | config.output.path = path.join(__dirname, "./build"); 16 | config.plugins.push(new WriteFilePlugin()); 17 | fs.removeSync(buildPath); 18 | fs.copySync("./public/", buildPath); 19 | return config; 20 | }; 21 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "my-demo-extension", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "react": "^16.4.1", 7 | "react-dom": "^16.4.1", 8 | "react-scripts": "1.1.4" 9 | }, 10 | "scripts": { 11 | "start": "react-app-rewired start", 12 | "build": "react-app-rewired build && node build-script.js", 13 | "test": "react-app-rewired test --env=jsdom", 14 | "eject": "react-app-rewired eject" 15 | }, 16 | "devDependencies": { 17 | "react-app-rewired": "^1.5.2", 18 | "write-file-webpack-plugin": "^4.3.2" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /public/background.js: -------------------------------------------------------------------------------- 1 | const jsLocation = "./static/js/bundle.js"; 2 | const cssLocation = null; 3 | 4 | chrome.tabs.onUpdated.addListener((tabId, changeInfo, tab) => { 5 | if (changeInfo.status === "complete") { 6 | if (jsLocation !== null) { 7 | chrome.tabs.executeScript(tabId, { 8 | file: jsLocation, 9 | runAt: "document_end" 10 | }); 11 | } 12 | 13 | if (cssLocation !== null) { 14 | chrome.tabs.executeScript(tabId, { 15 | file: cssLocation, 16 | runAt: "document_end" 17 | }); 18 | } 19 | } 20 | }); 21 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karigari/my-react-extension/1a8bd2a753818ed7c6e9bfb7988f0b7cd1634704/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 11 | 12 | 13 | 22 | React App 23 | 24 | 25 | 28 |
29 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "my-demo-extension", 3 | "version": "0.1.0", 4 | "background": { 5 | "persistent": false, 6 | "scripts": ["background.js"] 7 | }, 8 | "permissions": ["https://github.com/*"], 9 | "manifest_version": 2 10 | } 11 | -------------------------------------------------------------------------------- /src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | animation: App-logo-spin infinite 20s linear; 7 | height: 80px; 8 | } 9 | 10 | .App-header { 11 | background-color: #222; 12 | height: 150px; 13 | padding: 20px; 14 | color: white; 15 | } 16 | 17 | .App-title { 18 | font-size: 1.5em; 19 | } 20 | 21 | .App-intro { 22 | font-size: large; 23 | } 24 | 25 | @keyframes App-logo-spin { 26 | from { transform: rotate(0deg); } 27 | to { transform: rotate(360deg); } 28 | } 29 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from "react"; 2 | import logo from "./logo.svg"; 3 | import "./App.css"; 4 | 5 | class App extends Component { 6 | render() { 7 | return ( 8 |
9 |
10 | logo 11 |

Welcome to React

12 |
13 |

14 | To get started, edit src/App.js and save to reload. 15 |

16 |
17 | ); 18 | } 19 | } 20 | 21 | export default App; 22 | -------------------------------------------------------------------------------- /src/App.test.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import App from './App'; 4 | 5 | it('renders without crashing', () => { 6 | const div = document.createElement('div'); 7 | ReactDOM.render(, div); 8 | ReactDOM.unmountComponentAtNode(div); 9 | }); 10 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | padding: 0; 4 | font-family: sans-serif; 5 | } 6 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import "./index.css"; 4 | import App from "./App"; 5 | import registerServiceWorker from "./registerServiceWorker"; 6 | 7 | const anchor = document.createElement("div"); 8 | anchor.id = "extension-root"; 9 | document.body.insertBefore(anchor, document.body.childNodes[0]); 10 | 11 | ReactDOM.render(, document.getElementById("extension-root")); 12 | registerServiceWorker(); 13 | -------------------------------------------------------------------------------- /src/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /src/registerServiceWorker.js: -------------------------------------------------------------------------------- 1 | // In production, we register a service worker to serve assets from local cache. 2 | 3 | // This lets the app load faster on subsequent visits in production, and gives 4 | // it offline capabilities. However, it also means that developers (and users) 5 | // will only see deployed updates on the "N+1" visit to a page, since previously 6 | // cached resources are updated in the background. 7 | 8 | // To learn more about the benefits of this model, read https://goo.gl/KwvDNy. 9 | // This link also includes instructions on opting out of this behavior. 10 | 11 | const isLocalhost = Boolean( 12 | window.location.hostname === 'localhost' || 13 | // [::1] is the IPv6 localhost address. 14 | window.location.hostname === '[::1]' || 15 | // 127.0.0.1/8 is considered localhost for IPv4. 16 | window.location.hostname.match( 17 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 18 | ) 19 | ); 20 | 21 | export default function register() { 22 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 23 | // The URL constructor is available in all browsers that support SW. 24 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location); 25 | if (publicUrl.origin !== window.location.origin) { 26 | // Our service worker won't work if PUBLIC_URL is on a different origin 27 | // from what our page is served on. This might happen if a CDN is used to 28 | // serve assets; see https://github.com/facebookincubator/create-react-app/issues/2374 29 | return; 30 | } 31 | 32 | window.addEventListener('load', () => { 33 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 34 | 35 | if (isLocalhost) { 36 | // This is running on localhost. Lets check if a service worker still exists or not. 37 | checkValidServiceWorker(swUrl); 38 | 39 | // Add some additional logging to localhost, pointing developers to the 40 | // service worker/PWA documentation. 41 | navigator.serviceWorker.ready.then(() => { 42 | console.log( 43 | 'This web app is being served cache-first by a service ' + 44 | 'worker. To learn more, visit https://goo.gl/SC7cgQ' 45 | ); 46 | }); 47 | } else { 48 | // Is not local host. Just register service worker 49 | registerValidSW(swUrl); 50 | } 51 | }); 52 | } 53 | } 54 | 55 | function registerValidSW(swUrl) { 56 | navigator.serviceWorker 57 | .register(swUrl) 58 | .then(registration => { 59 | registration.onupdatefound = () => { 60 | const installingWorker = registration.installing; 61 | installingWorker.onstatechange = () => { 62 | if (installingWorker.state === 'installed') { 63 | if (navigator.serviceWorker.controller) { 64 | // At this point, the old content will have been purged and 65 | // the fresh content will have been added to the cache. 66 | // It's the perfect time to display a "New content is 67 | // available; please refresh." message in your web app. 68 | console.log('New content is available; please refresh.'); 69 | } else { 70 | // At this point, everything has been precached. 71 | // It's the perfect time to display a 72 | // "Content is cached for offline use." message. 73 | console.log('Content is cached for offline use.'); 74 | } 75 | } 76 | }; 77 | }; 78 | }) 79 | .catch(error => { 80 | console.error('Error during service worker registration:', error); 81 | }); 82 | } 83 | 84 | function checkValidServiceWorker(swUrl) { 85 | // Check if the service worker can be found. If it can't reload the page. 86 | fetch(swUrl) 87 | .then(response => { 88 | // Ensure service worker exists, and that we really are getting a JS file. 89 | if ( 90 | response.status === 404 || 91 | response.headers.get('content-type').indexOf('javascript') === -1 92 | ) { 93 | // No service worker found. Probably a different app. Reload the page. 94 | navigator.serviceWorker.ready.then(registration => { 95 | registration.unregister().then(() => { 96 | window.location.reload(); 97 | }); 98 | }); 99 | } else { 100 | // Service worker found. Proceed as normal. 101 | registerValidSW(swUrl); 102 | } 103 | }) 104 | .catch(() => { 105 | console.log( 106 | 'No internet connection found. App is running in offline mode.' 107 | ); 108 | }); 109 | } 110 | 111 | export function unregister() { 112 | if ('serviceWorker' in navigator) { 113 | navigator.serviceWorker.ready.then(registration => { 114 | registration.unregister(); 115 | }); 116 | } 117 | } 118 | --------------------------------------------------------------------------------