Contrib.social

Simplify composer.json

Open on Drupal.org →
Created on 4 April 2025, 3 days ago

Problem/Motivation

I noticed that the description in composer.json no longer matches the project page description ( used in the project browser → ).

For the sake of maintaining fewer lines of code, 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 structure_sync's composer.json...

  1. type: it will be set to drupal-module because the d.o-Project-node type is project_module
  2. license: it will be set to GPL-2.0-or-later, because all projects hosted on d.o must have this license
  3. homepage: it will be set to the d.o-Project-node URL

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.

Proposed resolution

  1. Update the description field in composer.json
  2. Remove the type, homepage, and, license fields in composer.json

Remaining tasks

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

User interface changes

None.

API changes

None.

Data model changes

None.

✨ Feature request
Status

Active

Version

2.0

Component

Code

Created by

🇨🇦Canada mparker17 UTC-4

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024