From 7d073337c62f41233c31bb6d245c4ccdac0a987c Mon Sep 17 00:00:00 2001 From: Alex Pott <alex.a.pott@googlemail.com> Date: Wed, 30 Oct 2019 17:12:29 +0100 Subject: [PATCH] Issue #3090684 by Mixologic, greg.1.anderson, opdavies, alexpott: Rename drupal/dev-dependencies and drupal/pinned-dev-dependencies (cherry picked from commit 7d71991c2dfba69c6416936e2b5f499bf8411548) --- .../Builder/DrupalCoreRecommendedBuilder.php | 4 +-- .../Builder/DrupalDevDependenciesBuilder.php | 4 +-- .../DrupalPinnedDevDependenciesBuilder.php | 4 +-- .../Metapackage/DevDependencies/composer.json | 2 +- .../PinnedDevDependencies/composer.json | 2 +- composer/Metapackage/README.txt | 28 +++++++++---------- composer/Template/LegacyProject/composer.json | 2 +- .../Template/RecommendedProject/composer.json | 2 +- .../Tests/Composer/Generator/BuilderTest.php | 4 +-- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/composer/Generator/Builder/DrupalCoreRecommendedBuilder.php b/composer/Generator/Builder/DrupalCoreRecommendedBuilder.php index 7964f0610b5f..1dc0a0989b45 100644 --- a/composer/Generator/Builder/DrupalCoreRecommendedBuilder.php +++ b/composer/Generator/Builder/DrupalCoreRecommendedBuilder.php @@ -33,8 +33,8 @@ public function getPackage() { // Copy the 'packages' section from the Composer lock into our 'require' // section. There is also a 'packages-dev' section, but we do not need // to pin 'require-dev' versions, as 'require-dev' dependencies are never - // included from subprojects. Use 'drupal/core-dev-dependencies' to get - // Drupal's dev dependencies. + // included from subprojects. Use 'drupal/core-dev' to get Drupal's + // dev dependencies. foreach ($composerLockData['packages'] as $package) { // If there is no 'source' record, then this is a path repository // or something else that we do not want to include. diff --git a/composer/Generator/Builder/DrupalDevDependenciesBuilder.php b/composer/Generator/Builder/DrupalDevDependenciesBuilder.php index 0b68b4a0e46f..43e80fc37d7f 100644 --- a/composer/Generator/Builder/DrupalDevDependenciesBuilder.php +++ b/composer/Generator/Builder/DrupalDevDependenciesBuilder.php @@ -3,7 +3,7 @@ namespace Drupal\Composer\Generator\Builder; /** - * Builder to produce metapackage for drupal/dev-dependencies. + * Builder to produce metapackage for drupal/core-dev. */ class DrupalDevDependenciesBuilder extends DrupalPackageBuilder { @@ -49,7 +49,7 @@ public function getPackage() { */ protected function initialPackageMetadata() { return [ - "name" => "drupal/dev-dependencies", + "name" => "drupal/core-dev", "type" => "metapackage", "description" => "require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.", "license" => "GPL-2.0-or-later", diff --git a/composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php b/composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php index 4a4abb3c1cc8..9e4c9724d6b4 100644 --- a/composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php +++ b/composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php @@ -3,7 +3,7 @@ namespace Drupal\Composer\Generator\Builder; /** - * Builder to produce metapackage for drupal/pinned-dev-dependencies. + * Builder to produce metapackage for drupal/core-dev-pinned. */ class DrupalPinnedDevDependenciesBuilder extends DrupalPackageBuilder { @@ -53,7 +53,7 @@ public function getPackage() { */ protected function initialPackageMetadata() { return [ - "name" => "drupal/pinned-dev-dependencies", + "name" => "drupal/core-dev-pinned", "type" => "metapackage", "description" => "Pinned require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.", "license" => "GPL-2.0-or-later", diff --git a/composer/Metapackage/DevDependencies/composer.json b/composer/Metapackage/DevDependencies/composer.json index 2557d6f64440..3da97fde2669 100644 --- a/composer/Metapackage/DevDependencies/composer.json +++ b/composer/Metapackage/DevDependencies/composer.json @@ -1,5 +1,5 @@ { - "name": "drupal/dev-dependencies", + "name": "drupal/core-dev", "type": "metapackage", "description": "require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.", "license": "GPL-2.0-or-later", diff --git a/composer/Metapackage/PinnedDevDependencies/composer.json b/composer/Metapackage/PinnedDevDependencies/composer.json index 0955f3521d25..ebfea238476e 100644 --- a/composer/Metapackage/PinnedDevDependencies/composer.json +++ b/composer/Metapackage/PinnedDevDependencies/composer.json @@ -1,5 +1,5 @@ { - "name": "drupal/pinned-dev-dependencies", + "name": "drupal/core-dev-pinned", "type": "metapackage", "description": "Pinned require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.", "license": "GPL-2.0-or-later", diff --git a/composer/Metapackage/README.txt b/composer/Metapackage/README.txt index 440e89e0a97b..ffdb8847e94b 100644 --- a/composer/Metapackage/README.txt +++ b/composer/Metapackage/README.txt @@ -15,20 +15,20 @@ Drupal Core provides three metapackages that serve different purposes. diagram below. This relationship makes it easier for Composer to update a Drupal project. - - drupal/dev-dependencies: This project provides the same version constraints - as Drupal uses for testing. It is useful for projects that either wish to - run some of the Drupal tests directly, or for projects that may wish to use - the same components that Drupal does for testing. + - drupal/core-dev: This project provides the same version constraints as Drupal + uses for testing. It is useful for projects that either wish to run some of + the Drupal tests directly, or for projects that may wish to use the same + components that Drupal does for testing. - - drupal/pinned-dev-dependencies: This project should be used INSTEAD OF - drupal/dev-dependencies in instances where a project wishes to pin to the - exact version of each testing dependency used in Drupal. This in general - should not be necessary. + - drupal/core-dev-pinned: This project should be used INSTEAD OF + drupal/core-dev in instances where a project wishes to pin to the exact + version of each testing dependency used in Drupal. This in general should not + be necessary. Note that a project that uses both drupal/core-recommended and -drupal/pinned-dev-dependencies must update them both at the same time, e.g.: +drupal/core-dev-pinned must update them both at the same time, e.g.: - composer update drupal/core-recommended drupal/pinned-dev-dependencies --with-updates + composer update drupal/core-recommended drupal/core-dev-pinned --with-updates Composer may have trouble with the update if one of these projects is listed on the command line without the other. Running composer update without any @@ -39,8 +39,8 @@ updated. ## Metapackage Usage in Template Projects The relationship between the metapackages drupal/core-recommended and -drupal/dev-dependencies and the project (subtree split) drupal/core, as -used in the drupal/recommended-project is shown below: +drupal/core-dev and the project (subtree split) drupal/core, as used in the +drupal/recommended-project is shown below: +----------------------------+ | drupal/recommended-project | @@ -55,7 +55,7 @@ used in the drupal/recommended-project is shown below: +--"require-dev": | | +-------------------------+ - +-->| drupal/dev-dependencies | + +-->| drupal/core-dev | +-------------------------+ If a user does not wish to pin their Drupal project's dependencies to the same @@ -63,4 +63,4 @@ versions used in drupal/core, then they should replace drupal/core-recommended with drupal/core in their "require" section. If a user does not need the testing dependencies in their Drupal project, then -they may simply remove drupal/dev-dependencies from the "require-dev" section. +they may simply remove drupal/core-dev from the "require-dev" section. diff --git a/composer/Template/LegacyProject/composer.json b/composer/Template/LegacyProject/composer.json index 51aced4574f2..45c53b076bbc 100644 --- a/composer/Template/LegacyProject/composer.json +++ b/composer/Template/LegacyProject/composer.json @@ -16,7 +16,7 @@ "drupal/core-vendor-hardening": "^8.8" }, "require-dev": { - "drupal/dev-dependencies": "^8.8" + "drupal/core-dev": "^8.8" }, "conflict": { "drupal/drupal": "*" diff --git a/composer/Template/RecommendedProject/composer.json b/composer/Template/RecommendedProject/composer.json index 98189b3105d7..cf5ff8b901d2 100644 --- a/composer/Template/RecommendedProject/composer.json +++ b/composer/Template/RecommendedProject/composer.json @@ -15,7 +15,7 @@ "drupal/core-composer-scaffold": "^8.8" }, "require-dev": { - "drupal/dev-dependencies": "^8.8" + "drupal/core-dev": "^8.8" }, "conflict": { "drupal/drupal": "*" diff --git a/core/tests/Drupal/Tests/Composer/Generator/BuilderTest.php b/core/tests/Drupal/Tests/Composer/Generator/BuilderTest.php index 385b6a996f4e..1c108659878d 100644 --- a/core/tests/Drupal/Tests/Composer/Generator/BuilderTest.php +++ b/core/tests/Drupal/Tests/Composer/Generator/BuilderTest.php @@ -42,7 +42,7 @@ public function builderTestData() { [ DrupalDevDependenciesBuilder::class, [ - 'name' => 'drupal/dev-dependencies', + 'name' => 'drupal/core-dev', 'type' => 'metapackage', 'description' => 'require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.', 'license' => 'GPL-2.0-or-later', @@ -60,7 +60,7 @@ public function builderTestData() { [ DrupalPinnedDevDependenciesBuilder::class, [ - 'name' => 'drupal/pinned-dev-dependencies', + 'name' => 'drupal/core-dev-pinned', 'type' => 'metapackage', 'description' => 'Pinned require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.', 'license' => 'GPL-2.0-or-later', -- GitLab