使用dotbot配置您的Firefox配置文件
项目描述
使用 dotbot 配置您的Firefox配置文件。
目录
您可以使用它的功能
当Firefox启动时,它将在您的配置文件目录中查找 user.js 文件。如果找到,则将 user.js 设置复制到 prefs.js 并使用。
您可以通过使用dotbot-firefox创建指向自定义 user.js 的符号链接来强制在所有配置文件中保持一致的Firefox配置。插件将找到包含 prefs.js 文件的Firefox配置文件目录,并使用dotbot的内置链接插件创建符号链接。
安装
有两种方式安装和使用该插件
将其作为Python包安装。
将其添加为dotfiles仓库中的git子模块。
将 dotbot_firefox.py 复制到您的dotfiles目录。
Python包
如果您想将dotbot-firefox作为Python包安装(例如,如果您正在使用虚拟环境),则可以使用 pip 安装插件
pip install dotbot-firefox
然后,当运行dotbot时,使用 -p 或 --plugin 选项告诉dotbot加载插件
dotbot [...] --plugin dotbot_firefox [...]
如果您正在使用dotbot的任何 install 脚本,则需要编辑该文件以添加 --plugin 选项。
Git子模块
如果您想将 dotbot-firefox 作为 git 子模块跟踪(例如,如果您使用 git 管理您的 dotfiles),则可以使用 git 将插件仓库添加为子模块。
git submodule add https://github.com/kurtmckee/dotbot-firefox.git
这将克隆仓库到名为 dotbot-firefox 的目录。然后,当运行 dotbot 时,使用 -p 或 --plugin 选项告诉 dotbot 加载插件。
dotbot [...] --plugin dotbot-firefox/dotbot_firefox.py [...]
请注意,当您克隆您的 dotfiles 仓库或在其他计算机上拉取新更改时,可能需要初始化插件的 git 子模块。该命令看起来可能如下所示:
git submodule update --init dotbot-firefox
复制 dotbot_firefox.py
如果您愿意,可以将 dotbot_firefox.py 复制到您的 dotfiles 目录。您可能选择这样做,如果您已经使用其他插件并已配置 dotbot 从插件目录加载所有插件。
如果您将 dotbot_firefox.py 复制到 dotfiles 目录的根目录,那么当运行 dotbot 时,请使用 -p 或 --plugin 选项告诉 dotbot 加载插件。
dotbot [...] --plugin dotbot_firefox.py [...]
如果您将 dotbot_firefox.py 复制到包含其他插件的目录,则可以使用 dotbot 的 --plugin-dir 选项来加载目录中的所有插件。以下示例中,插件目录名为 dotbot-plugins。
dotbot [...] --plugin-dir dotbot-plugins [...]
配置
首先,在 dotbot 管理的 dotfiles 目录中创建一个 user.js 文件。例如,它可能包含以下配置来设置您的首页:
user_pref("browser.startup.homepage", "https://dashboard.example");
(MozillaZine 维护了一个关于 Firefox 配置设置 的详细列表。)
然后,在您的 dotbot 配置中添加一个带有 user.js 键的 firefox 指令。该键的值遵循 dotbot Link 插件 的语法。
# Example 1:
# "user.js" can be specified as a string.
firefox:
user.js: firefox/user.js
# Example 2:
# "user.js" can have no value, and will be found
# in the same directory as your dotbot config file.
firefox:
user.js:
# Example 3:
# The extended Link plugin syntax is supported.
firefox:
user.js:
path: firefox/user.js
force: true
Firefox配置文件位置
dotbot-firefox 插件了解以下默认目录:
%APPDATA%\Mozilla\Firefox\Profiles(Windows)
~/Library/Application Support/Firefox/Profiles(Mac OS)
~/.mozilla/firefox(Linux)
~/snap/firefox/common/.mozilla/firefox(Linux 的 Firefox Snap)
~/.var/app/org.mozilla.firefox/.mozilla/firefox(Linux 的 Firefox Flatpak)
只有包含 prefs.js 文件的配置文件子目录才会被插件视为有效。
开发
要设置开发环境,请克隆 dotbot-firefox 插件的 git 仓库。然后,按照以下步骤创建虚拟环境和在本地运行单元测试:
# Create the virtual environment
$ python -m venv .venv
# Activate the virtual environment (Linux)
$ . .venv/bin/activate
# Activate the virtual environment (Windows)
$ & .venv/Scripts/Activate.ps1
# Update pip and setuptools, and install wheel
(.venv) $ pip install -U pip setuptools wheel
# Install poetry and tox
(.venv) $ pip install poetry tox
# Install all dependencies
(.venv) $ poetry install
# Run the unit tests locally
(.venv) $ tox