Download the PHP package peckphp/peck without Composer

On this page you can find all versions of the php package peckphp/peck. 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 peck

GitHub Workflow Status (master) Total Downloads Latest Version License


Peck is a powerful CLI tool designed to identify wording or spelling mistakes in your codebase: filenames, class names, method names, property names, docs, and more. Built for speed, simplicity, and seamless integration, Peck fits naturally into your workflow, much like tools such as Pint or Pest.

Leveraging the robust capabilities of GNU Aspell, Peck inspects every corner of your codebase — ensuring your work maintains a high standard of clarity and professionalism.

Note: Peck is still under active development and is not yet ready for production use.

Installation

Requires PHP 8.3+ and GNU Aspell

Peck relies on GNU Aspell for its spell-checking functionality. Make sure GNU Aspell is installed on your system before using Peck.

Installing GNU Aspell

Installing Peck

You can require Peck using Composer with the following command:

Usage

To check your project for spelling mistakes, run:

On the very first run, Peck may detect a large number of spelling mistakes. You may use the ignore-all option to ignore all the mistakes at once:

Configuration

Peck can be configured using a peck.json file in the root of your project.

You can scaffold the peck.json file with:

Here's an example configuration:

You can also specify the path to the configuration file using the --config option:

Presets

In order to make it easier to get started with Peck, we've included a few presets that you can use to ignore common words in your project. The following presets are available:

Command Options

The behaviour of peck can be modified with the following command options:

--init

If you don't have a peck.json file yet, you can create a blank configuration file by using the --init option.

--config

By default peck will check for a peck.json file in your project root. If one isn't available it will try to figure out the directory to check by itself.

--path

The path to check can be overwritten with the --path option. If the path is one you always need checking you can place it in your peck.json file.

--text

The --text option allows you to check a string of text for spelling mistakes. This is useful when you want to check a specific string, such as commit messages.

--ignore-all

This option will ignore all spelling mistakes in the current run. This is useful when you have a large number of mistakes and want to ignore them all at once.

CI / GitHub Actions

When running Peck on GitHub Actions, you can use the following workflow before running Peck:


Peck is an open-sourced software licensed under the MIT license.


All versions of peck with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
nunomaduro/termwind Version ^1.17.0|^2.3.0
symfony/console Version ^6.4.17|^7.2.1
symfony/finder Version ^6.4.17|^7.2.2
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 peckphp/peck contains the following files

Loading the files please wait ....