Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cundd/cundd_composer
Composer support for TYPO3 CMS
https://github.com/cundd/cundd_composer
composer cundd-composer php typo3 typo3-cms
Last synced: 3 months ago
JSON representation
Composer support for TYPO3 CMS
- Host: GitHub
- URL: https://github.com/cundd/cundd_composer
- Owner: cundd
- Created: 2012-12-24T09:43:25.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T10:38:19.000Z (over 2 years ago)
- Last Synced: 2023-10-20T19:08:35.931Z (over 1 year ago)
- Topics: composer, cundd-composer, php, typo3, typo3-cms
- Language: PHP
- Size: 2.39 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Cundd Composer
==============
[Composer](http://getcomposer.org/) support for TYPO3 CMS.
Installation
============
Install from [TER](https://typo3.org/extensions/repository/view/cundd_composer) or clone the source
with `git clone https://github.com/cundd/cundd_composer.git cundd_composer` and install Cundd Composer as usual through
the Extension Manager.
Usage
=====
Make sure the extensions that provide a `composer.json` for Cundd Composer are already installed before running Cundd
Composer's install or update commands. Only properly installed TYPO3 extensions are checked for a `composer.json` file.
via backend module
------------------
 Icon of the
Cundd Composer module
Let's assume we want to install the Composer dependencies for an TYPO3 extension called `MyExt`. In the root directory
of the extension a valid `composer.json` file exists which contains the `extra` section for `cundd/composer`:
```json
{
"extra": {
"cundd/composer": {
"install": true
}
}
}
```
1. Install `MyExt` through the Extension Manager
2. Go to the `Composer` module in the Tools section
3. Check the preview of the merged `composer.json`
4. Click on `Install` or `Update` to tell Composer to install requirements
via command line
----------------
TYPO3 based CLI commands are available to manage dependencies.
### composer:install
Installs the project dependencies from the `composer.lock` file (in `EXT:cundd_composer/Resources/Private/Temp/`) if
present, or falls back on the `composer.json`.
```bash
typo3 cundd-composer:install
```
### composer:update
Updates your dependencies to the latest version according to `composer.json`, and updates the `composer.lock`
file (in `EXT:cundd_composer/Resources/Private/Temp/`).
```bash
typo3 cundd-composer:update
```
### composer:installassets
Install available assets.
```bash
typo3 cundd-composer:install-assets
```
### composer:list
List information about the required packages.
```bash
typo3 cundd-composer:list
```
### composer:exec
Execute an arbitrary composer command.
```bash
typo3 cundd-composer:exec -- info
```
### cundd-composer:write-composer-json
Write the merged composer.json.
```bash
typo3 cundd-composer:write-composer-json
```
For extension developers
------------------------
Place a valid `composer.json` ([The composer.json Schema](https://getcomposer.org/doc/04-schema.md)) file in the root
directory of your extension and add the required `extra` section. If you want to use the Composer packages in a fronted
extension you can simply use the package classes. In case of a backend module you have to register the Cundd Composer
autoloader through `\Cundd\CunddComposer\Autoloader::register()`.
Assets
======
The Asset Installer loops through all the installed composer packages and checks if they contain one of the directories
defined in the extension manager (configuration name: `assetPaths`, defaults: `Resources/Public/`, `build`, `lib`, `js`
, `font`, `less` and `sass`). If one of the directories exist, a symlink to the directory will be created inside of
Cundd Composer's `Resources/Public/Assets/` folder.
Before the Asset Installer can be used, it has to be enabled in the extension manager. Therefore `allowInstallAssets`
has to be checked. If `automaticallyInstallAssets` (and `allowInstallAssets`) is enabled the Assets will be installed
automatically after Cundd Composer's `install` or `update` function is invoked.
Example
-------
If the package `foo/bar` contains the directory `Resources/Public/` Cundd Composer will create a symlink
at `EXT:cundd_composer/Resources/Public/Assets/foo_bar/` which will point
to `EXT:cundd_composer/vendor/foo/bar/Resources/Public/`.
Aim
---
The aim of the Asset Installer is to provide a schema to reference asset files and to publish those files in a public
folder, which allows the `vendor` directory to be inaccessible for browsers.
Maintenance
===========
The Composer binary is located in `./typo3conf/ext/cundd_composer/Resources/Private/PHP/composer.phar`. The
generated `composer.json`, cache and configuration files are saved
in `./typo3conf/ext/cundd_composer/Resources/Private/Temp/`.
Update the Composer binary to the latest version
------------------------------------------------
```bash
./typo3conf/ext/cundd_composer/Resources/Private/PHP/composer.phar selfupdate
```
Retrieve Composer configuration
-------------------------------
```bash
COMPOSER=./typo3conf/ext/cundd_composer/Resources/Private/Temp/composer.json \
./typo3conf/ext/cundd_composer/Resources/Private/PHP/composer.phar config -l
```
Set OAuth tokens for API rate limit
-----------------------------------
```bash
COMPOSER_HOME=./typo3conf/ext/cundd_composer/Resources/Private/Temp/ \
./typo3conf/ext/cundd_composer/Resources/Private/PHP/composer.phar config -g \
github-oauth.github.com theOauthToken
```
Clear the internal package cache
--------------------------------
```bash
COMPOSER_HOME=./typo3conf/ext/cundd_composer/Resources/Private/Temp \
./typo3conf/ext/cundd_composer/Resources/Private/PHP/composer.phar clearcache
```
Breaking changes
================
Breaking changes in Cundd Composer 3.0
--------------------------------------
The class name without namespaces has been removed `Tx_CunddComposer_Autoloader`.
Upgrade to TYPO3 6.2
--------------------
TYPO3 6.2 will parse the extensions `composer.json` files and retrieve different information from it. TYPO3's new
Package Manager also allows the definition of dependencies. Unfortunately these dependencies are limited to real TYPO3
extension. If you want to install an extension, which requires a non-TYPO3 package in `composer.json`, the Package
Manager tries to resolve this dependency in vain and the installation fails.
To work around this issue cundd_composer will look for the file `cundd_composer.json` instead of `composer.json`. For
legacy reasons cundd_composer will still use `composer.json` TYPO3 versions below 6.2.
**Please check the installed extensions before upgrading to TYPO3 6.2.**
Sponsored by
============
[](http://www.iresults.li)