Contribute to this guide

guideGit 先生

Git 先生 是 Git 的多仓库管理器。在 CKEditor 5 中,您可以使用它轻松开发和测试各种与 CKEditor 5 相关的仓库,例如 ckeditor5-devckeditor5-linters-config

# 设置

要使用该工具,请从 npm 全局安装它。

npm install -g mrgit

然后,在 ckeditor5 仓库的根目录中放置一个名为 mrgit.json 的文件。以下是该文件的示例内容

{
    "packages": "external/",
    "dependencies": {
        "ckeditor5-linters-config": "ckeditor/ckeditor5-linters-config@latest",
        "ckeditor5-dev": "ckeditor/ckeditor5-dev@latest"
    },
    "presets": {
        "dev": {
            "ckeditor5-dev": "ckeditor/ckeditor5-dev"
        },
        "example-feature": {
            "ckeditor5-linters-config": "ckeditor/ckeditor5-linters-config#i/1-example-feature",
            "ckeditor5-dev": "ckeditor/ckeditor5-dev#i/1-example-feature"
        }
    }
}

mrgit v2.0.0+ 开始支持标签和预设。

# 用法

在上面列出的示例配置文件中,我们定义了应该使用的基本依赖项。这些依赖项使用 @latest 标签,这意味着将使用最新的发布标签。这应该与 npm 上可用的最新版本相一致。在调用 mrgit sync 后,这些依赖项将被克隆并在指定(最新)版本中在本地可用。

或者,您可以使用文件中后面部分定义的预设之一,例如 dev 预设。为此,请执行 mrgit sync --preset dev - 这将使用预设中指定的版本。ckeditor/ckeditor5-dev 没有指定任何标签或分支,因此默认情况下将使用 master 分支。

由于此预设中仅指定了 ckeditor5-dev,因此 ckeditor5-linters-config 使用的版本将与默认 dependencies 部分中指定的版本相同。使用此机制,可以切换 ckeditor5 仓库使用的依赖项的生产版本和开发版本。

有关所有可用命令和配置选项,请参阅 Git 先生文档