Big bang

nodemon.json

@@ -0,0 +1,13 @@
+{
+  "env": {
+    "__DEV__": "true"
+  },
+  "watch": [
+    "src", "utils", "vite.config.ts"
+  ],
+  "ext": "tsx,css,html,ts",
+  "ignore": [
+    "src/**/*.spec.ts"
+  ],
+  "exec": "vite build"
+}

package.json

@@ -0,0 +1,44 @@
+{
+  "name": "vite-web-extension",
+  "displayName": "Web Extension Boilerplate",
+  "version": "1.1.0",
+  "description": "A simple chrome extension template with Vite, React, TypeScript and Tailwind CSS.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JohnBra/web-extension.git"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "nodemon"
+  },
+  "type": "module",
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "webextension-polyfill": "^0.10.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.18",
+    "@types/react": "^18.0.27",
+    "@types/react-dom": "^18.0.10",
+    "@types/webextension-polyfill": "^0.10.0",
+    "@typescript-eslint/eslint-plugin": "^5.49.0",
+    "@typescript-eslint/parser": "^5.49.0",
+    "@vitejs/plugin-react-swc": "^3.0.1",
+    "autoprefixer": "^10.4.13",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-react": "^7.32.1",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "fs-extra": "^11.1.0",
+    "nodemon": "^2.0.20",
+    "postcss": "^8.4.21",
+    "tailwindcss": "^3.2.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4",
+    "vite": "^4.0.4"
+  }
+}

postcss.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

src/assets/img/logo.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
+    <g fill="#61DAFB">
+        <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
+        <circle cx="420.9" cy="296.5" r="45.7"/>
+        <path d="M520.5 78.1z"/>
+    </g>
+</svg>

src/assets/styles/tailwind.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

src/global.d.ts

@@ -0,0 +1,21 @@
+declare module '*.svg' {
+  import React = require('react');
+  export const ReactComponent: React.SFC<React.SVGProps<SVGSVGElement>>;
+  const src: string;
+  export default src;
+}
+
+declare module '*.jpg' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.png' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.json' {
+  const content: string;
+  export default content;
+}

src/manifest.ts

@@ -0,0 +1,42 @@
+import type { Manifest } from 'webextension-polyfill';
+import pkg from '../package.json';
+
+const manifest: Manifest.WebExtensionManifest = {
+  manifest_version: 3,
+  name: pkg.displayName,
+  version: pkg.version,
+  description: pkg.description,
+  options_ui: {
+    page: 'src/pages/options/index.html',
+  },
+  background: {
+    service_worker: 'src/pages/background/index.js',
+    type: 'module',
+  },
+  action: {
+    default_popup: 'src/pages/popup/index.html',
+    default_icon: 'icon-34.png',
+  },
+  chrome_url_overrides: {
+    newtab: 'src/pages/newtab/index.html',
+  },
+  icons: {
+    '128': 'icon-128.png',
+  },
+  content_scripts: [
+    {
+      matches: ['http://*/*', 'https://*/*', '<all_urls>'],
+      js: ['src/pages/content/index.js'],
+      css: ['contentStyle.css'],
+    },
+  ],
+  devtools_page: 'src/pages/devtools/index.html',
+  web_accessible_resources: [
+    {
+      resources: ['contentStyle.css', 'icon-128.png', 'icon-34.png'],
+      matches: [],
+    },
+  ],
+};
+
+export default manifest;

src/pages/background/index.ts

@@ -0,0 +1 @@
+console.log('background script loaded');

src/pages/content/index.ts

@@ -0,0 +1,5 @@
+try {
+  console.log('content script loaded');
+} catch (e) {
+  console.error(e);
+}

src/pages/devtools/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Devtools</title>
+    </head>
+    <body>
+        <script type="module" src="./index.ts"></script>
+    </body>
+</html>

src/pages/devtools/index.ts

@@ -0,0 +1,7 @@
+import Browser from 'webextension-polyfill';
+
+Browser
+  .devtools
+  .panels
+  .create('Dev Tools', 'icon-34.png', 'src/pages/panel/index.html')
+  .catch(console.error);

src/pages/newtab/Newtab.css

@@ -0,0 +1,38 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  height: 40vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .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;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}

src/pages/newtab/Newtab.tsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import logo from '@assets/img/logo.svg';
+import '@pages/newtab/Newtab.css';
+
+export default function Newtab(): JSX.Element {
+  return (
+    <div className="App">
+      <header className="App-header">
+        <img src={logo} className="App-logo" alt="logo" />
+        <p>
+          Edit <code>src/pages/newtab/Newtab.tsx</code> and save to reload.
+        </p>
+        <a
+          className="App-link"
+          href="https://reactjs.org"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Learn React!
+        </a>
+      </header>
+    </div>
+  );
+}

src/pages/newtab/index.css

@@ -0,0 +1,13 @@
+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;
+}
+
+code {
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
+    monospace;
+}

src/pages/newtab/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>New tab</title>
+    </head>
+
+    <body>
+        <div id="__root"></div>
+        <script type="module" src="./index.tsx"></script>
+    </body>
+</html>

src/pages/newtab/index.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import Newtab from '@pages/newtab/Newtab';
+import '@pages/newtab/index.css';
+
+function init() {
+  const rootContainer = document.querySelector("#__root");
+  if (!rootContainer) throw new Error("Can't find Newtab root element");
+  const root = createRoot(rootContainer);
+  root.render(<Newtab />);
+}
+
+init();

src/pages/options/Options.css

@@ -0,0 +1,8 @@
+.container {
+  width: 100%;
+  height: 50vh;
+  font-size: 2rem;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

src/pages/options/Options.tsx

@@ -0,0 +1,6 @@
+import React from 'react';
+import '@pages/options/Options.css';
+
+export default function Options(): JSX.Element {
+  return <div className="container">Options</div>;
+}

src/pages/options/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Options</title>
+    </head>
+
+    <body>
+        <div id="__root"></div>
+        <script type="module" src="./index.tsx"></script>
+    </body>
+</html>

src/pages/options/index.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import Options from '@pages/options/Options';
+import '@pages/options/index.css';
+
+function init() {
+  const rootContainer = document.querySelector("#__root");
+  if (!rootContainer) throw new Error("Can't find Options root element");
+  const root = createRoot(rootContainer);
+  root.render(<Options />);
+}
+
+init();

src/pages/panel/Panel.css

@@ -0,0 +1,7 @@
+body {
+  background-color: #242424;
+}
+
+.container {
+  color: #ffffff;
+}

src/pages/panel/Panel.tsx

@@ -0,0 +1,10 @@
+import React from 'react';
+import '@pages/panel/Panel.css';
+
+export default function Panel(): JSX.Element {
+  return (
+    <div className="container">
+      <h1>Dev Tools Panel</h1>
+    </div>
+  );
+}

src/pages/panel/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Devtools Panel</title>
+    </head>
+
+    <body>
+        <div id="__root"></div>
+        <script type="module" src="./index.tsx"></script>
+    </body>
+</html>

src/pages/panel/index.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import Panel from '@pages/panel/Panel';
+import '@pages/panel/index.css';
+
+function init() {
+  const rootContainer = document.querySelector("#__root");
+  if (!rootContainer) throw new Error("Can't find Panel root element");
+  const root = createRoot(rootContainer);
+  root.render(<Panel />);
+}
+
+init();

src/pages/popup/Popup.tsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import logo from '@assets/img/logo.svg';
+
+export default function Popup(): JSX.Element {
+  return (
+    <div className="absolute top-0 left-0 right-0 bottom-0 text-center h-full p-3 bg-gray-800">
+      <header className="flex flex-col items-center justify-center text-white">
+        <img src={logo} className="h-36 pointer-events-none animate-spin-slow" alt="logo" />
+        <p>
+          Edit <code>src/pages/popup/Popup.jsx</code> and save to reload.
+        </p>
+        <a
+          className="text-blue-400"
+          href="https://reactjs.org"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Learn React!
+        </a>
+        <p>Popup styled with TailwindCSS!</p>
+      </header>
+    </div>
+  );
+}

src/pages/popup/index.css

@@ -0,0 +1,12 @@
+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;
+
+  position: relative;
+}

src/pages/popup/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Popup</title>
+    </head>
+
+    <body>
+        <div id="__root"></div>
+        <script type="module" src="./index.tsx"></script>
+    </body>
+</html>

src/pages/popup/index.tsx

@@ -0,0 +1,14 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import '@pages/popup/index.css';
+import '@assets/styles/tailwind.css';
+import Popup from '@pages/popup/Popup';
+
+function init() {
+  const rootContainer = document.querySelector("#__root");
+  if (!rootContainer) throw new Error("Can't find Popup root element");
+  const root = createRoot(rootContainer);
+  root.render(<Popup />);
+}
+
+init();

src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

tailwind.config.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+  content: ["./src/**/*.{js,jsx,ts,tsx}"],
+  theme: {
+    extend: {
+      animation: {
+        'spin-slow': 'spin 20s linear infinite',
+      }
+    },
+  },
+  plugins: [],
+}

tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "types": ["vite/client", "node"],
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "baseUrl": ".",
+    "paths": {
+      "@src/*": ["src/*"],
+      "@assets/*": ["src/assets/*"],
+      "@pages/*": ["src/pages/*"]
+    }
+  },
+  "include": ["src",
+    "utils", "vite.config.ts"],
+}

utils/log.ts

@@ -0,0 +1,48 @@
+type ColorType = 'success' | 'info' | 'error' | 'warning' | keyof typeof COLORS;
+
+export default function colorLog(message: string, type?: ColorType) {
+  let color: string = type || COLORS.FgBlack;
+
+  switch (type) {
+    case 'success':
+      color = COLORS.FgGreen;
+      break;
+    case 'info':
+      color = COLORS.FgBlue;
+      break;
+    case 'error':
+      color = COLORS.FgRed;
+      break;
+    case 'warning':
+      color = COLORS.FgYellow;
+      break;
+  }
+
+  console.log(color, message);
+}
+
+const COLORS = {
+  Reset: '\x1b[0m',
+  Bright: '\x1b[1m',
+  Dim: '\x1b[2m',
+  Underscore: '\x1b[4m',
+  Blink: '\x1b[5m',
+  Reverse: '\x1b[7m',
+  Hidden: '\x1b[8m',
+  FgBlack: '\x1b[30m',
+  FgRed: '\x1b[31m',
+  FgGreen: '\x1b[32m',
+  FgYellow: '\x1b[33m',
+  FgBlue: '\x1b[34m',
+  FgMagenta: '\x1b[35m',
+  FgCyan: '\x1b[36m',
+  FgWhite: '\x1b[37m',
+  BgBlack: '\x1b[40m',
+  BgRed: '\x1b[41m',
+  BgGreen: '\x1b[42m',
+  BgYellow: '\x1b[43m',
+  BgBlue: '\x1b[44m',
+  BgMagenta: '\x1b[45m',
+  BgCyan: '\x1b[46m',
+  BgWhite: '\x1b[47m',
+} as const;

utils/plugins/copy-content-style.ts

@@ -0,0 +1,21 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import colorLog from '../log';
+import { PluginOption } from 'vite';
+
+const { resolve } = path;
+
+const root = resolve(__dirname, '..', '..');
+const contentStyle = resolve(root, 'src', 'pages', 'content', 'style.css');
+const outDir = resolve(__dirname, '..', '..', 'public');
+
+export default function copyContentStyle(): PluginOption {
+  return {
+    name: 'make-manifest',
+    buildEnd() {
+      fs.copyFileSync(contentStyle, resolve(outDir, 'contentStyle.css'));
+
+      colorLog('contentStyle copied', 'success');
+    },
+  };
+}

utils/plugins/make-manifest.ts

@@ -0,0 +1,26 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import colorLog from '../log';
+import manifest from '../../src/manifest';
+import { PluginOption } from 'vite';
+
+const { resolve } = path;
+
+const outDir = resolve(__dirname, '..', '..', 'public');
+
+export default function makeManifest(): PluginOption {
+  return {
+    name: 'make-manifest',
+    buildEnd() {
+      if (!fs.existsSync(outDir)) {
+        fs.mkdirSync(outDir);
+      }
+
+      const manifestPath = resolve(outDir, 'manifest.json');
+
+      fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
+
+      colorLog(`Manifest file copy complete: ${manifestPath}`, 'success');
+    },
+  };
+}

vite.config.ts

@@ -0,0 +1,41 @@
+import react from '@vitejs/plugin-react-swc';
+import { resolve } from 'path';
+import { defineConfig } from 'vite';
+import copyContentStyle from './utils/plugins/copy-content-style';
+import makeManifest from './utils/plugins/make-manifest';
+
+const root = resolve(__dirname, 'src');
+const pagesDir = resolve(root, 'pages');
+const assetsDir = resolve(root, 'assets');
+const outDir = resolve(__dirname, 'dist');
+const publicDir = resolve(__dirname, 'public');
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@src': root,
+      '@assets': assetsDir,
+      '@pages': pagesDir,
+    },
+  },
+  plugins: [react(), makeManifest(), copyContentStyle()],
+  publicDir,
+  build: {
+    outDir,
+    sourcemap: process.env.__DEV__ === 'true',
+    rollupOptions: {
+      input: {
+        devtools: resolve(pagesDir, 'devtools', 'index.html'),
+        panel: resolve(pagesDir, 'panel', 'index.html'),
+        content: resolve(pagesDir, 'content', 'index.ts'),
+        background: resolve(pagesDir, 'background', 'index.ts'),
+        popup: resolve(pagesDir, 'popup', 'index.html'),
+        newtab: resolve(pagesDir, 'newtab', 'index.html'),
+        options: resolve(pagesDir, 'options', 'index.html'),
+      },
+      output: {
+        entryFileNames: (chunk) => `src/pages/${chunk.name}/index.js`,
+      },
+    },
+  },
+});