Textpattern-installer - Textpattern plugin and theme installer for Composer

Jukka Svahn

Last update: Apr 14, 2022

Related tags

Miscellaneous php composer composer-installer composer-plugin textpattern textpattern-plugin textpattern-development

Overview

Textpattern Installer for Composer

Package directory | Issues

Install plugins and themes to Textpattern CMS with Composer.

$ composer require rah/rah_replace

Overview

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, it's all managed through the dependency manager. Any theme or a plugin can be installed, updated or uninstalled, using a single command. And it comes with all other Composers benefits such as being able to commit your package manifesto under version control system and all of your teammates will have the same set of plugins synched without any extra fiddling.

Quick start for end-users

After installing Composer to the host system your Textpattern installation is running on:

$ cd /path/to/your/textpattern/installation/root
$ composer require textpattern/lock:4.6.2
$ composer require rah/rah_replace rah/rah_flat

As in the above, to set up:

Navigate to your Textpattern installation location containing a textpattern directory and a index.php file.
Lock-in your installed Textpattern version using the textpattern/lock meta-package so that Composer knows your Textpattern version.
You can now install any plugins, themes and libraries like any other Composer package.

Quick start for developers

Plugins and themes are just like any other normal Composer package, but with a special type and a matching installer requirement in your composer.json. The package should be named after the plugin or the theme too. An example composer.json stub would look like the following:

{
  "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
`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. See an example admin-theme.
`textpattern-public-theme`	The package is a front-end theme

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

Textpattern CMS 4.4.1, 4.5.7, 4.6.x, 4.7.x
PHP >=5.5.38
PDO

Comments

Uses Textile in help files

Hi @gocom, I recently started to make my plugins available via Composer but I meet the same issue I get during your absence with MassPlugCompiler: help files are not textilized correctly. Id's, Classes and notextile. tags are removed, so it breaks many stuff in my styled files. I forked your MassPlugCompiler repo in the past to quickly include Textile and also add a mulptile help files support but I'm not sure what could be done with this repo to fix the issue and get a tidy plugin doc. when installed via Composer.

Edit: This version of oui_player can be tested if you need an example; compiled files (via my MassPlugCompiler fork) work nicely but are broken when installed via Composer.

Edit#2: Because I'm not sure why Textpattern does not correctly apply Textile by itself on plugins install, I posted a new a thread on the forum.

opened by NicolasGraph 2
Admin theme path needs updating

In line with the recent relocation of the /textpattern/themes directory to /textpattern/admin-themes, this line needs changing in Installer/AdminTheme.php.

opened by jools-r 2
Uninstaller appears to be broken

Investigation necessary, but it appears that the uninstaller does not run properly and dies midway, resulting in a half-removal. I believe that composer lock file is neither update, only composer.json is modified when remove is called.
bug investigate

opened by gocom 1
Themes don't support deep directory structures
Unlike plugins, themes currently do not work with deep directory structures. Installation will fail if composer.json isn't placed next to the textpattern/ directory.

This needs to be supported since we shouldn't require that:

User needs to navigate away from project root when updating packages (all meta should be there).

Or have to set the project root as the server document root.

bug
opened by gocom 0
Install may die on a theme init error
If the theme errors or is removed between installs/updates, Composer will die on the following error:

cannot_instantiate_theme: pohjola, pohjola_theme

...because old-school Textpattern uses explicit process termination instead of Exceptions.

We should either:

Try to simulate Textpattern admin-side interface, skipping theme.

Default to core theme.
opened by gocom 0

Releases(1.0.14)

1.0.14(Apr 23, 2022)
Allow installing Textpattern plugins as dependencies outside a Textpattern installation as a normal library.

Source code(tar.gz)
Source code(zip)
1.0.13(Apr 23, 2022)
Fixed: Textpattern >= 4.8 compatibility on PHP >= 8.1. Before would halt to trying to access array offset on value of type null error about $txp_sections global variable on PHP >= 8.1.

Source code(tar.gz)
Source code(zip)
1.0.12(Apr 14, 2022)
Fixed: Composer compatibility regression introduced in the last release. Now truly supports Composer >= 2.0.0.

Source code(tar.gz)
Source code(zip)
1.0.11(Apr 14, 2022)
Fixed: Composer >= 2.0.0 compatibility.

Fixed: Textpattern 4.8.x compatibility.

Source code(tar.gz)
Source code(zip)
1.0.10(Apr 14, 2022)
Fixed: Incorrect method call.

Source code(tar.gz)
Source code(zip)

Owner

Jukka Svahn

Backend developer by trade, hobbyist designer and frontend fiddler, self-proclaimed home cook and baker

GitHub https://textpattern.com

Ied plugin composer - Inspired Plugin Composer: Create, publish and edit plugins from within Textpattern CMS.

ied_plugin_composer Create, publish and edit plugins from within Textpattern CMS. Creates a new page under the Extensions tab where you can edit and e

8 Oct 3, 2020

A composer plugin, to install differenty types of composer packages in custom directories outside the default composer default installation path which is in the vendor folder.

composer-custom-directory-installer A composer plugin, to install differenty types of composer packages in custom directories outside the default comp