Skip to content

[#278] Added support for Asset packagist. #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ jobs:
- name: Validate composer.json structure
run: composer normalize --dry-run

- name: Require bower-asset
run: |
test ! -d web/libraries/dropzone
composer require bower-asset/dropzone
test -d web/libraries/dropzone

- name: Override Drupal version to dev for testing dev releases
if: matrix.drupal-release == 'dev'
run: |
Expand Down
62 changes: 50 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dependencies with [Composer](https://getcomposer.org/).
## What does the template do?

* Drupal will be installed in the `web` directory.
* Generated composer autoloader `vendor/autoload.php` is used instead of
* Generated composer autoloader `vendor/autoload.php` is used instead of
`web/vendor/autoload.php` provided by Drupal core.
* Modules (packages of type `drupal-module`) will be placed in `web/modules/contrib` directory.
* Themes (packages of type `drupal-theme`) will be placed in `web/themes/contrib` directory.
Expand Down Expand Up @@ -47,12 +47,50 @@ cd some-dir
composer require drupal/devel
```

### Adding libraries

You can manage front-end asset libraries with Composer thanks to the
[asset-packagist repository](https://asset-packagist.org/). Composer will detect
and install new versions of a library that meet the stated constraints.

```bash
composer require bower-asset/dropzone
```

### Custom installation paths for libraries

The installation path of a specific library can be controlled by adding it to
the `extra.installer-paths` configuration preceding `web/libraries/{$name}`.
For example, the `chosen` Drupal module expects the `chosen` library to be
located on `web/libraries/chosen`, but `composer require npm-asset/chosen-js`
installs the library into `web/libraries/chosen-js`. The following configuration
overrides installation it into the expected directory:

```json
{
"extra": {
"installer-paths": {
"web/libraries/chosen": [
"npm-asset/chosen-js"
],
"web/libraries/{$name}": [
"type:drupal-library",
"type:npm-asset",
"type:bower-asset"
]
}
}
}
```

For more details, see https://asset-packagist.org/site/about

### Updating Drupal Core

This project will attempt to keep all of your Drupal Core files up-to-date; the
project [drupal/core-composer-scaffold](https://github.com/drupal/core-composer-scaffold)
is used to ensure that your scaffold files are updated every time `drupal/core`
is updated.
is used to ensure that your scaffold files are updated every time `drupal/core`
is updated.

If you customize any of the "scaffolding" files (commonly `.htaccess`),
you may need to merge conflicts if any of your modified files are updated in a
Expand All @@ -63,7 +101,7 @@ Follow the steps below to update your Drupal core files.
1. Run `composer update "drupal/core-*" --with-dependencies` to update Drupal Core and its dependencies.
2. Run `git diff` to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
`.htaccess` or `robots.txt`.
`.htaccess` or `robots.txt`.
3. Commit everything all together in a single commit, so `web` will remain in
sync with the `core` when checking out branches or running `git bisect`.
4. In the event that there are non-trivial conflicts in step 2, you may wish
Expand All @@ -83,12 +121,12 @@ workarounds if a project decides to do it anyway](https://getcomposer.org/doc/fa
### Should I commit the scaffolding files?

The [Drupal Composer Scaffold](https://github.com/drupal/core-composer-scaffold)
plugin can download the scaffold files (like `index.php`, `update.php` etc.) to
the `web` directory of your project. If you have not customized those files you
could choose to not check them into your version control system (e.g. git).
If that is the case for your project, it might be convenient to automatically
run the drupal-scaffold plugin after every install or update of your project.
You can achieve that by registering `@composer drupal:scaffold` as `post-install`
plugin can download the scaffold files (like `index.php`, `update.php` etc.) to
the `web` directory of your project. If you have not customized those files you
could choose to not check them into your version control system (e.g. git).
If that is the case for your project, it might be convenient to automatically
run the drupal-scaffold plugin after every install or update of your project.
You can achieve that by registering `@composer drupal:scaffold` as `post-install`
and `post-update` command in your `composer.json`:

```json
Expand All @@ -110,7 +148,7 @@ If you need to apply patches, you can do so with the
[composer-patches](https://github.com/cweagans/composer-patches) plugin included
in this project.

To add a patch to Drupal module `foobar`, insert the `patches` section in the
To add a patch to Drupal module `foobar`, insert the `patches` section in the
`extra` section of `composer.json`:

```json
Expand All @@ -137,7 +175,7 @@ for a package. For example, the minimum version required for Drupal 11.0 is
The purpose of `config.platform` is to set the PHP language requirements for the
specific instance of the package running in the current environment. For
example, while the minimum version required for Drupal 11 is `8.3` or above,
the actual PHP version on the hosting provider could be `8.3.1`. The value of
the actual PHP version on the hosting provider could be `8.3.1`. The value of
this field should provide your exact version of PHP with all 3 parts of the
version.

Expand Down
14 changes: 13 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"drupal/core-composer-scaffold": "^11@alpha",
"drupal/core-recommended": "^11@alpha",
"drush/drush": "^13@beta",
"oomphinc/composer-installers-extender": "^2.0",
"vlucas/phpdotenv": "^5.1",
"webflo/drupal-finder": "^1.2"
},
Expand All @@ -29,6 +30,10 @@
{
"type": "composer",
"url": "https://packages.drupal.org/8"
},
{
"type": "composer",
"url": "https://asset-packagist.org"
}
],
"minimum-stability": "dev",
Expand All @@ -48,6 +53,7 @@
"dealerdirect/phpcodesniffer-composer-installer": true,
"drupal/core-composer-scaffold": true,
"ergebnis/composer-normalize": true,
"oomphinc/composer-installers-extender": true,
"php-http/discovery": true,
"phpstan/extension-installer": true
},
Expand All @@ -66,7 +72,9 @@
"type:drupal-core"
],
"web/libraries/{$name}": [
"type:drupal-library"
"type:drupal-library",
"type:bower-asset",
"type:npm-asset"
],
"web/modules/contrib/{$name}": [
"type:drupal-module"
Expand All @@ -81,6 +89,10 @@
"type:drupal-drush"
]
},
"installer-types": [
"bower-asset",
"npm-asset"
],
"patchLevel": {
"drupal/core": "-p2"
},
Expand Down