jakzal/toolbox jakzal/toolbox

  • Stars
    star
    183
  • Rank 209,533 (Top 5 %)
  • Language
    PHP
  • License
    MIT License
  • Created about 6 years ago
  • Updated 4 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
jakzal/toolbox
github

jakzal

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Helps to discover and install tools

Toolbox

Build Status Build Status

Helps to discover and install tools.

Use cases

Toolbox started its life as a simple script in the phpqa docker image. Its purpose was to install set of tools while building the docker image and it's still its main goal. It has been extracted as a separate project to make maintenance easier and enable new use cases.

Available tools

Name Description PHP 8.0 PHP 8.1 PHP 8.2
behat Helps to test business expectations ✅ ✅ ✅
box Fast, zero config application bundler with PHARs ❌ ✅ ✅
box-3 Fast, zero config application bundler with PHARs ✅ ✅ ❌
churn Discovers good candidates for refactoring ✅ ✅ ✅
codeception Codeception is a BDD-styled PHP testing framework ✅ ✅ ✅
composer Dependency Manager for PHP ✅ ✅ ✅
composer-bin-plugin Composer plugin to install bin vendors in isolated locations ✅ ✅ ✅
composer-normalize Composer plugin to normalize composer.json files ✅ ✅ ✅
composer-require-checker Verify that no unknown symbols are used in the sources of a package. ❌ ✅ ✅
composer-require-checker-3 Verify that no unknown symbols are used in the sources of a package. ✅ ✅ ✅
composer-unused Show unused packages by scanning your code ✅ ✅ ✅
dephpend Detect flaws in your architecture ✅ ✅ ✅
deprecation-detector Finds usages of deprecated code ✅ ✅ ✅
deptrac Enforces dependency rules between software layers ❌ ✅ ✅
diffFilter Applies QA tools to run on a single pull request ✅ ✅ ✅
ecs Sets up and runs coding standard checks ✅ ✅ ✅
infection AST based PHP Mutation Testing Framework ❌ ✅ ✅
larastan PHPStan extension for Laravel ✅ ✅ ✅
local-php-security-checker Checks composer dependencies for known security vulnerabilities ✅ ✅ ✅
parallel-lint Checks PHP file syntax ✅ ✅ ✅
paratest Parallel testing for PHPUnit ✅ ✅ ✅
pdepend Static Analysis Tool ✅ ✅ ✅
phan Static Analysis Tool ✅ ✅ ✅
phive PHAR Installation and Verification Environment ✅ ✅ ✅
php-coupling-detector Detects code coupling issues ✅ ✅ ✅
php-cs-fixer PHP Coding Standards Fixer ✅ ✅ ✅
php-fuzzer A fuzzer for PHP, which can be used to find bugs in libraries by feeding them 'random' inputs ✅ ✅ ✅
php-semver-checker Suggests a next version according to semantic versioning ✅ ✅ ✅
phpa Checks for weak assumptions ✅ ✅ ✅
phparkitect Helps to put architectural constraints in a PHP code base ✅ ✅ ✅
phpat Easy to use architecture testing tool ✅ ✅ ✅
phpbench PHP Benchmarking framework ✅ ✅ ✅
phpca Finds usage of non-built-in extensions ✅ ✅ ✅
phpcb PHP Code Browser ✅ ✅ ✅
phpcbf Automatically corrects coding standard violations ✅ ✅ ✅
phpcodesniffer-composer-install Easy installation of PHP_CodeSniffer coding standards (rulesets). ✅ ✅ ✅
phpcov a command-line frontend for the PHP_CodeCoverage library ❌ ✅ ✅
phpcpd Copy/Paste Detector ✅ ✅ ✅
phpcs Detects coding standard violations ✅ ✅ ✅
phpcs-security-audit Finds vulnerabilities and weaknesses related to security in PHP code ✅ ✅ ✅
phpda Generates dependency graphs ✅ ❌ ❌
phpdd Finds usage of deprecated features ✅ ✅ ✅
phpDocumentor Documentation generator ✅ ✅ ✅
phpinsights Analyses code quality, style, architecture and complexity ✅ ✅ ✅
phplint Lints php files in parallel ✅ ✅ ✅
phploc A tool for quickly measuring the size of a PHP project ✅ ✅ ✅
phpmd A tool for finding problems in PHP code ✅ ✅ ✅
phpmetrics Static Analysis Tool ✅ ✅ ✅
phpmnd Helps to detect magic numbers ✅ ✅ ✅
phpspec SpecBDD Framework ✅ ✅ ❌
phpstan Static Analysis Tool ✅ ✅ ✅
phpstan-banned-code PHPStan rules for detecting calls to specific functions you don't want in your project ✅ ✅ ✅
phpstan-beberlei-assert PHPStan extension for beberlei/assert ✅ ✅ ✅
phpstan-deprecation-rules PHPStan rules for detecting deprecated code ✅ ✅ ✅
phpstan-doctrine Doctrine extensions for PHPStan ✅ ✅ ✅
phpstan-ergebnis-rules Additional rules for PHPstan ✅ ✅ ✅
phpstan-exception-rules PHPStan rules for checked and unchecked exceptions ✅ ✅ ✅
phpstan-larastan Separate installation of phpstan for larastan ✅ ✅ ✅
phpstan-phpunit PHPUnit extensions and rules for PHPStan ✅ ✅ ✅
phpstan-strict-rules Extra strict and opinionated rules for PHPStan ✅ ✅ ✅
phpstan-symfony Symfony extension for PHPStan ✅ ✅ ✅
phpstan-webmozart-assert PHPStan extension for webmozart/assert ✅ ✅ ✅
phpunit The PHP testing framework ❌ ✅ ✅
phpunit-8 The PHP testing framework (8.x version) ✅ ✅ ✅
phpunit-9 The PHP testing framework (9.x version) ✅ ✅ ✅
pint Opinionated PHP code style fixer for Laravel ✅ ✅ ✅
psalm Finds errors in PHP applications ✅ ✅ ✅
psalm-plugin-doctrine Stubs to let Psalm understand Doctrine better ✅ ✅ ✅
psalm-plugin-phpunit Psalm plugin for PHPUnit ✅ ✅ ✅
psalm-plugin-symfony Psalm Plugin for Symfony ✅ ✅ ✅
psecio-parse Scans code for potential security-related issues ✅ ✅ ✅
rector Tool for instant code upgrades and refactoring ✅ ✅ ✅
roave-backward-compatibility-check Tool to compare two revisions of a class API to check for BC breaks ✅ ✅ ✅
simple-phpunit Provides utilities to report legacy tests and usage of deprecated code ✅ ✅ ✅
twig-lint Standalone cli twig 1.X linter ✅ ✅ ✅
twig-linter Standalone cli twig 3.X linter ✅ ✅ ✅
twigcs The missing checkstyle for twig! ✅ ✅ ✅
yaml-lint Compact command line utility for checking YAML file syntax ❌ ✅ ✅

Removed tools

Name Summary
analyze Visualizes metrics and source code
box-legacy Legacy version of box
composer-normalize Composer plugin to normalize composer.json files
design-pattern Detects design patterns
parallel-lint Checks PHP file syntax
php-formatter Custom coding standards fixer
phpcf Finds usage of deprecated features
phpdoc-to-typehint Automatically adds type hints and return types based on PHPDocs
phpstan-localheinz-rules Additional rules for PHPstan
phpunit-5 The PHP testing framework (5.x version)
phpunit-7 The PHP testing framework (7.x version)
security-checker Checks composer dependencies for known security vulnerabilities
testability Analyses and reports testability issues of a php codebase

Installation

Get the toolbox.phar from the latest release. The command below should do the job:

curl -Ls https://github.com/jakzal/toolbox/releases/latest/download/toolbox.phar -o toolbox && chmod +x toolbox

Usage

List available tools

./toolbox list-tools

Filter tools by tags

To exclude some tools from the listing multiple --exclude-tag options can be added. The --tag option can be used to filter tools by tags.

./toolbox list-tools --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar

Install tools

./toolbox install

Install tools in a custom directory

By default tools are installed in the /usr/local/bin directory. To perform an installation in another location, pass the --target-dir option to the install command. Also, to change the location composer packages are installed in, export the COMPOSER_HOME environment variable.

mkdir /tools
export COMPOSER_HOME=/tools/.composer
export PATH="/tools:$COMPOSER_HOME/vendor/bin:$PATH"
./toolbox install --target-dir /tools

The target dir can also be configured with the TOOLBOX_TARGET_DIR environment variable.

Dry run

To only see what commands would be executed, use the dry run mode:

./toolbox install --dry-run

Filter tools by tags

To exclude some tools from the installation multiple --exclude-tag options can be added. The --tag option can be used to filter tools by tags.

./toolbox install --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar

Test if installed tools are usable

./toolbox test

Dry run

To only see what commands would be executed, use the dry run mode:

./toolbox test --dry-run

Filter tools by tags

To exclude some tools from the generated test command multiple --exclude-tag options can be added. The --tag option can be used to filter tools by tags.

./toolbox test --exclude-tag exclude-php:8.2 --exclude-tag foo --tag bar

Tools definitions

By default the following files are used to load tool definitions:

  • resources/pre-installation.json
  • resources/architecture.json
  • resources/checkstyle.json
  • resources/compatibility.json
  • resources/composer.json
  • resources/deprecation.json
  • resources/documentation.json
  • resources/linting.json
  • resources/metrics.json
  • resources/phpstan.json
  • resources/psalm.json
  • resources/refactoring.json
  • resources/security.json
  • resources/test.json
  • resources/tools.json

Definitions can be loaded from customised files by passing the --tools option(s):

./toolbox list-tools --tools path/to/file1.json --tools path/to/file2.json

Tool definition location(s) can be also specified with the TOOLBOX_JSON environment variable:

TOOLBOX_JSON='path/to/file1.json,path/to/file2.json' ./toolbox list-tools

Tool tags

Tools can be tagged in order to enable grouping and filtering them.

The tags below have a special meaning:

  • pre-installation - these tools will be installed before any other tools.
  • exclude-php:8.1, exclude-php:8.2 etc - used to exclude installation on the specified php version.

Contributing

Please read the Contributing guide to learn about contributing to this project. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

More Repositories

1

phpqa

Docker image that provides static analysis tools for PHP
Dockerfile
1,195
star
2

phpunit-injector

Injects services from a PSR-11 dependency injection container to PHPUnit test cases
PHP
62
star
3

phpunit-globals

Allows to use attributes to define global variables in PHPUnit test cases
PHP
39
star
4

BehatRestExtension

A RestExtension for Behat
PHP
32
star
5

BehatNoExtension

This Behat extension makes it possible to extend Behat without having to write an extension yourself.
PHP
32
star
6

12tdds

12 TDDS OF CHRISTMAS
PHP
19
star
7

behat-from-scratch

Behat from scratch
PHP
19
star
8

DemoBundle

DemoBundle demonstrates how to run Behat and Symfony functional tests without a need of installing bundle in a project.
PHP
18
star
9

phpunit-doubles

Initialises test doubles in PHPUnit test cases for you
PHP
16
star
10

ParamConverterBundle

This bundle provides additional param converters for Symfony.
PHP
16
star
11

bundle-test

Tools for testing Symfony Bundles.
PHP
12
star
12

SymfonyComponentsExamples

[NOT MAINTAINED] Example usage of Symfony2 Components outside of Symfony framework
PHP
10
star
13

collections

A tiny PHP collection library enabling array_* like operations on generators and other traversables
PHP
8
star
14

gradle-structurizr-cli

Enables Gradle to run Structurizr CLI commands
Kotlin
8
star
15

vagrant-symfony

Basic vagrant configuration for Symfony projects
8
star
16

symfify

Sets up a basic Symfony project in a code base that did not start as a Symfony project
PHP
7
star
17

mastermind

A deliberate practice exercise
6
star
18

SymfonyConBot

The SymfonyCon IRC bot
PHP
6
star
19

docker-symfony-intl

Docker images for testing the Symfony Intl Component
Dockerfile
5
star
20

injector

Injects services from a PSR-11 service container into objects
PHP
5
star
21

docker-symfony-dev

Docker images for Symfony framework development
Shell
5
star
22

EpgDownloader

Downloads and converts electronic program guides
Perl
4
star
23

php-cgi

Ubuntu init script for spawning php-cgi processes
3
star
24

vim

My vim configuration
Vim Script
3
star
25

gyImagenePlugin

Image manipulation plugin for symfony
PHP
3
star
26

web-scraper-demo

PHP
2
star
27

phpnw15-workshop

Loose coupling in practice workshop for PHPNW 2015
PHP
2
star
28

php-cap

Set of Capistrano overrides for deployment of PHP projects
Ruby
2
star
29

kotlin-mastermind

Mastermind game
Kotlin
2
star
30

jakzal.github.io

1
star
31

frame

A failed experiment
Kotlin
1
star
32

FunctionalDesign

The source code for the examples in Functional Design rewritten to Kotlin
Kotlin
1
star
33

Blog

My Blog
PHP
1
star
34

xoom-mastermind

Mastermind implementation in Kotlin with XOOM
Kotlin
1
star
35

dotfiles

dot files
Shell
1
star