Download the PHP package lform/pretty-code without Composer

On this page you can find all versions of the php package lform/pretty-code. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package pretty-code

Pretty Code

Pretty Code is a githook-driven collection of linter & formatter configurations for PHP, CSS, HTML, and JavaScript. It is also designed for per-project customization, which is useful when dealing with older, unconventional, or problematic code bases.

When this package is updated, running composer update or npm update will pull in the latest configuration changes, minus anything you've overridden in your project. This allows for easy updates to the configuration without having to manually update files.

Table of Contents

  1. Requirements
  2. Installation
  3. Initialization
  4. Commands
  5. Customization per Project

Requirements

Installation

IMPORTANT: The NPM part of the package must be installed to use the githook-driven linters and formatters. That is the case for PHP as well, regardless of whether you are using the Composer package.

This package is designed to work in Linux and OSX environments. Windows is not supported at this time.

NPM Installation

This installs the frontend part of the package as well as the githook-driven automations.

Composer Installation

This installs the PHP part of the package.

Laravel & PHPStan

For Laravel based projects, install Larastan, which will configure PHPStan for use in Laravel projects.

Installing Larastan

  1. Install Larastan (refer to documentation) via Composer
  2. Create a phpstan.neon file in the project root or copy the one from pretty-code
  3. Edit the .lintstagedrc.json file and remove the preset configuration path from phpstan, so it uses the project root configuration by default.

  4. Add the larastan extension to the phpstan.neon file in the project root:

    includes:

    • vendor/larastan/larastan/extension.neon

      Initialization

Once the packages are installed, the package has to be initialized via npm to do a few things:

  1. Copy a .lintstagedrc.json config to the project root, if it does not already exist
  2. Copy a preconfigured .githooks directory to the project root to trigger the git automations. If the directory already exists, the initialization script will not overwrite it.
  3. Copy a .editorconfig config to the project root, if it does not already exist
  4. Configure the project git repo core.hooksPath to use the new .githooks directory.
  5. Add new scripts in package.json to run the linters and formatters manually.

For Composer, initialization will just add the new scripts to composer.json to run the linters and formatters manually.

Afterward, these new files & changes should be committed to git once everything is confirmed working. Read below for how to initialize the package.

NPM Initialization

Composer Initialization

Troubleshooting

PHPStan Pains

PHPStan is very helpful but can be a source of aggravation on projects that have an older code-base or used unconventional approaches. There are a few things that can be done to address these issues:

  1. If it's a Laravel project, install Larastan (instructions are above)
  2. Exclude files from reporting in the configuration or with inline comments. For errors that should be ignored, add them to the configuration.
  3. Lower the reporting level in the configuration
  4. Generate a baseline report, so you can focus on new code instead of trying to fix old code. Commit the baseline report to the project repo.

If all else fails, PHPStan can be disabled but this should be avoided except when necessary.

Disconnecting & Reconnecting the Automations

If you're having problems with the automated git hooks and need to disable or re-enable them:

OS Issues

NOTE: On OSX, you may also need to install coreutils since the initialization scripts use the realpath command. If you see errors related to this, run the following:

Uninstalling

To remove the package:

  1. Delete any custom linter or formatter configs from the project root
  2. Delete the .githooks directory
  3. Run git config core.hooksPath .git/hooks
  4. Run npm remove @lform/pretty-code
  5. Run composer remove lform/pretty-code
  6. Remove the pretty scripts from composer.json and package.json

Linters & Formatters

Linters

Formatters

Supported File Types

L = Linted, F = Formatted

Commands

Formatters

Linters

Customization Per Project

To customize the linters and formatters per project:

  1. Copy the specific configuration files that need to be modified from the Pretty Code package root to the project root. Only copy the configurations that you need, these custom configs will no longer get updated via the package management system.
  2. Modify the copied configuration files as needed.
  3. Open the .lintstagedrc.json file and remove the explicit config-file paths or ignore-file paths from the respective linters or formatters being adjusted.
  4. Do the same thing for the package.json and composer.json scripts as applicable.
  5. The linters and formatters with project-based configs will automatically use the configuration files from the project root directory.

To undo these changes, just delete the configurations and restore the original scripts by referencing the package's package.json and composer.json files.

Configuration Files

Todos

  1. Add github workflows
  2. Add tailwind linter
  3. Add antlers formatter + linter
  4. Add windows support (convert bin scripts to node.js)

All versions of pretty-code with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
friendsofphp/php-cs-fixer Version ^3.46
phpstan/phpstan Version ^1.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package lform/pretty-code contains the following files

Loading the files please wait ....