studioumi / drupal-project

使用composer的Drupal 10项目模板

安装: 291

依赖: 0

建议: 0

安全: 0

星标: 3

关注者: 2

分支: 941

公开问题: 1

类型:项目

10.x-dev 2024-08-20 23:39 UTC

README

Merge upstream branches CI

通过composer create-project创建Drupal 10.x的初始构建包。

使用方法

首先请安装composer

使用以下命令创建项目。

# {some-dir} は Drupal をインストールするディレクトリ.
composer create-project studioumi/drupal-project:10.x-dev {some-dir} --no-interaction

创建项目后,进入安装目录并执行Drupal的初始安装。

cd {some-dir}
drush site:install --account-name=admin --account-mail=foo@example.com --account-pass=pass --locale=ja --db-url=mysql://user:password@host:port/dbname

初始安装后,修改settings.php并执行git初始化。

git init
git commit -m "initial commit."

运行DDEV

以下命令启动DDEV环境。请事先安装DDEV。( https://ddev.readthedocs.io/en/stable/ )

ddev start

其他库导入方法

要安装贡献模块或其他库,可以使用composer require ...命令导入。

cd some-dir
composer require drupal/devel:~1.0

更新Drupal核心

  1. 使用composer update更新包
composer update drupal/core-* --with-dependencies
  1. 使用git diff检查差异。在此过程中,.htaccessrobots.txt等文件也会更新,因此根据需要执行差异的合并。

应用核心和贡献模块的补丁

如果核心等行为出现问题,需要应用补丁,请在composer.json中记录要应用的补丁。这可以通过composer-patches自动应用补丁。

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL or local path to patch"
        }
    }
}

固定PHP版本的方法

以下命令可以固定要执行的PHP版本。

composer config platform.php 8.1

用于前端开发的包

此包包含用于简化自定义模块/主题前端开发的任务运行器和代码检查器。要使用它们,请在本地环境中使用Node.js和Yarn。

设置

执行以下命令安装必要的Node.js包。

yarn

stylelint

检查以SCSS编写的文件是否符合Drupal编码标准。

npx stylelint <file_name>

# カスタムモジュールを一括で stylelint する例
npx stylelint app/modules/custom/**/*.scss

ESLint

检查以ES6编写的JavaScript文件是否符合Drupal编码标准。

npx eslint <file_name>

# カスタムモジュールを一括で eslint する例
npx eslnt app/modules/custom/**/*.es6.js

Gulp.js

这是一个任务运行器,用于自动化Browsersync的启动、SASS(SCSS)和ES6编写的JavaScript的转译等任务。

npx gulp [tasks]

如果没有指定执行gulp时的任务,则Browsersync将启动,并监视SCSS和JavaScript(ES6)文件,在文件更新时进行转译。

可用的任务

设置

如果想要更改各个任务的默认选项,请将gulpfile.js/config/example.local.yml文件复制到gulpfile.js/config/local.yml以覆盖设置。

如果想要更改Browsersync的端口,可以按以下方式定义。

browsersync:
  port: 8080

有关默认设置和其他选项的详细信息,请参阅gulpfile.js/config/default.yml中的注释。

其他

本项目是drupal-composer/drupal-project的分支项目。有关详细信息,请参考那里。

主要更改点