Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gocom/textpattern-installer
Textpattern plugin and theme installer for Composer
https://github.com/gocom/textpattern-installer
composer composer-installer composer-plugin php textpattern textpattern-development textpattern-plugin
Last synced: about 1 month ago
JSON representation
Textpattern plugin and theme installer for Composer
- Host: GitHub
- URL: https://github.com/gocom/textpattern-installer
- Owner: gocom
- License: gpl-2.0
- Created: 2013-04-27T21:22:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-11-19T14:44:24.000Z (about 2 years ago)
- Last Synced: 2024-11-15T21:42:27.583Z (about 1 month ago)
- Topics: composer, composer-installer, composer-plugin, php, textpattern, textpattern-development, textpattern-plugin
- Language: PHP
- Homepage: https://textpattern.com
- Size: 157 KB
- Stars: 6
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Textpattern Installer for Composer
=====
[Package directory](https://packagist.org/search/?q=textpattern) | [Issues](https://github.com/gocom/textpattern-installer/issues)
Install plugins and themes to [Textpattern CMS](https://textpattern.com)
with [Composer](https://getcomposer.org/) dependency manager.
```shell
$ composer require rah/rah_replace
```
Why Composer?
-----
Normally installing Textpattern plugins requires that you manually download an
installation package, upload the package through your admin-panel, and then go
through a multi-step installer process; rinse and repeat for every plugin, and
when you need to update one.
With [Composer](https://getcomposer.org/), it's all managed through the
dependency manager. Any theme or a plugin can be installed, updated or
uninstalled, using a single command. This also comes with all the other
Composer's benefits such as being able to commit your package manifesto under
version control system and all of your project teammates will have the same
set of plugins synced without any extra fiddling.
Quick start for end-users
-----
After [installing Composer](https://getcomposer.org/doc/00-intro.md) to your
host system that Textpattern is installed on, you can start adding plugins
to Textpattern with Composer from command line.
First, head over to your Textpattern installation location, and tell
Composer your Textpattern installation version by installing
[textpattern/lock](https://github.com/gocom/textpattern-lock) meta-package:
```shell
$ cd /path/to/your/textpattern/installation/root
$ composer require textpattern/lock:4.6.2
```
After that, you can add any plugins and themes to your Textpattern installation
like any other Composer packages:
```shell
$ composer require rah/rah_replace rah/rah_flat
```
Always run Composer commands in Textpattern installation directory, or in a
directory right above it; the Composer installer supports installing Textpattern
to a sub-directory, which would allow Textpattern to be within public HTTP
server root directory, while Composer packages can be in a directory above it.
Quick start for developers
-----
Plugins and themes are just like any other normal Composer package, but with a
special [type](https://getcomposer.org/doc/04-schema.md#type) and a matching
installer requirement in your
[composer.json](https://getcomposer.org/doc/04-schema.md). The package should be
named after the plugin or the theme too. An example `composer.json` stub would
look like the following:
```json
{
"name": "vendor/pfx_pluginname",
"type": "textpattern-plugin",
"require": {
"textpattern/installer" : "*"
}
}
```
### Package types
| Type | Description |
|------------------------|-------------|
| `textpattern-plugin` | The package contains manifest.json formatted plugin sources. See [an example plugin](https://github.com/gocom/abc_plugin) |
| `textpattern-plugin-package`| The package contains collection of compiled plugin installer files. Any file that's name matches the format `pfx_pluginname_v0.1.0.txt` will be installed. |
| `textpattern-admin-theme` | The package is [an admin-side theme](https://docs.textpattern.com/themes/admin-side-themes). See [an example admin-theme](https://github.com/gocom/abc_theme). |
| `textpattern-public-theme` | The package is [a front-end theme](https://docs.textpattern.com/themes/front-end-themes) |
Internals
-----
The installer works by scanning `composer.json` file's sibling and child
directories for a Textpattern installation. If found, it injects the whole
Textpattern application to the currently running Composer process. It then
collects any plugins and themes from Composer packages and installs them,
invoking plugin-lifecycle updaters and installers as needed. This process
can be compatible with, and used by, any plugin or a theme.
The installer doesn't require any extra configuration from the end-user or the
developer. All it needs is a functional Textpattern installation, located
either in the same directory as the `composer.json` file or in a child
directory. Just note that the system the Composer command is ran at, needs to
have access to the database; take this in mind if you are, for instance, running
the composer command outside a virtualized container.
Requirements
-----
* [Composer](https://getcomposer.org/) 1.x, 2.x
* [Textpattern CMS](https://textpattern.com/) 4.4.1, 4.5.7, 4.6.x, 4.7.x, 4.8.x
* [PHP](https://secure.php.net/) >= 5.5.38
* [PDO](https://secure.php.net/manual/en/book.pdo.php)
Development
----
See [CONTRIBUTING.md](CONTRIBUTING.md)