dzunke/panaly-files

A Panaly plugin that is analyzing a set of folders for their filesystem structure

dev-main 2024-04-17 19:26 UTC

Requires

• php: ^8.2
• dzunke/panaly: dev-main
• symfony/finder: ^7.0

Requires (Dev)

• doctrine/coding-standard: ^12.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^11.1

MIT

• Denis Zunke

README

The plugin to the Panaly Project Analyzer enables metrics that can be utilized to collect data about the filesystem of a project. It will not access any tooling but utilizes the Symfony Finder Component.

Available Metrics

Directory Count

The directory count with the name directory_count gives an Integer result with the count of found directories. The following options are available for the metric.

Option	Description
paths	The paths will be combined to a single count

File Count

The file count with the name file_count gives an Integer result with the count of found directories. The following options are available for the metric.

Option	Description
paths	(Required) Array - The paths will be combined to a single count.
names	(Optional) Array - A filter for the names of the files, the possible values are defined by the Finder component of symfony.

Largest Files

The metric with the name largest_files is able to list the largest files that are given within the paths. The Listing could also be filtered by a name and so will just return the largest files of specific filters like with the file count. The resulting metric is of type Table with the columns file and size.

Option	Description
paths	(Required) Array - The paths will be combined to a single count.
names	(Optional) Array - A filter for the names of the files, the possible values are defined by the Finder component of symfony.
amount	(Optional) Integer Default: 5 - The amount of files that should be listed in the result.

Example Configuration

# panaly.dist.yaml
plugins:
    DZunke\PanalyFiles\FilesPlugin: ~ # no options available

groups:
    filesystem:
        title: "Filesystem Metrics"
        metrics:
            file_count:
                title: All Project Files
                paths:
                    - src
            file_count_php:
                title: PHP Files
                metric: file_count
                paths:
                    - src
                    - tests
                names:
                    - "*.php"
            directory_count:
                title: Test Directories
                paths:
                    - tests
            largest_php_files:
                title: Largest PHP Files
                metric: largest_files
                amount: 3
                paths:
                    - src
                    - tests
                names:
                    - "*.php"

Thanks and License

Panaly Project Analyzer - Filesystem Plugin © 2024+, Denis Zunke. Released utilizing the MIT License.

GitHub @dzunke  ·  Twitter @DZunke