alecrabbit/php-wcwidth

Calculate width of unicode strings rendered to a terminal

1.0.0 2023-09-21 10:58 UTC

Requires

• php: >=8.2

Requires (Dev)

• nunomaduro/collision: ^7.0
• phpunit/phpunit: ^10.0
• symfony/cache: ^6.2
• symfony/console: ^6.2
• symfony/http-client: ^6.2
• symfony/var-dumper: ^6.2
• twig/twig: ^3.5

Suggests

• ext-ffi: For FFI bindings.
• ext-mbstring: For multibyte Unicode string functionality.

MIT

• php
• cli
• console
• wcwidth
• wcswidth

README

This is kinda port of python's jquast/wcwidth

🌐 Unicode release files

• Installation
• Quick start
• Usage
• FFI Extension

Installation

$ composer require alecrabbit/php-wcwidth

Quick start

use function AlecRabbit\WcWidth\wcwidth;
use function AlecRabbit\WcWidth\wcswidth;

echo wcwidth('a'); // 1
echo wcwidth('é'); // 1
echo wcwidth('🐘'); // 2
echo wcswidth('🐘🐘🐘'); // 6

echo wcwidth('🐘🐘🐘'); // 2 - only first char is considered

see doc/usage.md for more details.

FFI extension

Note ‼️ Experimental feature.

For improved performance, consider leveraging the Foreign Function Interface (FFI) extension, if available. To enable this feature, set the USE_FFI environment variable to true.

USE_FFI=true

Note When using ffi extension version value is ignored completely.