PHPackages petk/normalizator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. petk/normalizator ActiveProject[Utility & Helpers](/categories/utility) petk/normalizator ================= Normalize files in Git repository v0.0.6(2y ago)510MITPHPPHP >=8.2CI passing Since Jun 12Pushed 3mo ago2 watchersCompare [ Source](https://github.com/petk/normalizator)[ Packagist](https://packagist.org/packages/petk/normalizator)[ Docs](https://github.com/petk/normalizator)[ RSS](/packages/petk-normalizator/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (6)Dependencies (8)Versions (7)Used By (0) Normalizator ============ [](#normalizator) [![Test workflow](https://github.com/petk/normalizator/actions/workflows/tests.yaml/badge.svg)](https://github.com/petk/normalizator/actions/workflows/tests.yaml/badge.svg) Command line tool written in PHP that checks and fixes trailing whitespace, LF or CRLF newline characters, redundant trailing final newlines, file permissions and similar in given files. Features -------- [](#features) - Checks file permissions - Trims trailing whitespace characters - Trims redundant final newlines - Trims redundant leading newlines - Inserts missing final newline - Trims redundant newlines in the middle of the file - Converts and syncs EOL (end of line) characters - Cleans spaces before tabs in the indentation part of the line - Checks file extensions - Checks file and directory names if they contain any special characters (spaces, non-ASCII characters, etc.) - Checks file encodings - Checks indentation style Installation ------------ [](#installation) Normalizator is a simple Phar executable file that can be downloaded from GitHub: ``` curl -OL https://github.com/petk/normalizator/releases/latest/download/normalizator.phar ``` Or: ``` wget https://github.com/petk/normalizator/releases/latest/download/normalizator.phar ``` By moving it to `/usr/local/bin` it can be accessed accross the system: ``` chmod +x normalizator.phar mv normalizator.phar /usr/local/bin/normalizator ``` Update ------ [](#update) Update normalizator to the latest version: ``` sudo normalizator self-update ``` About ----- [](#about) There is a recurring and never-ending issue in many code projects with trailing whitespace, missing final newlines at the end of the files, too many redundant newlines, different end of line characters, misused permissions and similar. Beside the multiple preferred coding styles, also certain editors behave differently and some automatically fix these when saving files. Some utilize `.editorconfig` file by default and some leave files intact. Git also provides several [configuration options](https://git-scm.com/docs/git-config) to detect and deal with these issues. Although it is not mandatory for all files to have these issues fixed, a more consistent and homogeneous approach brings less cognitive load in commits and a better development experience in certain text editors and IDEs. This tool aims to bring an initial solution to this issue and provides a more consistent set of source code files across the code repository with a simplistic yet still useful and powerful enough approach to tidy all files in a given Git repository, directory, or a path using command line. Docker ------ [](#docker) There is also a [Docker image](https://hub.docker.com/r/petk/normalizator)available to run the tool inside a container: ``` docker run -it -v path/to/files:/opt/app:rw petk/normalizator:latest check . ``` Requirements ------------ [](#requirements) To use normalizator, system needs to have PHP 8.4 or greater installed with the following PHP extensions: - fileinfo - filter - iconv - intl - mbstring - phar Usage ----- [](#usage) Check files (dry run) without modifying any file: ``` normalizator check [OPTION...] [--] ... ``` Fix and overwrite files: ``` normalizator fix [OPTION...] [--] ... ``` ### Passing paths [](#passing-paths) Paths or files can be passed as a space separated arguments: ``` normalizator check [OPTION...] [--] ~/dir/foo ~/dir/bar ~/dir/file.php ... ``` The `--not` option skips given paths or files: ``` normalizator check [OPTION...] \ --not \ --not \ ... [OPTION...] \ [--] ... ``` ### File encoding [](#file-encoding) For non-ASCII and non-UTF-8 file encodings, option `--encoding` or short `-c`tries to convert file content encoding to UTF-8: ``` normalizator check --encoding -- ~/projects/path/to/files/ # or normalizator check -c -- ~/projects/path/to/files/ ``` See also: - Article: [The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets](https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character-sets-no-excuses/) ### Trailing whitespace [](#trailing-whitespace) Normalizator can trim trailing whitespace characters in text files: ``` normalizator check --trailing-whitespace -- ~/projects/path/to/files/ # or normalizator check -w -- ~/projects/path/to/files/ ``` To fix files: ``` normalizator fix -w -- ~/projects/path/to/files/ ``` ### Indentation style [](#indentation-style) Indentation style can be checked with: ``` normalizator check --indentation -- ~/projects/path/to/files # or normalizator check -i -- ~/projects/path/to/files ``` Indentation size is set to 4 (one tab equals to 4 spaces). Indentation size can be changed with the `--indentation-size` option. For example, the following will set indentation size to 2: ``` normalizator fix --indentation --indentation-size=2 -- ~/projects/path/to/files ``` ### Space before tab [](#space-before-tab) To clean all spaces before tabs in the indentation: ``` normalizator check --space-before-tab -- ~/projects/path/to/files/ # or normalizator check -s -- ~/projects/path/to/files/ ``` ### EOL normalization [](#eol-normalization) This normalizes the EOL (end of line) style (LF vs CRLF): ``` normalizator check --eol -- ~/projects/path/to/files/ # or normalizator check -e -- ~/projects/path/to/files/ ``` According to [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/basedefs/V1_chap03.html#tag_03_206), a line is a sequence of zero or more non-`` characters plus a terminating `` character. Files should normally have at least one final newline character. [C89 standard](https://port70.net/~nsz/c/c89/c89-draft.html#2.1.1.2) and [above](https://port70.net/~nsz/c/c99/n1256.html#5.1.1.2) mention a final newline: > A source file that is not empty shall end in a new-line character, which shall not be immediately preceded by a backslash character. Newline characters: - LF (`\n`) (\*nix and Mac, default) - CRLF (`\r\n`) (Windows) - CR (`\r`) (old Mac, obsolete) It is possible to set EOL character with the [`eol` Git attribute](https://git-scm.com/docs/gitattributes#_eol) if some files require specific EOL: ``` README.md eol=crlf ``` Normalizator will take the Git attribute setting into account. To override the EOL characters for all files in the given path: ``` normalizator check --eol LF -- ~/projects/path/to/files ``` ### Redundant leading EOL [](#redundant-leading-eol) ``` normalizator check --leading-eol -- ~/projects/path/to/files # or normalizator check -l -- ~/projects/path/to/files ``` ### Final EOL normalization [](#final-eol-normalization) ``` normalizator check --final-eol -- ~/projects/path/to/files # or normalizator check -N -- ~/projects/path/to/files ``` Optionally, the maximum number of allowed final EOLs can be set by passing a number. In case of a missing final EOL, one will be appended. This will allow up to 2 final EOLs: ``` normalizator check --final-eol 2 -- ~/projects/path/to/files ``` ### Redundant middle EOL [](#redundant-middle-eol) To trim redundant EOLs in the middle of the text or code: ``` normalizator check --middle-eol -- ~/projects/path/to/files # or normalizator check -m -- ~/projects/path/to/files ``` ### Permissions normalization [](#permissions-normalization) This syncs permissions of given files and directories. Symbolic links are not affected. ``` normalizator check --permissions -- ~/projects/path/to/files/ # or normalizator check -u -- ~/projects/path/to/files/ ``` This mostly applies for \*nix systems. - Files should usually have 0644 permissions. - Directories should usually have 0755 permissions. - Executable files should usually have 0755 permissions. - Protected files have 0444 permissions. Permissions in the `.git` directory: ``` 0755 └─ .git/ 0755 ├─ branches/ 0644 ├─ COMMIT_EDITMSG 0644 ├─ config 0755 ├─ hooks/ 0755 │ ├─ applypatch-msg.sample 0755 │ ├─ commit-msg.sample │ └─ ... 0644 ├─ index 0755 ├─ info/ 0755 ├─ logs/ 0755 ├─ objects/ 0755 │ ├─ 06/ 0444 │ │ ├─ 1d542745facb8d2307059048b0c72746daf9a0 │ │ └─ ... 0755 │ ├─ 08/ 0755 │ ├─ 13/ │ └─ ... 0644 ├─ packed-refs 0755 ├─ refs/ └─ ... ``` On systems with umask 002 (Ubuntu) these permissions are off by 2. So they are a bit more relaxed and defaults are: - Files: 0664 - Directories 0775 - Executables 0755 - Protected files are still 0444 ### File extension normalization [](#file-extension-normalization) To normalize file extensions: ``` normalizator check --extension -- ~/projects/path/to/files/ # or normalizator check -x -- ~/projects/path/to/files/ ``` This will adjust file extensions, for example from `.JPEG` to `.jpg` and similar. ### Filename normalization [](#filename-normalization) To normalize names of files and directories: ``` normalizator check --name -- ~/projects/path/to/files/ # or normalizator check -a -- ~/projects/path/to/files/ ``` This fixes names of files and directories so that they don't contain whitespaces or special characters that might cause issues in certain occassions. Documentation ------------- [](#documentation) - [Docker](https://github.com/petk/normalizator/blob/main/docs/docker.md) - [Normalizator development](https://github.com/petk/normalizator/blob/main/docs/development.md) - [Contributing guidelines](https://github.com/petk/normalizator/blob/main/docs/CONTRIBUTING.md) - [Code of conduct](https://github.com/petk/normalizator/blob/main/docs/CODE_OF_CONDUCT.md) License and contributing ------------------------ [](#license-and-contributing) Contributions are welcome by forking the repository on GitHub. This repository is released under the MIT license. ### Health Score 33 — LowBetter than 75% of packages Maintenance53 Moderate activity, may be stable Popularity10 Limited adoption so far Community8 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~64 days Recently: every ~79 days Total 6 Last Release 745d ago PHP version history (2 changes)v0.0.1PHP >=8.1 v0.0.5PHP >=8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1614009?v=4)[Peter Kokot](/maintainers/petk)[@petk](https://github.com/petk) --- Top Contributors [![petk](https://avatars.githubusercontent.com/u/1614009?v=4)](https://github.com/petk "petk (101 commits)") --- Tags standardsstylenormalizator ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/petk-normalizator/health.svg) ``` [![Health](https://phpackages.com/badges/petk-normalizator/health.svg)](https://phpackages.com/packages/petk-normalizator) ``` ### Alternatives [friendsofphp/php-cs-fixer A tool to automatically fix PHP code style 13.5k234.7M20.6k](/packages/friendsofphp-php-cs-fixer)[symfony/event-dispatcher-contracts Generic abstractions related to dispatching event 3.4k756.5M424](/packages/symfony-event-dispatcher-contracts)[symfony/service-contracts Generic abstractions related to writing services 2.6k860.1M360](/packages/symfony-service-contracts)[illuminate/contracts The Illuminate Contracts package. 704122.9M10.1k](/packages/illuminate-contracts)[phpro/soap-client A general purpose SoapClient library 8885.6M46](/packages/phpro-soap-client)[civicrm/civicrm-core Open source constituent relationship management for non-profits, NGOs and advocacy organizations. 728272.9k20](/packages/civicrm-civicrm-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)