https://github.com/arvinxx/umi-chrome-extensions-template

基于 Umi 的 Chrome 插件开发模板
https://github.com/arvinxx/umi-chrome-extensions-template

chrome-extension template umi

Last synced: 19 days ago
JSON representation

基于 Umi 的 Chrome 插件开发模板

• Host: GitHub
• URL: https://github.com/arvinxx/umi-chrome-extensions-template
• Owner: arvinxx
• License: mit
• Created: 2020-12-23T14:02:39.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-27T15:01:19.000Z (about 2 years ago)
• Last Synced: 2024-12-25T12:11:52.709Z (25 days ago)
• Topics: chrome-extension, template, umi
• Language: TypeScript
• Homepage:
• Size: 143 KB
• Stars: 65
• Watchers: 3
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - arvinxx/umi-chrome-extensions-template - extension,template,umi pushed_at:2022-11 star:0.1k fork:0.0k 基于 Umi 的 Chrome 插件开发模板 (TypeScript)

README

        
# Umi Chrome Extensions Template

![][version-url] [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) ![][license-url]

[version-url]: https://img.shields.io/github/v/release/arvinxx/umi-chrome-extensions-template

[license-url]: https://img.shields.io/github/license/arvinxx/umi-chrome-extensions-template

基于 Umi 的 Chrome 插件开发脚手架。

## ✨ 特性

- 🌋 **企业级框架**：基于 umi 和 umi 插件 [umi-plugin-extension](https://github.com/arvinxx/umi-plugin-extensions) 构建，享受 umi 生态的全部技术能力；

- 📦 **开箱即用**：脚手架中已经配置 Chrome 插件开发常用的设置项；

- 🔥 **热更新**： 开发时 `options` 和 `popup` 页面支持 `react hot reload` 和 `react devtools`；

- ♻️ **自动重载**： 开发时 `contentScipts` 和 `background` 支持自动刷新;

- 🔧 **配置收敛**：直接在 `.umi.ts` 或 `config.ts` 设置插件配置；

- ⛑ **类型安全**： 脚手架由 Typescript 编写，已集成 Chrome 插件的类型定义文件。

- 🚀 **版本发布**： 使用 `semantic release` 实现语义化版本管理与自动发布流

## 📦 使用

克隆模板

```

git clone https://github.com/arvinxx/umi-chrome-extension-template.git

```

安装依赖，推荐使用 pnpm

```

pnpm i

```

## 🛠️ 开发

🔔 请确保你对 Chrome 插件开发已经有基本的了解，入门推荐：[Chrome 插件(扩展)开发全攻略](https://umi-plugin-extensions.vercel.app/tutorial)。

如果你对项目的配置有疑问，请查阅 umi-plugin-extension 配置项文档。 ➡️ [传送门](https://arvinxx.github.io/umi-plugin-extensions/#/api)

### 启动

```

pnpm start

```

## 👷 打包

构建生产产物直接运行：

```

pnpm run build

```

## 🤝 贡献 [![PRs Welcome](https://camo.githubusercontent.com/0ff11ed110cfa69f703ef0dcca3cee6141c0a8ef465e8237221ae245de3deb3d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](http://makeapullrequest.com/)

欢迎提交 PRs 和 issues。

## License

[MIT](./LICENSE) ® Arvin Xu