Skip to content
/ wxt-template Public template

browser extension development with wxt

License

Notifications You must be signed in to change notification settings

simochee/wxt-template

Repository files navigation

WXT template

Features

  • 完全な WXT の開発環境
  • Biome と Lefthook による Git Hook ベースの Linter / Formatter
  • commitlint と Conventional Commits によるバージョニング
  • Chrome Web Store と Add-ons for Firefox への自動公開

Usage

Repositry Variables

Chrome Web Store と Add-ons for Firefox から取得できる拡張機能の ID を設定します。

  • CHROME_EXTENSION_ID
  • FIREFOX_EXTENSION_ID

Repository Secrets

wxt submit init で作成される .env.submit を元に、次の値を設定してください。

Chrome Web Store

  • CHROME_CLIENT_ID
  • CHROME_CLIENT_SECRET
  • CHROME_REFRESH_TOKEN

Add-ons for Firefox

  • FIREFOX_JWT_ISSUER
  • FIREFOX_JWT_SECRET

Additional: React + Tailwind CSS

はじめに、必要な依存関係を追加でインストールします。

pnpm add react{,-dom}
pnpm add -D @tsconfig/vite-react @types/react{,-dom} tailwindcss @tailwindcss/vite

tsconfig.json を更新します。

echo "$(jq '.extends |= ["@tsconfig/vite-react"] + (. // [])' tsconfig.json)" > tsconfig.json

つぎに、Tailwind CSS の Vite Plugin を wxt.config.ts に設定します。

+ import tailwindcss from '@tailwindcss/vite';

export default defineConfig({
+  vite: () => ({
+    plugins: [tailwindcss()],
+  }),
});

さいごに、 Tailwind CSS のエントリーポイントとなる CSS ファイルを作成します。

echo "@import \"tailwindcss\";" > assets/styles.css

CSS ファイルはエントリーポイントの HTML ファイルで参照することで利用可能になります。

+  <link rel="stylesheet" href="~/assets/styles.css">

License

MIT

README Template

README のテンプレートは、次のプレースホルダーを置き換えてからご利用ください。

  • REPOSITORY_OWNER
  • REPOSITORY_NAME
  • EXTENSION_NAME
  • SHORT_DESCRIPTION
  • LONG_DESCRIPTION
  • CHROME_EXTENSION_ID
  • FIREFOX_EXTENSION_ID
テンプレートを確認

EXTENSION_NAME

Browser Extension: SHORT_DESCRIPTION

LONG_DESCRIPTION

Install

Chrome Chrome Web Store also compatible with Edge Opera Brave

Firefox Add-ons for Firefox

License

MIT