Skip to content

[!!!][TASK] Require composer.json in classic mode #6268

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[!!!][TASK] Require composer.json in classic mode #6268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 11 additions & 14 deletions Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@
`composer.json`
===============

*-- required* in Composer-based installations
.. important::

.. versionchanged:: 14.0
With TYPO3 14.0 a valid composer.json is required for all TYPO3 extensions,
including those only used in Classic-mode installations.

*-- required* in **all** installations

.. typo3:file:: composer.json
:name: extension-composer-json
Expand Down Expand Up @@ -48,20 +54,11 @@ easy way via the :bash:`composer require` command.
About the composer.json file
============================

.. note::
While the file :file:`composer.json <extension-composer-json>` is currently not strictly required
for an extension to function properly in Classic mode installations (no Composer)
it is recommended to keep it in any public extension that is published to
`TYPO3 Extension Repository (TER) <https://extensions.typo3.org/>`__.

Including a :file:`composer.json <extension-composer-json>` is strongly recommended for a number of
reasons:

#. The file :file:`composer.json <extension-composer-json>` is required for documentation that should
appear on `docs.typo3.org <https://docs.typo3.org/>`__.
Including a :file:`composer.json <extension-composer-json>` is **required**.

See :ref:`h2document:migrate` for more information on the necessary changes
for rendering of extension documentation.
#. Without a valid :file:`composer.json <extension-composer-json>` an extension
is not installable in TYPO3, even in Classic mode installations not using
Composer.

#. Working with Composer in general is strongly recommended for TYPO3.

Expand Down