studioumi / drupal-project
使用composer的Drupal 10项目模板
Requires
- php: >=8.1
- composer/installers: ^2.1
- cweagans/composer-patches: ^1.7
- drupal-composer/drupal-paranoia: ~1
- drupal/core-composer-scaffold: ^10.0
- drupal/core-recommended: ^10.0
- drush/drush: ^12.4
- vlucas/phpdotenv: ^5.1
- webflo/drupal-finder: ^1.2
Requires (Dev)
- drupal/coder: ^8.3
- drupal/core-dev: ^10.0
- mglaman/phpstan-drupal: ^1.2
Conflicts
This package is auto-updated.
Last update: 2024-09-20 23:49:10 UTC
README
通过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核心
- 使用
composer update
更新包
composer update drupal/core-* --with-dependencies
- 使用
git diff
检查差异。在此过程中,.htaccess
或robots.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的分支项目。有关详细信息,请参考那里。
主要更改点
drupal/core
->drupal/core-recomended
的替换- 使用drupal-composer/drupal-paranoia
- DDEV 的运行环境