Skip to content

Commit e227780

Browse files
[TASK] Use composer.json only for extension title (#6279)
Resolves: TYPO3-Documentation/Changelog-To-Doc#1501 Releases: main
1 parent 2121750 commit e227780

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ This is a minimal :file:`composer.json <extension-composer-json>` for a TYPO3 ex
7575

7676
* The vendor name is `MyVendor`.
7777
* The :ref:`extension key <extension-key>` is `my_extension`.
78+
* The extension title is `My Extension` and the description is `An example extension`.
7879

7980
Subsequently:
8081

@@ -127,6 +128,8 @@ Extended composer.json
127128
Properties
128129
==========
129130

131+
.. _ext-composer-json-property-name:
132+
130133
name
131134
----
132135

@@ -141,12 +144,22 @@ uppercase / lowercase spelling, for example: The PHP namespace
141144
:php:`JohnDoe\SomeExtension` may be `johndoe/some-extension` in
142145
:file:`composer.json <extension-composer-json>`.
143146

147+
.. _ext-composer-json-property-description:
148+
144149
description
145150
-----------
146151

152+
.. versionchanged:: 14.0
153+
Extension titles were previously taken from file :file:`ext_emconf.php` but
154+
in Composer mode the :file:`ext_emconf.php` file is no longer necessary. The
155+
description field in :file:`composer.json` is exploded to get the extension
156+
title (in front of "-") and the extension description (after "-").
157+
147158
(*required*)
148159

149-
Description of your extension (1 line).
160+
This field contains the extension title and the description of your extension
161+
(1 line). The title is separated from the description by a dash "-". If there is no
162+
dash, the title will be the entire description.
150163

151164
.. _ext-composer-json-property-type:
152165

Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_ExtendedComposer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "my-vendor/my-extension",
33
"type": "typo3-cms-extension",
4-
"description": "An example extension",
4+
"description": "My Extension - An example extension",
55
"license": "GPL-2.0-or-later",
66
"require": {
77
"php": "^8.1",

Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_MinimalComposer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "my-vendor/my-extension",
33
"type": "typo3-cms-extension",
4-
"description": "An example extension",
4+
"description": "My Extension - An example extension",
55
"license": "GPL-2.0-or-later",
66
"require": {
77
"typo3/cms-core": "^12.4 || ^13.4"

0 commit comments

Comments
 (0)