Drupal Contrib Starterkit

If you want to contribute to Drupal modules and themes, this starterkit is for you. It provides all the necessary tools to get started with contributing to Drupal and ensures that you follow the Drupal coding standards. By using this starterkit, you'll have a running Drupal site with all the required tools for development. All you need to do is copy this repository and run a few commands. You can change the project's name in the .ddev/config.yaml file and update the Drupal version by changing the drupal/core-recommended version in the composer.json file and running the ddev composer install command. Available Drupal versions are listed on this page: https://github.com/drupal/core-recommended/tags. With this starterkit, you can start contributing to Drupal projects without worrying about setting up a development environment from scratch.

Requirements

1. Colima or Docker Desktop
2. ddev

Getting Started

1. Clone this repository git clone https://github.com/msankhala/drupal-contrib-starterkit.git
2. Run ddev start
3. Run ddev composer install
4. Run ddev nvm install stable
5. Run ddev npm install
6. Run ddev drush site:install --account-name=admin --account-pass=admin -y

Precommit hooks

This starterkit provides the precommit hooks that will run each time you try to commit in this repository. The precommit hooks will run the following commands based on the file extensions.

1. secretlint
2. prettier --write
3. eslint --fix
4. stylelint --fix
5. twig-cs-fixer --fix
6. phpcbf
7. phpcs

Using precommit hooks for custom modules and themes

For any module or theme that you want to contribute to, you can use the precommit hooks provided by this starterkit.

1. First clone the module or theme in the docroot/modules/custom or docroot/themes/custom directory.
2. Then run git config core.hooksPath ../../../../.husky command in the module or theme directory. This will set the custom module or theme to use the precommit hooks provided by this starterkit.

cd docroot/modules/custom/<module-name> or docroot/themes/custom/<theme-name>
git config core.hooksPath ../../../../.husky

Tools

1. Husky
2. Lint-staged
3. PHP Code Sniffer
4. PHP Code Beautifier
5. EsLint
6. StyleLint
7. SecretLint
8. Prettier
9. Twig-cs-fixer

composer require modules in comopser.json

1. Acquia blt
2. Admin Toolbar
3. Config split

composer require-dev modules in comopser.json

1. Coder
2. Devel
3. Drush
4. Drupal Check

Useful Vscode extensions

1. PHP Intelephense
2. PHP Sniffer & Beautifier
3. Drupal Check
4. PHP Debug

Installing Specific Node version inside the web container

Ddev has pre-installed nvm. You can use nvm to install any node version you want. For example, if you want to install node version 18.13.0, you can run the following command:

Install node version 18.13.0

ddev nvm install 18.13.0

List the installed node versions

ddev nvm ls

Use the installed node version

ddev nvm use 18.13.0

Changing drupal core version

You can simply change the drupal core version in the composer.json file and run the ddev composer install command. This starterkit is using drupal/core-recommended package. You can find the available drupal core versions here: https://github.com/drupal/core-recommended/tags

Bypass the precommit hooks

Sometimes you may want to bypass the precommit hooks, Because it is throwing some linting error that you may want to fix letter or it is not part of the scope of the issue that you try to fix. You can do that by using the --no-verify flag with the git commit command.

git commit -m "Commit message" --no-verify

Updating the linting rules and ignore files

There are two files for each linting tool. One is the rule file and the other is the ignore file. You can find these files in the repo root. You can update these files as per your need but it is NOT recommended to update the rule file. You can update the ignore file if you want to ignore any file or directory from linting. Below are the files for each linting tool.

1. .eslintrc.js
2. .eslintignore
3. .stylelintrc.js
4. .stylelintignore
5. .prettierrc.js
6. .prettierignore
7. .secretlintrc.js
8. .secretlintignore

Note: The linting rule files are supported in different formats like .json, .yaml, .cjs, .mjs, rc files, etc. But we are sticking with .js files because it is easy to use and maintain and you can add comments and use variables in .js files.

Updating the validate branch naming rule

There is .validate-branch-namerc.js file that contains the rule for validating the branch name. You can update this file as per your need.

Adding issue number automatically to commit message

There is jira-prepare-commit-msg.config.js file that will automatically add the issue number to the commit message. You can update this file as per your need.

Updating the Drupal version

By default this starterkit will install the drupal 9. You can change the drupal version by following the below steps.

1. Update the drupal/core-recommended version in the composer.json file.
2. Run the ddev composer update command, This will update the dependencies.