Skip to content

chore: Backport structarmed.php from 4.8 to develop and use baseline config #10544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samsonasik merged 5 commits into from
Sep 12, 2026
+62 −28
Merged

chore: Backport structarmed.php from 4.8 to develop and use baseline config #10544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bfad0ed
chore: cherry-pick structarmed.php from 4.8 to develop and use baseli…
samsonasik Sep 12, 2026
4db2f5a
clean copy
samsonasik Sep 12, 2026
afd7a36
register baseline
samsonasik Sep 12, 2026
954ede8
register baseline
samsonasik Sep 12, 2026
5b2083c
register structarmed-baseline.php to .gitattributes
samsonasik Sep 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ utils/ export-ignore
.php-cs-fixer.no-header.php export-ignore
.php-cs-fixer.tests.php export-ignore
.php-cs-fixer.user-guide.php export-ignore
structarmed-baseline.php export-ignore
structarmed.php export-ignore
phpmetrics.json export-ignore
phpstan-baseline.php export-ignore
Expand Down
20 changes: 20 additions & 0 deletions structarmed-baseline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

declare(strict_types=1);

return [
[
'rule' => 'base_classes.must_be_abstract',
'message' => 'Extended class [CodeIgniter\Config\BaseService] must be declared abstract or instantiated',
'file' => 'system/Config/BaseService.php',
'class' => 'CodeIgniter\Config\BaseService',
'layer' => 'Source',
],
[
'rule' => 'base_classes.must_be_abstract',
'message' => 'Extended class [CodeIgniter\Debug\Toolbar\Collectors\BaseCollector] must be declared abstract or instantiated',
'file' => 'system/Debug/Toolbar/Collectors/BaseCollector.php',
'class' => 'CodeIgniter\Debug\Toolbar\Collectors\BaseCollector',
'layer' => 'Source',
],
];
69 changes: 41 additions & 28 deletions structarmed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,39 @@
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
use Boundwize\StructArmed\Rule\Rules\Function_\MustHaveReturnTypeFunctionRule;

use Boundwize\StructArmed\Architecture;
use Boundwize\StructArmed\Preset\Preset;
use Boundwize\StructArmed\Preset\Presets\CodeQualityPreset;
use Boundwize\StructArmed\Preset\Presets\Psr4Preset;
use Boundwize\StructArmed\Rule\Rules\Class_\ExtendedClassMustBeAbstractOrInstantiatedRule;
use Boundwize\StructArmed\Rule\Rules\Function_\MustHaveReturnTypeFunctionRule;
use CodeIgniter\Cache\ResponseCache;
use CodeIgniter\Database\BaseResult;
use CodeIgniter\DataCaster\DataCaster;
use CodeIgniter\DataConverter\DataConverter;
use CodeIgniter\Entity\Cast\CastInterface;
use CodeIgniter\Entity\Cast\URICast;
use CodeIgniter\Entity\Entity;
use CodeIgniter\Entity\Exceptions\CastException;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\DownloadResponse;
use CodeIgniter\HTTP\Header;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\Response;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\DataCaster\DataCaster;
use CodeIgniter\Entity\Cast\CastInterface;
use CodeIgniter\Entity\Exceptions\CastException;
use CodeIgniter\DataConverter\DataConverter;
use CodeIgniter\Entity\Entity;
use CodeIgniter\Entity\Cast\URICast;
use CodeIgniter\HTTP\ResponseTrait;
use CodeIgniter\HTTP\SSEResponse;
use CodeIgniter\HTTP\StreamResponse;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Log\Handlers\ChromeLoggerHandler;
use CodeIgniter\Security\CheckPhpIni;
use CodeIgniter\View\Table;
use CodeIgniter\Database\BaseResult;
use CodeIgniter\View\Plugins;
use CodeIgniter\HTTP\ResponseTrait;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\HTTP\DownloadResponse;
use CodeIgniter\Security\CheckPhpIni;
use CodeIgniter\Validation\Validation;
use CodeIgniter\View\Plugins;
use CodeIgniter\View\RendererInterface;
use Boundwize\StructArmed\Architecture;
use Boundwize\StructArmed\Preset\Preset;
use Boundwize\StructArmed\Preset\Presets\Psr4Preset;
use CodeIgniter\View\Table;

return Architecture::define()
->skip([
Expand All @@ -50,12 +54,15 @@
__DIR__ . '/system/View/Cells/Cell.php',
],
])
->baseline(__DIR__ . '/structarmed-baseline.php')
->cacheDirectory(is_dir('/tmp') ? '/tmp/structarmed' : null)
->withPresets(Preset::PSR4(), Preset::CODEQUALITY())

->layer('Helpers', __DIR__ . '/system/Helpers')
->rule('helpers.functions_must_have_return_type', new MustHaveReturnTypeFunctionRule('Helpers'))

->rule('base_classes.must_be_abstract', new ExtendedClassMustBeAbstractOrInstantiatedRule('Source', '/^CodeIgniter\\\\.*Base.*$/'))

// Resolve CodeIgniter layers from class names because several layers share directories.
->layerPattern('API', '/^CodeIgniter\\\\API\\\\.*$/')
->layerPattern('Cache', '/^CodeIgniter\\\\Cache\\\\.*$/')
Expand All @@ -72,11 +79,13 @@
->layerPattern('Filters', '/^CodeIgniter\\\\Filters\\\\Filter.*$/')
->layerPattern('Format', '/^CodeIgniter\\\\Format\\\\.*$/')
->layerPattern('Honeypot', '/^CodeIgniter\\\\.*Honeypot.*$/')
->layerPattern('Input', '/^CodeIgniter\\\\Input\\\\.*$/')
->layerPattern('URI', '/^CodeIgniter\\\\HTTP\\\\URI$/')
->layerPattern('HTTP', '/^CodeIgniter\\\\HTTP\\\\.*$/', '/(Exception|URI)/')
->layerPattern('I18n', '/^CodeIgniter\\\\I18n\\\\.*$/')
->layerPattern('Images', '/^CodeIgniter\\\\Images\\\\.*$/')
->layerPattern('Language', '/^CodeIgniter\\\\Language\\\\.*$/')
->layerPattern('Lock', '/^CodeIgniter\\\\Lock\\\\.*$/')
->layerPattern('Log', '/^CodeIgniter\\\\Log\\\\.*$/')
->layerPattern('Model', '/^CodeIgniter\\\\.*Model$/')
->layerPattern('Modules', '/^CodeIgniter\\\\Modules\\\\.*$/')
Expand All @@ -96,26 +105,28 @@
'Controller' => ['HTTP', 'Validation'],
'Cookie' => ['I18n'],
'Database' => ['Entity', 'Events', 'I18n'],
'DataCaster' => ['I18n', 'URI', 'Database'],
'DataCaster' => ['I18n', 'URI', 'Database', 'Encryption'],
'DataConverter' => ['DataCaster'],
'Email' => ['I18n', 'Events'],
'Entity' => ['DataCaster', 'I18n'],
'Files' => ['I18n'],
'Filters' => ['HTTP'],
'Honeypot' => ['Filters', 'HTTP'],
'HTTP' => ['Cookie', 'Files', 'I18n', 'Security', 'URI'],
'HTTP' => ['Cookie', 'Files', 'I18n', 'Input', 'Security', 'URI'],
'Input' => ['I18n'],
'Images' => ['Files', 'I18n'],
'Lock' => ['Cache'],
'Model' => ['Database', 'DataCaster', 'DataConverter', 'Entity', 'I18n', 'Pager', 'Validation'],
'Pager' => ['URI', 'View'],
'Publisher' => ['Files', 'URI'],
// +API = API + its allowed layers; +Controller = Controller + its allowed layers
'RESTful' => ['+API', '+Controller'],
'Router' => ['HTTP', 'I18n'],
'Security' => ['Cookie', 'HTTP', 'I18n', 'Session'],
'Session' => ['Cookie', 'Database', 'HTTP', 'I18n'],
'Throttle' => ['Cache', 'I18n'],
'Validation' => ['Database', 'HTTP', 'Helpers'],
'View' => ['Cache'],
'RESTful' => ['+API', '+Controller'],
'Router' => ['HTTP', 'I18n'],
'Security' => ['Cookie', 'HTTP', 'I18n', 'Session'],
'Session' => ['Cookie', 'Database', 'HTTP', 'I18n'],
'Throttle' => ['Cache', 'I18n'],
'Validation' => ['Database', 'HTTP', 'Helpers', 'I18n', 'Input'],
'View' => ['Cache'],
])
->skipPathsForRuleset(['*test*'])
// Skip violations for class-specific dependencies.
Expand All @@ -129,7 +140,7 @@
CastInterface::class,
CastException::class,
])
->skipClassViolation(\CodeIgniter\DataCaster\Exceptions\CastException::class, [
->skipClassViolation(CodeIgniter\DataCaster\Exceptions\CastException::class, [
CastException::class,
])
->skipClassViolation(DataConverter::class, [
Expand Down Expand Up @@ -157,4 +168,6 @@
->skipClassViolation(Response::class, [PagerInterface::class])
->skipClassViolation(RedirectResponse::class, [PagerInterface::class])
->skipClassViolation(DownloadResponse::class, [PagerInterface::class])
->skipClassViolation(SSEResponse::class, [PagerInterface::class])
->skipClassViolation(StreamResponse::class, [PagerInterface::class])
->skipClassViolation(Validation::class, [RendererInterface::class]);