tribe-libs

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #android #machine-learning #docker #macos #java #awesome #cli #awesome-list #security #mcp

(★ 13)

A library for use on Modern Tribe service projects

tribe-libs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Tribe Libs is a collection of libraries created by Modern Tribe
for use with Square One-based WordPress projects. It is required by the
Square One core plugin.

## Versions

| Tribe Libs Version | PHP Constraints |                                                                                 Notes |
|--------------------|:---------------:|--------------------------------------------------------------------------------------:|
| 3.x                |     7.2-7.4     |                                                  Master branch. No longer maintained. |
| 4.x                |      7.4+       | For use in legacy Square One PHP 7.4 projects where the host is upgrading to PHP 8.0. |
| 5.x+               |     ^8.1        |                                      PHP 8.1+ with PHP-DI 7 and first-party Field Models DTOs. |

## Installation

```
composer require moderntribe/tribe-libs:^5.0
```

### Upgrading from 4.x to 5.x

1. Require PHP **8.1+** in the consuming project.
2. Bump `moderntribe/tribe-libs` (or individual `moderntribe/square1-*` packages) to `^5.0`.
3. Remove any project patches for `php-di/php-di` PHP 8.4 nullable issues — 5.x uses **PHP-DI 7**.
4. Field Models: keep using `Field_Model` / `castValue` / `castType` as before. Spatie DTO is removed; first-party DTOs ship with `Spatie\DataTransferObject\*` class aliases when Spatie is not installed.
5. Do **not** require unpublished `moderntribe/square1-*:^5.0` packages from Packagist until they are released — consume `moderntribe/tribe-libs` (monorepo `replace`) or path/VCS of this repo.

## Usage

All Square One project docs live in the [Square One repository](https://github.com/moderntribe/square-one/tree/master/docs). Package-level READMEs under `src/*/README.md` cover individual libraries.

### Field Models (5.x)

Hydrate typed models from ACF arrays. The public API matches 4.x (`Field_Model`, `castValue`, `castType`); Spatie DTO is no longer a dependency.

```php
use Tribe\Libs\Field_Models\Field_Model;
use Tribe\Libs\Field_Models\Models\Link;

class Card_Fields extends Field_Model {
	public string $heading = '';
	public Link $link;
}

$card = new Card_Fields( (array) get_fields() );

echo $card->heading;
echo $card->link->url;
```

More examples (collections, nested models, Spatie aliases): [src/Field_Models/README.md](src/Field_Models/README.md).

### Mutable Container (PHP-DI 7)

Wrap the app container when you need a fully fresh object graph (queues, long-running jobs):

```php
use Tribe\Libs\Container\Container;
use Tribe\Libs\Container\MutableContainer;

// In a Definer:
MutableContainer::class => static fn ( $c ) => ( new Container() )->wrap( $c ),

// Later:
$fresh = $container->get( MutableContainer::class )->makeFresh( My_Job::class );
```

See [src/Container/README.md](src/Container/README.md).

## Support

Usage of Tribe Libs is not actively supported by Modern Tribe outside of client contracts. Pull requests and suggestions are welcome and will be addressed based on business need.

## Release Process

This library comprises a large collection of smaller libraries that can be included
in whole or in part on Square One projects. These libraries are developed
following the [monorepo model](https://gomonorepo.org/). All changes are
committed to this, the parent project. Maintenance of the individual packages
is managed using the [Monorepo Builder](https://github.com/Symplify/MonorepoBuilder) utility.

### Releasing a new version

> **IMPORTANT:** branches must already exist in the sub-repos, use the [Create Sub-Repo Branch GitHub Workflow](https://github.com/moderntribe/tribe-libs/actions/workflows/sub-repo-branch-create.yml) to create them if they don't already exist.

1. Ensure that all code for the release is merged to the branch that matches the release number, e.g. if you're planning to release an update `4.1.0`, that code should live in the `4.x` branch. A release such as `5.2.6` should live in the `5.x` branch.
1. Ensure that all updates for the release are logged in `CHANGELOG.md` under `## Unreleased`.
1. Run the release script, with the version number for the release (format: `<major>.<minor>.<patch>`):
   Dry run example for a `4.x` release:
   ``` bash
   git checkout 4.x && git pull && ./monorepo.sh release 4.1.0 --dry-run
   ```
   Real release example for a `4.x` release:
   ``` bash
   git checkout 4.x && git pull && ./monorepo.sh release 4.1.0
   ``` 
1. The script will handle several steps for you automatically:
    1. Set any package interdependencies to the new version.
    1. Update `CHANGELOG.md` with the appropriate version number.
    1. Create the git tag and push it to GitHub, tagged to the branch you have checked out.
    1. Bump the **current branch you have checked out** version's to the next version number
1. When the tag is pushed to GitHub, an Action there will automatically split the monorepo and deploy the tag
   to all of the package repos. (Note: The GH Action will run as a bot user with appropriate permissions
   to write to all of the package repositories. Those repositories are read-only for normal usage.)

### Adding Packages

1. Create a new directory for the package in `src`. Create your code there, include an independent
   `composer.json` for the package (you can [copy the sample](dev/monorepo/samples/composer.json)),
   and commit it to tribe-libs.
1. Create an empty public GitHub repository for the package (you probably need to be an org admin to
   complete this step). Follow the naming convention `moderntribe/square1-*`. Ensure that the user `tr1b0t`
   has write access to the repo. Use the script `dev/monorepo/scripts/create-package-repo.sh`
   to create the repo and add the `tr1b0t` user automatically.
   ```bash
   ./dev/monorepo/scripts/create-package-repo.sh square1-my-new-repo
   ```
1. Add a single commit (a blank readme is fine) and push it up.
1. Run the [Create Sub-Repo Branch GitHub Workflow](https://github.com/moderntribe/tribe-libs/actions/workflows/sub-repo-branch-create.yml) to create any missing version branches, e.g. `master`,`4.x`, `5.x` etc...
1. Run the script to merge the package `composer.json` files to the root
   `composer.json` file:
   ```bash
   ./monorepo.sh merge
   ```
1. After the next release, Register the package on [Packagist](https://packagist.org/packages/submit).

### Adding Composer Dependencies

1. Add the dependency to `composer.json` in the sub-package(s) that needs it.
1. Run the `merge` command to merge dependencies up to the root `composer.json`
   ```bash
   ./monorepo.sh merge
   ```

### Update the development version

You will rarely need to do this, but it is documented here just in case.

1. Set the `master` branch alias for all packages:
   ```bash
   ./monorepo.sh set-alias 5.0
   ```
1. Bump the interdependencies among the packages to the same version.
   ```
   ./monorepo.sh bump-interdependency "^5.0"
   ```

tribe-libs

tribe-libs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tribe-libs

tribe-libs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README