Search by

andersundsehr / grumphp-bom-task

Kantiandersundsehr

This package is abandoned and no longer maintained. The author suggests using the pluswerk/grumphp-bom-task package instead.

Force files to have no BOM

Package info

github.com/andersundsehr/grumphp-bom-task

Issues

pkg:composer/andersundsehr/grumphp-bom-task

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 1 409

Dependents: 0

Suggesters: 0

Stars: 2

11.2.2 2026-11-05 21:30 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

LGPL-3.0-or-later 130fd2bb13d5ae75076be615d63c93387e49a05d

Published on Packagist.org on 2026-11-06 10:40 UTC

This package is auto-updated.

Last update: 2026-11-06 10:40:56 UTC

README

Packagist Packagist

pluswerk/grumphp-bom-task

A GrumPHP task that fails if a file starts with a UTF-8 byte order mark (BOM), and the fixbom command that removes it.

Most editors do not show a BOM, but it causes real problems: in a PHP file it is sent as output before <?php, and declare(strict_types=1) is no longer the first statement. JSON parsers and shell scripts often fail on it as well.

This task is part of pluswerk/grumphp-config. If you use that package, the task is already installed and configured.

Requirements

  • PHP 8.2 or newer
  • GrumPHP 2
  • the file command line tool

Installation

composer require --dev pluswerk/grumphp-bom-task

Register the extension and the task in your grumphp.yml:

grumphp:
  tasks:
    plus_bom_fixer:
      triggered_by: [php, css, scss, less, json, sql, yml, txt]
  extensions:
    - PLUS\GrumPHPBomTask\ExtensionLoader

Options

triggered_by

Default: [php, css, scss, less, json, sql, yml, txt]

File extensions to check. Extend the list if you need more, for example yaml, xlf, html or typoscript.

The task also accepts GrumPHP's metadata options, e.g. priority.

How it works

The task runs with vendor/bin/grumphp run and in the pre-commit hook; in the hook it checks only the staged files.

For each file with a matching extension it calls file <path> and looks for BOM in the output. If the file command is missing or fails, the file counts as a file without BOM.

The task does not change files. If it finds a BOM, it fails and prints the affected files together with a command that fixes them:

src/Example.php has BOM and should be fixed
you can use this to fix them:
./vendor/bin/fixbom 'src/Example.php'

fixbom

vendor/bin/fixbom file1 [file2 ...]

Removes a UTF-8 BOM from the start of each given file. The file permissions and the group are kept. Files without a BOM stay unchanged; files that do not exist are reported and skipped.

Upgrading from the AUS version

Older versions were published as andersundsehr/grumphp-bom-task with the namespace AUS. Rename the task and the extension in your grumphp.yml:

Old New
aus_bom_fixer plus_bom_fixer
AUS\GrumPHPBomTask\ExtensionLoader PLUS\GrumPHPBomTask\ExtensionLoader

If your grumphp.yml still lists tasks and extensions under parameters:, move them under grumphp:; GrumPHP 1.0 and newer only read them there.

Contributing

This package is developed in the monorepo andersundsehr/grumphp-config. Please open issues and pull requests there.

License

LGPL-3.0-or-later

with ♥️ from anders und sehr GmbH

If something did not work 😮
or you appreciate this Extension 🥰 let us know.

We are hiring https://www.andersundsehr.com/karriere/