README

FIRE

   )
  ) \
 / ) (
 \(_)/

=================

Fast Initialization and Rebuilding of Environments.

FIRE 是一组标准化的命令，用于运行本地 Drupal 环境，无论您使用哪种 Docker 封装（Lando 或 DDEV），以及无论实际站点托管在哪里（Pantheon 或 Acquia）。这意味着您所工作的每个网站都将使用 相同的 命令来执行诸如获取新数据库（fire get-db）等操作。这使得快速轻松地让新人员参与您任何网站的工作变得更加容易。

安装

1. 在您的计算机上安装 FIRE 启动器（推荐但可选）
   https://github.com/fourkitchens/fire-launcher
2. 将命令包安装到您的项目中
   composer require fourkitchens/fire --dev
3. 为项目创建 fire.yml 配置文件
   fire init
4. 编辑 fire.yml 并调整配置。
5. 检查 fire 是否正常工作
   如果您已安装 FIRE 启动器

fire

否则

./vendor/bin/fire

它应该显示所有可用的 FIRE 命令。

1. 编辑您项目的 README.md 文件，并指向我们的 项目文档
   如果您的项目运行 FIRE 命令还有其他要求（例如，您的项目是否也需要 Node 和 NVM？），那么请确保也在您的项目 README.md 中列出这些。

用法

已安装 FIRE 启动器

示例

fire build

未安装 FIRE 启动器

示例

./vendor/bin/fire build

可用命令

• init: 启动向导，帮助您初始化 fire.yml 文件。

  别名: i

• env:start: 启动基于 Docker 的本地环境（Lando，DDev）。

  别名: start

• env:stop: 停止基于 Docker 的本地环境（Lando，DDev）。

  别名: stop

• env:poweroff: 停止基于 Docker 和代理的环境（Lando，DDev）。

  别名: poweroff

• env:switch: 一个项目可以同时配置两个环境：Lando 和 DDev，因此“switch”命令可以帮助您在本地开发环境之间进行“热切换”（Lando 或 DDev）。

  别名: env-switch|switch|sw

• local:build: 从头开始构建您的 Drupal 网站。

  别名: local-build, build

  选项

  --no-db-import: 忽略数据库导入过程（下载 & 导入）。

  --no-db-download: 仅忽略 DB 下载，数据将从您现有的 db 备份文件中导入。

  -f, --get-files: 从远程服务器获取文件。

• local:build:drush-commands: Drush 构建命令 - updb , cr, cim , cr, deploy:hook

  别名 build-drush

• local:build:js: 构建 Project JS 依赖项（项目根目录）。

  别名: build-js

• local:build:php: 构建 Project PHP 依赖项。

  别名: build-php

• local:build:theme: 构建 Projects 主题。

  别名 build-theme

• local:configure:export：导出站点配置 - 无需交互。

  别名：configure-export|configure_export|cex

• local:configure:import：导入站点配置 - 无需交互。

  别名：configure-import|configure_import|cim

• local:composer：本地环境的Composer代理。

  别名：c, composer

  参数

  `args`: The composer command you would like to execute.
  

  使用示例

  fire composer install
  fire composer install -- --ignore-platform-reqs
  fire composer update drupal/core -- -W
  fire composer require 'drupal/devel:^5.1'
  fire composer require fourkitchens/fire -- --dev
  

• local:drush：本地环境的Drush代理。

  别名：drush

  参数

  args：要执行的Drush命令。

• local:get-db：获取本地环境的数据库。

  别名：get-db|db-get|getdb|dbget|get_db|db_get|local:db:get|local:get:db

• local:get-files：从远程源（Pantheon、acquia）下载站点文件。

  别名：get-files|files-get|getfiles|filesget|get_files|files_get|pull-files|pull_files|local:file:get|local:get:files

  选项

  --no-download：重用现有文件副本在参考文件夹中，并将它们放置在文件文件夹中（仅适用于Pantheon）。

• local:import-db：导入本地环境的数据库。

  别名：import-db|db-import|importdb|dbimport|import_db|db_import

• local:lint:php：为您本地环境运行和配置Phpcs。

  别名：phpcs

• local:setup：从头开始设置您的项目（lando、ddev），所有数据将被销毁并重建。

  别名：setup

  选项

  --no-db-import: 忽略数据库导入过程（下载 & 导入）。

  --no-db-download: 仅忽略 DB 下载，数据将从您现有的 db 备份文件中导入。

  -f, --get-files: 从远程服务器获取文件。

• xdebug:enable：配置您的本地环境Xdebug以与您首选的代码编辑器一起工作。

  别名：xd-en

• vrt:generate-backstop-config：为您创建基本的Backstop.json。

  别名：vgc

• vrt:init：从头开始配置您的本地环境以使用VRT测试。

  别名：vinit

• vrt:local-env-config：修改您的本地环境，以便您可以使用Backstop。

  别名：vlec

• vrt:reference：从参考URL获取新的参考屏幕截图。

  别名：vref

• vrt:run：运行您的VRT测试。

  别名：vrun

• vrt:testing-setup：为VRT测试设置测试和参考站点。别名：vts

• command:add：此命令允许您在项目中创建自定义命令。

  别名：ca, cadd

• command:overwrite：此命令允许您覆盖项目中默认的fire命令。

  别名：co, coverride

  有两种覆盖类型

  1. 部分覆盖：它首先运行原始命令，然后允许您添加新功能。

  2. 完全覆盖：它替换所有现有代码，并允许您从头开始编写命令。

  您还可以创建一个新命令，只需在提示时选择“自定义”选项，然后回答问题，现在应在自定义路径中创建一个新命令，默认情况下仅添加一个任务以清理Drupal缓存，但从此文件中，您可以添加自定义任务。

配置

在项目根目录中创建一个名为：fire.yml 的文件，并在其中指定全局项目设置。

如果您需要稍后覆盖一些全局设置以针对特定环境，可以创建 fire.local.yml 并覆盖您想要的任何变量。

配置变量

• local_environment： 可选设置，系统将自动检测您的本地环境，目前可用的有：ddev、lando。

• local_fe_theme_name： 可选设置，系统将尝试自动获取您的主题，但您始终可以指定您需要使用的主题。

• local_theme_build_script：您用于构建主题的NPM脚本。

• remote_platform：您的站点远程平台。目前可用的有：pantheon、acquia。

• remote_sitename：远程平台站点的机器名。

• remote_canonical_env：远程平台的规范环境（用于拉取文件和数据库的环境）。

开发

• 从源安装FIRE包。

composer require fourkitchens/fire --dev --prefer-install=source

开发背景

我们使用Robo作为开发此工具的框架。

• 命令示例： https://github.com/consolidation/robo/blob/4.x/examples/src/Robo/Plugin/Commands/ExampleCommands.php

• Robo 框架文档： https://robo.li/docs/framework.html