vite chrome extension 制作流程

找了半天如何结合vite进行chrome extension的开发。发现了npm有一些模版,不过感觉都不太好用,或者是基于webpack的。
因此顺便在学习一下如何进行项目配置,着手自己搭一个开发环境。整体思路也很简单,这种不涉及后端方法替换,只是生成多项目。
沿着这个思路(基于node7+开发):
样例项目 github

安装vite项目

npm create vite@latest extension -- --template vue
cd extension
npm install
npm run build  

增加Chrome extension支持

dist 文件内部会编译出一个网页,接下来要让chrome能够加载这个网页。
在dist文件夹内部增加 manifest.json 即可。文档地址
manifest.json 文件如下:

{
  "name": "vite",
  "version": "1.0.0",
  "manifest_version": 3,
  "description": "vite chrome extension tempalte",
  "icons": {
    "16": "assets/vue.svg",
    "48": "assets/vue.svg",
    "128": "assets/vue.svg"
  },
  "options_ui": {
    "page": "index.html",
    "open_in_tab": false
  }
}

之后在dist文件夹内放点icons,这样基本东西就齐了。如果没有其他的需求,目前这种基本上就能完事了。

但是一般来说还想加点 background service worker, override page 之类的东西。因此还要继续改造一下。

增加 background service worker

再增加一个独立的项目生成 background.js
增加一个 vite.config.background.js。
顺便整理一下当前的项目文件组织方式。

- src
  - background # background 项目
  - popup # popup 项目
  - manifest.json # manifest.json 
  - assets # manifest.json 中的 logo

dist 打包的目录的结构如下:

- dist
  - background # background 项目
  - popup # popup 项目
  - manifest.json # manifest.json 
  - assets # manifest.json 中的 logo

这样需要增加两个编译项目:

  • vite.config.popup.js
  • vite.confg.background.js

vite.confg.background.js 项目配置

类似的配置修改到 vite.config.popup.js 上。

import { defineConfig } from 'vite'
import { resolve } from "path"
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  build: {
    rollupOptions: {
      input: {
        main: resolve(__dirname, 'src/background/background.js'),
      },
      output: {
        dir: "dist/background",
        entryFileNames: "background.js"
      }
    }
  }
})

manifest.json 中增加background配置

  "options_ui": {
    "page": "popup/index.html", // 对应的popup项目
    "open_in_tab": false
  },
  "background": {
    "service_worker": "background/background.js"
  }

进而需要修改一下 package.json

"scripts": {
  "build": "vite build -c vite.config.popup.js && vite build -c vite.config.background.js",
  // "build": "bash build.sh", // 或者增加脚本bash.sh
},

bash.sh脚本如下:

vite build -c vite.config.popup.js &&\
vite build -c vite.config.override.js

不过其中有一个public产出物无法自动拷贝到dist文件中,因此需要在脚本中增加一些拷贝命令。
完整bash.sh如下:

mkdir dist
rm -rf dist/* &&\

vite build -c vite.config.popup.js &&\
vite build -c vite.config.background.js &&\

cp -r src/assets dist &&\
cp src/manifest.json dist/manifest.json &&\

# copy public 

mv src/popup/dist/popup/* dist/popup/ &&\
rm -rf src/popup/dist

基本上到此就能够支持extension跑起来了。
如果需要 override 配置,再增加一个独立的项目配置项即可。

参考完整项目地址

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容

  • 什么 chrome extension chrome extension,也就是我们平时所说的浏览器插件,是可以定...
    CBDxin阅读 2,874评论 0 6
  • 怎样从众多网页上快速提取信息?比如说: 从数百个宝贝页面提取价格和属性 从数千个招聘职位页面中提取招聘信息 你可能...
    zhyuzh3d阅读 1,855评论 0 6
  • 一、前言 Chrome插件是一个用Web技术开发,可以增强浏览器功能的软件。它其实和一个普通web应用一样都是由h...
    liuniansilence阅读 3,623评论 0 0
  • 需求背景: 最近维护一个老项目,没有前端交接,文档只有项目启动和打包说明,配合的后端也是半路接手只愿提供新接口的文...
    折叠幸福阅读 887评论 0 1
  • demo地址 先上一张效果图: 结构 几个概念 从上图可以看出围绕在extension中的几个可见UI元素:ico...
    冰川孤辰js阅读 7,733评论 0 3