PHPackages sitegeist/fluid-components-linter - 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. [Testing & Quality](/categories/testing) 4. / 5. sitegeist/fluid-components-linter ActiveLibrary[Testing & Quality](/categories/testing) sitegeist/fluid-components-linter ================================= Tool to validate fluid components based on a specified ruleset 1.0.6(1y ago)575.9k↓43.4%1[2 issues](https://github.com/sitegeist/fluid-components-linter/issues)MITPHPPHP >=8.3.0CI passing Since Jul 28Pushed 1y ago2 watchersCompare [ Source](https://github.com/sitegeist/fluid-components-linter)[ Packagist](https://packagist.org/packages/sitegeist/fluid-components-linter)[ Docs](https://github.com/sitegeist/fluid-components-linter)[ RSS](/packages/sitegeist-fluid-components-linter/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (8)Versions (16)Used By (0) Fluid Components Linter ======================= [](#fluid-components-linter) CLI tool to validate your [Fluid Components](https://github.com/sitegeist/fluid-components)based on a specific ruleset for code quality. Features -------- [](#features) - check basic Fluid syntax - check correct component structure (e. g. correct nesting of component ViewHelpers) - enforce naming scheme and min/max length of parameter names - limit parameter count per component (which should lead to simpler components) - enforce parameter descriptions - enforce presence of markdown documentation and fixture files used by Fluid Styleguide - normalize syntax of namespaces in parameter type - encourage strict data types instead of generic `array` or `object` - suggest usage of correct types if parameter names contain hints like `link` or `image` - enforce that component prefixer and `class` param are used - enforce that certain ViewHelpers can't be used inside components - enforce that `content` param is always wrapped in `` Getting Started --------------- [](#getting-started) To use the linter, require this package as a dev dependency via composer: ``` composer req --dev sitegeist/fluid-components-linter ``` The package provides the binary `fclint` which can be used to validate individual component files as well as whole directory structures containing component files. ``` fclint lint Resources/Private/Components/ ``` For ease of use you might want to define a custom composer command in your project: *composer.json:* ``` { ... "scripts": { "lint:components": "fclint lint Resources/Private/Components/" } } ``` and then just call: ``` composer lint:components ``` (on-demand, in git hooks, in your CI...) Customize Ruleset ----------------- [](#customize-ruleset) If you want to modify the code quality ruleset, you can overwrite the predefined rules in [default.fclint.json](./src/Configuration/default.fclint.json): ``` fclint lint -c ./myRules.fclint.json Resources/Private/Components/ ``` For convenience, a file named `.fclint.json` in the current working directory will be picked up automatically and doesn't need to be specified with `-c`. Your adjusted configuration will be merged with the selected configuration preset, so you only need to specify the rules you want to change. To make the following changes to the default rules: - ignore all components inside a folder called `Template/` - don't require a markdown documentation file if a fixture file is present - limit length of parameter names to 30 characters (default is 40) you would use the following configuration file: *.fclint.json:* ``` { "files": { "ignorePatterns": [ "**/Template/**" ] }, "component": { "requireDocumentationWithFixtureFile": { "check": false } }, "params": { "nameLength": { "max": 30 } } } ``` Command Line Options -------------------- [](#command-line-options) There are a few command line options that can be specified: ``` $ fclint lint --help Description: Validates fluid components based on a specified ruleset Usage: lint [options] [--] ... Arguments: paths Component files that should be included Options: -e, --extension[=EXTENSION] Component file extension [default: ".html"] -p, --preset[=PRESET] Name of configuration preset [default: false] -c, --config[=CONFIG] Path to custom configuration file (.fclint.json in the current working directory will be picked up automatically) [default: false] --severity[=SEVERITY] Minimum severity, all issues below this severity will be skipped. Possible values: info, minor, major, critical, blocker [default: "info"] -i, --ignore[=IGNORE] Glob pattern that defines which files should be skipped (multiple values allowed) --json Output results as json (compatible to codeclimate spec) ``` Support & Discussion ------------------------ [](#support--discussion) If you have any questions, need support or want to discuss components in TYPO3, feel free to join [\#ext-fluid\_components](https://typo3.slack.com/archives/ext-fluid_components). ### Health Score 45 — FairBetter than 93% of packages Maintenance38 Infrequent updates — may be unmaintained Popularity35 Limited adoption so far Community11 Small or concentrated contributor base Maturity78 Established project with proven stability Bus Factor1 Top contributor holds 82.3% 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 ~190 days Recently: every ~333 days Total 10 Last Release 403d ago Major Versions 0.3 → 1.0.02020-09-30 PHP version history (5 changes)0.1PHP >=7.2.0 <8 1.0.3PHP >=7.2.0 1.0.4PHP >=8.0.0 1.0.5PHP >=8.2.0 1.0.6PHP >=8.3.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/ca4eee1e54bccd482945cd03a170a3dfa0c4672c32d0a565dc1228a905a06c27?d=identicon)[s2b](/maintainers/s2b) --- Top Contributors [![s2b](https://avatars.githubusercontent.com/u/458524?v=4)](https://github.com/s2b "s2b (65 commits)")[![ulrichmathes](https://avatars.githubusercontent.com/u/26324456?v=4)](https://github.com/ulrichmathes "ulrichmathes (14 commits)") --- Tags code-qualitycomponentsfluidfluid-componentslintertypo3-fluid ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/sitegeist-fluid-components-linter/health.svg) ``` [![Health](https://phpackages.com/badges/sitegeist-fluid-components-linter/health.svg)](https://phpackages.com/packages/sitegeist-fluid-components-linter) ``` ### Alternatives [behat/behat Scenario-oriented BDD framework for PHP 4.0k96.8M2.0k](/packages/behat-behat)[vimeo/psalm A static analysis tool for finding errors in PHP applications 5.8k77.5M6.7k](/packages/vimeo-psalm)[phan/phan A static analyzer for PHP 5.6k11.2M1.1k](/packages/phan-phan)[phpro/grumphp A composer plugin that enables source code quality checks. 4.3k15.5M904](/packages/phpro-grumphp)[magento/magento2-functional-testing-framework Magento2 Functional Testing Framework 15511.5M30](/packages/magento-magento2-functional-testing-framework)[acquia/orca A tool for testing a company's software packages together in the context of a realistic, functioning, best practices Drupal build 32902.4k](/packages/acquia-orca) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)