README

Twig 开发版允许核心团队在 Pattern Lab 环境中运行每个组件的最新版本的同时，对选择的相关组件进行工作和提交更改。此版本不稳定。

Pattern Lab Twig 标准版是稳定版本。请从这里开始满足您的所有 Twig 需要。

打包组件

Twig 开发版安装以下组件的 dev 分支

• pattern-lab/core: GitHub, Packagist
• pattern-lab/patternengine-twig: 文档, GitHub, Packagist
• pattern-lab/starterkit-twig-demo: GitHub, Packagist
• pattern-lab/styleguidekit-assets-default: GitHub, Packagist
• pattern-lab/styleguidekit-twig-default: GitHub, Packagist
• pattern-lab/unified-asset-installer: GitHub, Packagist

安装 Twig 开发版

Pattern Lab 使用 Composer 来管理项目依赖项。如果您打算使用开发版，您必须已安装 Composer。

1. 安装 Composer

请遵循 Composer 网站上的安装 Composer 说明。我们建议您全局安装。

2. 安装开发版

使用 Composer 的 create-project 功能将开发版安装到您选择的目录。键入

cd install/location/
composer create-project pattern-lab/edition-development-twig your-project-name && cd $_

这将在 your-project-name 目录中创建一个目录。它还将安装 Pattern Lab 的默认文件夹结构、核心、依赖项以及选定的包作为单独的 Git 克隆。

有用的命令

以下是一些您可以在命令行中使用，以在 Pattern Lab 中工作的有用命令。

列出所有可用命令

要列出所有可用命令，请输入：

php core/console --help

要列出特定命令的选项，请输入：

php core/console --help --[command]

生成 Pattern Lab

要生成 Pattern Lab 的前端，请输入：

php core/console --generate

监视更改并重新生成 Pattern Lab

要监视更改并重新生成 Pattern Lab 的前端，请输入：

php core/console --watch

启动服务器以查看 Pattern Lab

您可以使用 PHP 内置的 web 服务器在浏览器中审查您的 Pattern Lab 项目。在另一个窗口中输入：

php core/console --server

然后在您的浏览器中打开 https://:8080。

安装 StarterKit

要将接近空白的 StarterKit 作为项目的起点安装，请输入：

php core/console --starterkit --init

要从 GitHub 安装特定的 StarterKit，请输入：

php core/console --starterkit --install <starterkit-vendor/starterkit-name>

更新 Git 远程仓库

由于 Composer 的问题，默认的 remote 值将 dev 分支设置为错误的位置。如果您尝试推送更改，这可能会导致问题。要更新它们，您必须为每个软件包输入：

git config branch.dev.remote origin

列表中包含的开发版软件包及其位置如下：

pattern-lab/core -> vendor/pattern-lab/core/
pattern-lab/unified-asset-installer -> vendor/pattern-lab/unified-asset-installer
pattern-lab/patternengine-twig -> packages/pattern-lab/patternengine-twig
pattern-lab/starterkit-twig-default -> packages/pattern-lab/starterkit-twig-default
pattern-lab/styleguidekit-assets-default -> packages/pattern-lab/styleguidekit-assets-default
pattern-lab/styleguidekit-twig-default -> packages/pattern-lab/styleguidekit-twig-default

重要：如果您添加了另一个 Pattern Lab 软件包（例如插件、StarterKit 等），您还必须确保更新其 dev 分支的 origin。 见上方说明。

添加新软件包

要将新软件包添加到您的开发版 Twig 版本中，请输入：

composer require package-name/from-packagist

Composer 使用 Packagist 作为来自核心 Pattern Lab 团队的所有 Pattern Lab 相关软件包的存储库。

重要：如果您添加了另一个 Pattern Lab 软件包（例如插件、StarterKit 等），您还必须确保更新其 dev 分支的 origin。 见上方说明。

分支和测试软件包

要使用开发版测试对软件包分支所做的更改，请执行以下操作：

1. 分支一个软件包并创建一个功能测试分支

在 GitHub 上，您可以分支您想要修改的软件包。您必须创建一个新的分支，您将在其中创建新的更改。在这个例子中，我们将使用 pattern-lab/patternengine-mustache 作为分支项目的示例，使用 bugfix 作为分支的名称。

2. 更新 composer.json 中的仓库部分

在 composer.json 中，您需要添加或更新 repositories 部分，以便指向软件包的分支仓库。

"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/your-name/patternengine-php-mustache"
    }
],

3. 更新 composer.json 中的依赖分支

在 composer.json 文件中，您需要更新 require 部分，以便指向您在分叉的仓库中的新分支

"require": {
    "pattern-lab/patternengine-twig": "dev-bugfix"
}

提醒： Composer 使用 dev- 来确定何时在仓库中克隆分支而不是下载它。 dev- 不应成为您分支名称的一部分。

4. 更新开发版本的依赖项

为了将开发版本的依赖项更新为使用您分叉的包，请执行以下操作

composer update pattern-lab/patternengine-twig

针对“发布版本”进行测试

核心 Pattern Lab 团队开发的包使用 Git 仓库管理的 gitflow 模型。因为开发版本为每个包克隆了仓库，所以您可以技术上切换每个包以使用 master 分支来测试特定包的最后一个发布版本。