analia-mok/tweak-cli

An opinionated bootstrapper tool for setting up Lando-based projects.

0.1.0 2020-04-04 19:17 UTC

Requires

• php: ^7.2
• laminas/laminas-text: ^2.7
• laravel-zero/framework: ^7.0
• spatie/laravel-enum: ^1.4
• symfony/yaml: ^5.0
• titasgailius/terminal: ^0.2.2

Requires (Dev)

• mockery/mockery: ^1.3.1
• phpunit/phpunit: ^8.5

MIT

• Analia Mok

• php
• cli
• tweak
• lando

README

An opinionated bootstrapper tool for setting up Lando-based projects.

At GeekHive, we've standardized on using Lando for local development on WordPress and Drupal projects. However, for every new project, I always have to tweak (hint hint nudge nudge) the Lando config to add a set of helper tooling to make the team's life easier. So here is Tweak CLI, a simple tool for adding our helper commands and scripts to new projects.

Currently, the tool tweaks in yaml configuration and bash scripts into your current project. When the latest release of Lando is out, we will convert most - if not all - of the helpers into a proper Lando plugin.

Installation

Run composer global require analia-mok/tweak-cli

Upgrading

Run composer global update analia-mok/tweak-cli

How to Use

Make sure you have ~/.composer/vendor/bin in your terminal's path.

Preferably, you will already have created your project on Pantheon and have run lando init.

Once done, simply run tweak in and you will be set up with all of Tweak's helpers.

Pre-1.0 Goals

• Implement tweak in: Primary command for "tweaking in" helper scripts and adjusting your lando.yml file.
• Support Pantheon-hosted projects
• Support composer and non-composer projects
• Support WordPress and Drupal
• Adjust pulldb and pullfiles scripts to allow selection of environments.
• Add better test coverage...

Future Goals

• CI/CD file generation. We do have a standard set of CircleCI-related files that barely change from project to project that we could share.
  • Ex. WordPress + Pantheon's CircleCI Orb.
• Opt-in to tweak in pantheon.yml configuration for quicksilver (e.g. Slack, New Relic Notifications)
• There's some caveats to using Symfony's Process component for running external commands. It would be convenient to run lando init if the current project to tweak in does not a lando.yml yet.
• Support other hosting platforms that are lando friendly, such as Platform.sh.
• Add Laravel helpers support