This commit is contained in:
Jonghakseo
2022-04-10 20:31:39 +09:00
commit 85a07b8a06
49 changed files with 3305 additions and 0 deletions

5
.eslintrc Normal file
View File

@@ -0,0 +1,5 @@
{
"globals": {
"chrome": "readonly"
}
}

13
.gitignore vendored Normal file
View File

@@ -0,0 +1,13 @@
# dependencies
/node_modules
# testing
/coverage
# build
/dist
# etc
.DS_Store
.env.local
.idea

6
.prettierrc Normal file
View File

@@ -0,0 +1,6 @@
{
"singleQuote": false,
"trailingComma": "es5",
"requirePragma": false,
"arrowParens": "always"
}

1
README.md Executable file
View File

@@ -0,0 +1 @@
# chrome-extension-boilerplate-react-vite

1
index.d.ts vendored Normal file
View File

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

40
package.json Executable file
View File

@@ -0,0 +1,40 @@
{
"name": "chrome-extension-boilerplate-react-vite",
"version": "0.0.1",
"description": "chrome extension boilerplate",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite.git"
},
"scripts": {
"build": "vite build",
"dev": "vite build --watch",
"preview": "vite preview"
},
"type": "module",
"dependencies": {
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
"devDependencies": {
"@types/chrome": "^0.0.180",
"@types/node": "^17.0.23",
"@types/react": "^17.0.39",
"@types/react-dom": "^17.0.11",
"@vitejs/plugin-react": "^1.3.0",
"eslint": "^7.32.0",
"eslint-plugin-import": "^2.25.4",
"eslint-plugin-jsx-a11y": "^6.5.1",
"eslint-plugin-react": "^7.28.0",
"eslint-plugin-react-hooks": "^4.3.0",
"fs-extra": "^10.0.0",
"prettier": "^2.5.1",
"sass": "^1.50.0",
"ts-loader": "^9.2.6",
"ts-node": "^10.7.0",
"typescript": "^4.5.5",
"vite": "^2.9.1",
"vite-plugin-html": "^3.2.0"
}
}

21
plugins/copy-manifest.ts Normal file
View File

@@ -0,0 +1,21 @@
import * as fs from "fs";
import * as path from "path";
import colorLog from "./utils/color-log";
const { resolve } = path;
const outDir = resolve(__dirname, "..", "dist");
const rootDir = resolve(__dirname, "..", "src");
export default function copyManifest() {
return {
name: "copy-manifest",
buildEnd() {
const from = resolve(rootDir, "manifest.json");
const to = resolve(outDir, "manifest.json");
fs.copyFileSync(from, to);
colorLog(`Manifest file copy complete: ${to}`, "success");
},
};
}

33
plugins/copy-template.ts Normal file
View File

@@ -0,0 +1,33 @@
import * as fs from "fs";
import * as path from "path";
import colorLog from "./utils/color-log";
import checkCalled from "./utils/check-called";
const { resolve } = path;
const publicDir = resolve(__dirname, "../public");
const pagesDir = resolve(__dirname, "../src/pages");
const folders = ["Newtab", "Panel", "Devtools", "Options", "Popup"];
export default function copyTemplate() {
const checker = checkCalled();
return {
name: "copy-template",
buildStart() {
if (checker.isCalled()) {
return;
}
folders.forEach((folder) => {
const from = resolve(pagesDir, folder, "index.html");
const to = resolve(publicDir, `${folder.toLowerCase()}.html`);
fs.copyFileSync(from, to);
colorLog(`Template file copy complete: ${to}`, "success");
});
checker.call();
},
};
}

View File

@@ -0,0 +1,15 @@
/**
* Checker that the plugin is called only once at build time
* 플러그인 호출시 한 번만 호출되도록 체크하는 역할을 한다
*/
export default function checkCalled() {
let _isCalled = false;
return {
isCalled() {
return _isCalled;
},
call() {
_isCalled = true;
},
};
}

View File

@@ -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;

11
public/devtools.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Devtools</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

BIN
public/icon-128.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

BIN
public/icon-34.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

11
public/newtab.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>New tab</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

11
public/options.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Options</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

11
public/panel.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Devtools Panel</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

11
public/popup.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Popup</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

7
src/assets/img/logo.svg Normal file
View File

@@ -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>

After

Width:  |  Height:  |  Size: 2.6 KiB

21
src/assets/index.d.ts vendored Normal file
View File

@@ -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;
}

32
src/manifest.json Executable file
View File

@@ -0,0 +1,32 @@
{
"manifest_version": 3,
"name": "Chrome Extension",
"version": "0.0.1",
"description": "A chrome extension",
"options_page": "options.html",
"background": { "service_worker": "background.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://*/*", "<all_urls>"],
"js": ["content.js"],
"css": ["content.styles.css"]
}
],
"devtools_page": "devtools.html",
"web_accessible_resources": [
{
"resources": ["content.styles.css", "icon-128.png", "icon-34.png"],
"matches": []
}
]
}

View File

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

View File

View File

@@ -0,0 +1 @@
console.log("content loaded");

View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Devtools</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

View File

@@ -0,0 +1,7 @@
import "chrome";
try {
chrome.devtools.panels.create("Dev Tools", "icon-34.png", "panel.html");
} catch (e) {
console.error(e);
}

View File

@@ -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);
}
}

View File

@@ -0,0 +1,10 @@
$myColor: red;
h1,
h2,
h3,
h4,
h5,
h6 {
color: $myColor;
}

View File

@@ -0,0 +1,28 @@
import React from "react";
import logo from "@assets/img/logo.svg";
import "@pages/Newtab/Newtab.css";
import "@pages/Newtab/Newtab.scss";
const Newtab = () => {
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>
<h6>The color of this paragraph is defined using SASS.</h6>
</header>
</div>
);
};
export default Newtab;

View File

@@ -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;
}

View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>New tab</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

View File

@@ -0,0 +1,7 @@
import React from "react";
import { render } from "react-dom";
import Newtab from "@pages/Newtab/Newtab";
import "@pages/Newtab/index.css";
render(<Newtab />, window.document.querySelector("#app-container"));

View File

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

View File

@@ -0,0 +1,9 @@
import React from "react";
import "@pages/Options/Options.css";
const Options: React.FC = () => {
return <div className="OptionsContainer">Options</div>;
};
export default Options;

View File

View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Options</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

View File

@@ -0,0 +1,7 @@
import React from "react";
import {render} from "react-dom";
import Options from "@pages/Options/Options";
import "@pages/Options/index.css";
render( <Options/>, window.document.querySelector("#app-container"));

View File

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

12
src/pages/Panel/Panel.tsx Normal file
View File

@@ -0,0 +1,12 @@
import React from "react";
import "@pages/Panel/Panel.css";
const Panel: React.FC = () => {
return (
<div className="container">
<h1>Dev Tools Panel</h1>
</div>
);
};
export default Panel;

View File

View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Devtools Panel</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

View File

@@ -0,0 +1,7 @@
import React from "react";
import { render } from "react-dom";
import "@pages/Panel/index.css";
import Panel from "@pages/Panel/Panel";
render(<Panel />, window.document.querySelector("#app-container"));

45
src/pages/Popup/Popup.css Normal file
View File

@@ -0,0 +1,45 @@
.App {
position: absolute;
top: 0px;
bottom: 0px;
left: 0px;
right: 0px;
text-align: center;
height: 100%;
padding: 10px;
background-color: #282c34;
}
.App-logo {
height: 30vmin;
pointer-events: none;
}
@media (prefers-reduced-motion: no-preference) {
.App-logo {
animation: App-logo-spin infinite 20s linear;
}
}
.App-header {
height: 100%;
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);
}
}

26
src/pages/Popup/Popup.tsx Normal file
View File

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

17
src/pages/Popup/index.css Normal file
View File

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

View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="ko">
<head>
<meta charset="UTF-8" />
<title>Popup</title>
</head>
<body>
<div id="app-container"></div>
</body>
</html>

View File

@@ -0,0 +1,7 @@
import React from "react";
import { render } from "react-dom";
import Popup from "@pages/Popup/Popup";
import "@pages/Popup/index.css";
render(<Popup />, window.document.querySelector("#app-container"));

28
tsconfig.json Normal file
View File

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

84
vite.config.ts Normal file
View File

@@ -0,0 +1,84 @@
import { defineConfig, PluginOption } from "vite";
import react from "@vitejs/plugin-react";
import { resolve } from "path";
import { createHtmlPlugin } from "vite-plugin-html";
import copyTemplate from "./plugins/copy-template";
import copyManifest from "./plugins/copy-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");
const customPlugins: PluginOption[] = [copyTemplate(), copyManifest()];
export default defineConfig({
resolve: {
alias: {
"@src": root,
"@assets": assetsDir,
"@pages": pagesDir,
},
},
plugins: [
react(),
...customPlugins,
createHtmlPlugin({
minify: true,
pages: [
{
entry: resolve(pagesDir, "Newtab", "index.tsx"),
filename: "newtab.js",
template: "public/newtab.html",
},
{
entry: resolve(pagesDir, "Options", "index.tsx"),
filename: "options.js",
template: "public/options.html",
},
{
entry: resolve(pagesDir, "Panel", "index.tsx"),
filename: "panel.js",
template: "public/panel.html",
},
{
entry: resolve(pagesDir, "Popup", "index.tsx"),
filename: "popup.js",
template: "public/popup.html",
},
{
entry: resolve(pagesDir, "Devtools", "index.ts"),
filename: "devtools.js",
template: "public/devtools.html",
},
],
}),
],
publicDir,
build: {
outDir,
watch: {
include: "src",
},
emptyOutDir: true,
rollupOptions: {
input: {
// css
ContentStyle: resolve(pagesDir, "Content", "content.style.css"),
// ts
Content: resolve(pagesDir, "Content", "index.ts"),
Background: resolve(pagesDir, "Background", "index.ts"),
},
output: {
entryFileNames: (chunk) => {
if (chunk.name === "ContentStyle") {
return `content.styles.css`;
}
return `${chunk.name}.js`;
},
},
external: ["chrome"],
},
},
});

2590
yarn.lock Normal file

File diff suppressed because it is too large Load Diff