Skip to content

安装

引导一个新项目、从头开始,或迁移现有项目

引导项目

运行init命令,并按照提示操作。

sh
pnpm dlx wxt@latest init
sh
bunx wxt@latest init
sh
npx wxt@latest init
sh
# 初始使用 NPM,但提示时选择 Yarn
npx wxt@latest init

入门模板:

TypeScript Logo原生开发
Vue LogoVue
React LogoReact
Svelte LogoSvelte
Solid LogoSolid

所有模板默认使用 TypeScript。如需使用 JavaScript,请更改文件扩展名。

演示

wxt init 演示

运行 dev 命令后,继续后续步骤

从头开始

  1. 创建新项目

    sh
    cd my-project
    pnpm init
    sh
    cd my-project
    bun init
    sh
    cd my-project
    npm init
    sh
    cd my-project
    yarn init
  2. 安装 WXT:

    sh
    pnpm i -D wxt
    sh
    bun i -D wxt
    sh
    npm i -D wxt
    sh
    yarn add --dev wxt
  3. 添加入口点 my-project/entrypoints/background.ts

    ts
    export default defineBackground(() => {
      console.log('Hello world!');
    });
  4. package.json 中添加脚本:

    package.json
    json
    {
      "scripts": {
        "dev": "wxt", 
        "dev:firefox": "wxt -b firefox", 
        "build": "wxt build", 
        "build:firefox": "wxt build -b firefox", 
        "zip": "wxt zip", 
        "zip:firefox": "wxt zip -b firefox", 
        "postinstall": "wxt prepare"
      }
    }
  5. 在开发模式下运行扩展

    sh
    pnpm dev
    sh
    bun run dev
    sh
    npm run dev
    sh
    yarn dev

    WXT 将自动打开已安装您扩展的浏览器窗口。

后续步骤