7 Best TYPO3 Code Quality, Review & Lint Tools

// For example, a JavaScript linter would flag the first use of parseInt below as unsafe:

// without a radix argument - Unsafe
var count = parseInt(countString);

// with a radix parameter specified - Safe
var count = parseInt(countString, 10);

// Install popular PHP-Codesniffer
sudo apt install php-codesniffer

// Check individual file
phpcs --standard=PSR2 ext_localconf.php

// Check whole folder’s PHP files
phpcs --standard=PSR2 ./

// Options to ignore the warning, allow extensions, etc.
phpcs --standard=PSR2 --warning-severity=0 --extensions=php *

// Install TypoScript lint
composer global require helmich/typo3-typoscript-lint

// Create “tslint.yml” TypoScript lint configuration
paths:
- Configuration/PageTSconfig
- Configuration/TypoScript

filePatterns:
 - "*.ts"
 - "*.typoscript"

sniffs:
 - class: Indentation
   parameters:
     indentConditions: true
 - class: RepeatingRValue
   disabled: true
 - class: DeadCode
   disabled: true
 
// Run TypoScript lint
.config/composer/vendor/bin/typoscript-lint -c tslint.yaml

// Run Single TypoScript lint
.config/composer/vendor/bin/typoscript-lint path/to/your.typoscript

// Installation of TYPO3 Fluid Lint
composer global require typo3fluid/fluid-lint:dev-master

// Let’s chek TYPO3 Fluid Lint
.config/composer/vendor/bin/fluidline Resoures/Private/Templates/Default.html

// Install Python-PIP YAML Lint
sudo apt install python-pip
sudo pip install yamllint==1.10.0

// Let’s check whole folder for .yaml or .yml
yamllint -d relaxed .

// Install Symfony’s Great Translation XLIFF Lint Component
composer global require symfony/translation

// Check individual XLIFF Lint
php bin/console lint:xliff default.xliff

// Check whole fodler XLIFF Lint
php bin/console lint:xliff /Resources/Private/Language

# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

# CSS-Files
[*.css]
indent_style = space
indent_size = 4

# HTML-Files
[*.html]
indent_style = space
indent_size = 4

# TMPL-Files
[*.tmpl]
indent_style = space
indent_size = 4

# TSX-Files
[*.tsx]
indent_style = space
indent_size = 4

# LESS-Files
[*.less]
indent_style = space
indent_size = 4

# JS-Files
[*.js]
indent_style = space
indent_size = 4

# PHP-Files
[*.php]
indent_style = space
indent_size = 4

# MD-Files
[*.md]
indent_style = space
indent_size = 4

# ReST-Files
[*.rst]
indent_style = space
indent_size = 3

# TypoScript
[*.typoscript,*.ts]
indent_style = space
indent_size = 4

# YML-Files
[{*.yml,*.yaml}]
indent_style = space
indent_size = 2

# package.json, composer.json or .travis.yml
[{package.json,composer.json,.travis.yml}]
indent_style = space
indent_size = 2

# SCSS
[*.scss]
indent_style = tab
indent_size = 2

cache:
 key: "$CI_COMMIT_REF_NAME-$CI_JOB_STAGE"
 paths:
   - .composer/

before_script:
 - apk add git --update

stages:
 - php
 - typoscript
 - yaml
 - fluid
 - xliff

.php: &phptesting
 stage: php
 image: php:$DOCKER_TAG
 only:
   - branches
 before_script:
   - export TYPO3_PATH_WEB="$PWD/.Build/Web"
   - export COMPOSER_CACHE_DIR=.composer
   - curl -OLs https://composer.github.io/installer.sig
   - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
   - php -r "if (hash_file('SHA384', 'composer-setup.php') === trim(file_get_contents('installer.sig'))) { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
   - php composer-setup.php --no-ansi --install-dir=/usr/bin --filename=composer
   - php -r "unlink('composer-setup.php'); unlink('installer.sig');"
   - composer require friendsofphp/php-cs-fixer
 script:
   - .Build/bin/php-cs-fixer fix --dry-run --config=.php_cs --diff

# Tests in PHP 7.2 and TYPO3 9.5 version
php:testphp72:typo3_95:
 <<: *phptesting
 variables:
   DOCKER_TAG: 7.2-alpine
   # TYPO3_VERSION: ^9.5

typoscript:test:
 image: composer:1.6
 stage: typoscript
 before_script:
   - export COMPOSER_CACHE_DIR=.composer
   - composer require --dev helmich/typo3-typoscript-lint
 script:
   - .Build/bin/typoscript-lint -c .tslint.yml

yaml:test:
 image: python:alpine3.7
 stage: yaml
 before_script:
   - pip install yamllint==1.10.0
 script:
   - yamllint -c .yamllint.yml .

fluid:test:
 image: composer:1.6
 stage: fluid
 before_script:
   - export COMPOSER_CACHE_DIR=.composer
   - composer require typo3fluid/fluid-lint:dev-master
 script:
   - .Build/bin/fluidlint Resources/Private/Templates/Default.html

xliff:test:
 image: composer:1.6
 stage: xliff
 before_script:
   - export COMPOSER_CACHE_DIR=.composer
   #- apk --no-cache add libxml2-utils
   #- wget https://raw.githubusercontent.com/symfony/translation/v4.1.1/Resources/schemas/xliff-core-1.0-strict.xsd
   - composer require symfony/translation
 script:
   - .Build/bin/xlifflint /usr/local/bin/php lint:xliff /Resources/Private/Language
   #- xmllint --schema xliff-core-1.0-strict.xsd --noout $(find Resources -name '*.xlf')