基本零配置的 Webextension 脚手架,用 React TypeScript Sass 开发浏览器扩展
文章目录
Create React Typescript Sass Webextension
灵活强大的零配置 Webextension 开发脚手架。
- 支持 React, TypeScript 和 Sass
- Jest 测试,内含 sinon-chrome
- 提供虚拟浏览器扩展环境,方便开发 UI
- 自动生成 Webpack 入口
- 支持任意浏览器导出,可以用不同的 Manifest
安装
<pre>
git clone git@github.com:crimx/create-react-typescript-sass-webextension.git 你的仓库名
cd 你的仓库名
git remote set-url git@github.com:你的用户名/你的仓库名.git
yarn install
</pre>
使用
大多数情况下你只需要处理 src 下的文件:
- 这个模板自带一个典型扩展的三个主要部分:
backgroud,content和popup。不需要的话直接删除就行,Webpack 入口会自动生成。 - 如果需要输出更多的页面或脚本,只需在
src中新建目录,目录名会被用作入口名。目录中应包含一个index.(js|jsx|ts|tsx)文件。如果需要输出页面的话再添加个index.html作为模板。可以参考 popup 页面。 -
background,components,assets和manifest是预留名称。-
background用于生成背景脚本,用其它的名字作入口的话虚拟扩展环境不会加载。 -
components放共用的组件。 -
assets放静态文件。 -
manifest用于生成manifest.json。-
不要删除
common.manifest.json。如果你不希望合并设置,把它的内容改成空 JSON{}。 - 支持任意浏览器,添加相应文件即可,如
edge.manifest.json。
-
不要删除
-
- 如果需要在
src目录下添加目录,却又不希望其生成入口,用_开头的目录名。
命令
构建
-
yarn start加载虚拟浏览器扩展环境,调整页面样式时有用。- 因扩展的安全政策,在真实的扩展环境中开发会很不方便。框架的 devtool 用不了,热加载和自动刷新也很麻烦…… 所以我写了个模拟环境,主要实现了 runtime message 和 storage 两大块,跟真实行为基本一致。如果需要更多,在
config/fake-env/webextension-page.js中添加。 - 默认加载
popup页面。 如果要换其它入口,比如options页面,可以运行yarn start --main=options。 -
background脚本会默认加载 (如果存在的话)。 - 修改
config/fake-env/fake-ajax拦截 ajax 请求。
- 因扩展的安全政策,在真实的扩展环境中开发会很不方便。框架的 devtool 用不了,热加载和自动刷新也很麻烦…… 所以我写了个模拟环境,主要实现了 runtime message 和 storage 两大块,跟真实行为基本一致。如果需要更多,在
-
yarn dev跟yarn start一样。 -
yarn test模块测试。-
yarn test --coverage查看 coverage 结果。 - 内含
sinon-chrome,TypeScript 类型已调好,直接写代码就行。
-
-
yarn build完整构建项目。- 分别输出 Chrome 和 Firefox 结果到
build目录中。 - 要获得更新后的版本号,先
yarn release再构建。
- 分别输出 Chrome 和 Firefox 结果到
-
yarn devbuild不压缩代码快速构建项目,检测文件变化。- 默认
chrome,对于其它浏览器,如 Firefox ,运行yarn devbuild --firefox。 - 浏览器对应的 manifest 文件必须存在
manifest下,如opera.manifest.json。
- 默认
- 在命令后添加
--debug可以开启process.env.DEBUG_MODE。
Git
-
yarn commit使用 conventional 风格 commit 代码。 VSCode 用户还可以用 vscode-commitizen 扩展。 -
yarn release自动计算增加版本号并更新 CHANGELOG 日志。
高级配置
自动更新依赖
可以设置 travis CI 和 greenkeeper 来自动更新依赖。
如果需要一并更新 lockfile ,使用 greenkeeper-lockfile 。
Commit 风格
本模板使用 conventional 风格。如需更换,参考 commitlint 和 commitizen 配置。
代码风格
本模板使用 TypeScript 版本的 Standard JavaScript 代码风格,可以在 tslint.json 中修改。
更多配置
参考 create-reate-app ,大部分支持。




评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论