Contrib.social

Simplify composer.json

Open on Drupal.org →
Created on 15 October 2024, about 1 month ago

Problem/Motivation

Since we recently updated the d.o-Project-node's summary field for the project browser initiative → , we should update the description field in composer.json too.

We can also remove some fields from composer.json, because the Drupal.org Composer Service (façade) a.k.a. project_composer → rewrites the following fields which are currently defined in ckeditor_abbreviation's composer.json...

  1. type: it will be set to drupal-module because the d.o-Project-node type is project_module
  2. keywords: it will be set to match the d.o-Project-node categories →
  3. license: it will be set to GPL-2.0-or-later, because all projects hosted on d.o must have this license
  4. homepage: it will be set to the d.o-Project-node URL
  5. support/source: it will be set to the URL of the project on git.drupalcode.org
  6. require: it will be set to match the dependencies in the .info.yml file because all current dependencies are Drupal projects

... and fewer lines of code to maintain is appreciated.

For more information, see the following project_composer code: _project_composer_build_component_metadata(), project_composer_get_component_json(), and _project_composer_release_metadata().

Note that project_composer also rewrites the name, but it is one of the few required fields in composer.json, so if someone happens to clone the module, it is nice to have it set, so that Composer doesn't get upset.

Note that project_composer does not automatically insert a support/source key.

Proposed resolution

  1. Update the description field in composer.json
  2. Remove the type, keywords, license, homepage, support/source, and require fields in composer.json

Remaining tasks

  1. Write a patch
  2. Review and feedback
  3. RTBC and feedback
  4. Commit

User interface changes

None.

API changes

None.

Data model changes

None.

✨ Feature request
Status

Active

Version

5.0

Component

Code

Created by

🇨🇦Canada mparker17 UTC-4

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024