Skip to content
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.

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

[TASK] Use central configuration for all packages #120

Merged
merged 2 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 0 additions & 40 deletions .build/ecs.php

This file was deleted.

10 changes: 0 additions & 10 deletions .build/rector.php

This file was deleted.

34 changes: 11 additions & 23 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,23 @@ jobs:
# Give the default GITHUB_TOKEN write permission to commit and push the
# added or changed files to the repository.
contents: write
strategy:
matrix:
composer-command:
- name: Generate docs
command: 'docs:generate'
directory: ['typo3-fractor', 'fractor-composer-json']

name: '${{ matrix.composer-command.name }}/packages/${{ matrix.directory }}'

defaults:
run:
working-directory: packages/${{ matrix.directory }}
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Install composer dependencies
uses: php-actions/composer@v6
- name: "Setup PHP"
uses: shivammathur/setup-php@v2
with:
container_workdir: /app/packages/${{ matrix.directory }}
memory_limit: 512M
php-version: 8.2
coverage: none

# see https://github.com/ramsey/composer-install
- name: "Install Composer dependencies"
uses: ramsey/composer-install@v3

- name: "Generate documentation"
run: "composer docs"

- name: 'Run check "${{ matrix.composer-command.name }}"'
uses: php-actions/composer@v6
with:
container_workdir: /app/packages/${{ matrix.directory }}
command: ${{ matrix.composer-command.command }}
memory_limit: 512M
- name: 'Set Branch Name'
id: set-branch-name
run: |
Expand Down
68 changes: 15 additions & 53 deletions .github/workflows/lint_test_pull_requests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,72 +20,34 @@ jobs:
- name: PHP Code Style
command: 'style:php:check'
- name: Composer normalize
command: 'normalize --dry-run'
command: 'style:composer:normalize'
- name: PHPStan
command: analyze:php
- name: PHPUnit
command: test:php
- name: Rector
command: 'rector --dry-run'
directory: ['extension-installer', 'fractor', 'fractor-xml', 'typo3-fractor', 'fractor-doc-generator', 'fractor-yaml', 'fractor-fluid', 'fractor-composer-json']
exclude:
- directory: extension-installer
composer-command: {name: 'PHPUnit', command: 'test:php'}
command: 'rector'

name: ${{ matrix.composer-command.name }}/${{ matrix.directory }}

steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Install composer dependencies
uses: php-actions/composer@v6
with:
container_workdir: /app/packages/${{ matrix.directory }}
memory_limit: 512M

- name: 'Run check "${{ matrix.composer-command.name }}"'
uses: php-actions/composer@v6
with:
container_workdir: /app/packages/${{ matrix.directory }}
command: ${{ matrix.composer-command.command }}
memory_limit: 512M

php-root-check:
runs-on: ubuntu-latest
continue-on-error: true
strategy:
fail-fast: false
matrix:
composer-command:
- name: PHP Code Style
command: 'style:php:check'
- name: Composer normalize
command: 'normalize --dry-run'
- name: PHPStan
command: analyze:php
- name: Rector
command: 'rector --dry-run'
name: ${{ matrix.composer-command.name }}

steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: "Checkout"
uses: actions/checkout@v4

- name: Install composer dependencies
uses: php-actions/composer@v6
# see https://github.com/shivammathur/setup-php
- name: "Setup PHP"
uses: shivammathur/setup-php@v2
with:
container_workdir: /app/
memory_limit: 512M
php-version: 8.2
coverage: none

# see https://github.com/ramsey/composer-install
- name: "Install Composer dependencies"
uses: ramsey/composer-install@v3

- name: 'Run check "${{ matrix.composer-command.name }}"'
uses: php-actions/composer@v6
with:
container_workdir: /app/
command: ${{ matrix.composer-command.command }}
memory_limit: 512M
run: composer ${{ matrix.composer-command.command }}


e2e-tests:
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
.run-test.sh
/composer.lock
/vendor/
.phpunit.cache
42 changes: 40 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,20 +84,42 @@
},
"config": {
"allow-plugins": {
"a9f/fractor-extension-installer": true,
"ergebnis/composer-normalize": true
}
},
"extra": {
"class": "a9f\\FractorExtensionInstaller\\InstallerPlugin"
},
"scripts": {
"auto-scripts": {
"fractor:installer": "a9f\\FractorMonorepo\\Composer\\Scripts\\FractorPackageInstaller::generate"
},
"analyze:php": "phpstan analyze",
"contribute": [
"@style:composer:normalize:fix",
"@merge-composer-json"
],
"docs": [
"fractor-doc-generator generate packages/typo3-fractor/rules --output-file packages/typo3-fractor/docs/typo3-fractor-rules.md",
"fractor-doc-generator generate packages/fractor-composer-json/rules --output-file packages/fractor-composer-json/docs/composer-json-fractor-rules.md"
],
"merge-composer-json": "monorepo-builder merge",
"rector": "rector",
"propagate": "monorepo-builder propagate",
"rectify": "rector",
"rector": "rector --dry-run",
"release": "monorepo-builder release patch",
"style:composer:normalize": [
"@composer normalize --dry-run e2e/composer.json",
"@composer normalize --dry-run packages/extension-installer/composer.json",
"@composer normalize --dry-run packages/fractor/composer.json",
"@composer normalize --dry-run packages/fractor-composer-json/composer.json",
"@composer normalize --dry-run packages/fractor-doc-generator/composer.json",
"@composer normalize --dry-run packages/fractor-fluid/composer.json",
"@composer normalize --dry-run packages/fractor-xml/composer.json",
"@composer normalize --dry-run packages/fractor-yaml/composer.json",
"@composer normalize --dry-run packages/typo3-fractor/composer.json"
],
"style:composer:normalize:fix": [
"@composer normalize --no-check-lock e2e/composer.json",
"@composer normalize --no-check-lock packages/extension-installer/composer.json",
Expand All @@ -109,7 +131,23 @@
"@composer normalize --no-check-lock packages/fractor-yaml/composer.json",
"@composer normalize --no-check-lock packages/typo3-fractor/composer.json"
],
"local:contribute": [
"@rectify",
"@analyze:php",
"@style:php:fix",
"@style:composer:normalize:fix",
"@test:php"
],
"style:php:check": "ecs",
"style:php:fix": "ecs --fix"
"style:php:fix": "ecs --fix",
"test:php": "phpunit",
"validate-monorepo": "monorepo-builder validate",
"post-install-cmd": [
"@auto-scripts"
],
"post-update-cmd": [
"@auto-scripts"
]
}

}
39 changes: 35 additions & 4 deletions ecs.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,38 @@

declare(strict_types=1);

return (include __DIR__ . '/.build/ecs.php')
->withPaths([__DIR__ . '/e2e', __DIR__ . '/src'])
->withRootFiles()
;
use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use PhpCsFixer\Fixer\ControlStructure\YodaStyleFixer;
use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
use PhpCsFixer\Fixer\Operator\OperatorLinebreakFixer;
use PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer;
use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
use Symplify\CodingStandard\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer;
use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
// add a single rule
->withConfiguredRule(NoSuperfluousPhpdocTagsFixer::class, [
'allow_mixed' => true,
])
->withConfiguredRule(GeneralPhpdocAnnotationRemoveFixer::class, [
'annotations' => ['throws', 'author', 'package', 'group'],
])
->withRules([
NoUnusedImportsFixer::class,
ArraySyntaxFixer::class,
StandaloneLineInMultilineArrayFixer::class,
ArrayOpenerAndCloserNewlineFixer::class,
DeclareStrictTypesFixer::class,
LineLengthFixer::class,
YodaStyleFixer::class,
OperatorLinebreakFixer::class,

])
->withSkip([__DIR__ . '/packages/extension-installer/generated'])
->withPreparedSets(psr12: true, symplify: true, common: true, cleanCode: true)
->withPaths([__DIR__ . '/e2e', __DIR__ . '/src', __DIR__ . '/packages'])
->withRootFiles();
17 changes: 1 addition & 16 deletions packages/extension-installer/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,18 @@
"composer-plugin-api": "^2.0"
},
"require-dev": {
"composer/composer": "^2.7",
"ergebnis/composer-normalize": "^2.42",
"phpstan/phpstan": "^1.10",
"rector/rector": "^1.0",
"symplify/easy-coding-standard": "^12.1"
"composer/composer": "^2.7"
},
"autoload": {
"psr-4": {
"a9f\\FractorExtensionInstaller\\": "src/",
"a9f\\FractorExtensionInstaller\\Generated\\": "generated/"
}
},
"config": {
"allow-plugins": {
"ergebnis/composer-normalize": true
}
},
"extra": {
"branch-alias": {
"dev-main": "0.2-dev"
},
"class": "a9f\\FractorExtensionInstaller\\InstallerPlugin"
},
"scripts": {
"analyze:php": "phpstan analyze",
"rector": "rector",
"style:php:check": "ecs",
"style:php:fix": "ecs --fix"
}
}
9 changes: 0 additions & 9 deletions packages/extension-installer/ecs.php

This file was deleted.

5 changes: 0 additions & 5 deletions packages/extension-installer/phpstan.neon

This file was deleted.

8 changes: 0 additions & 8 deletions packages/extension-installer/rector.php

This file was deleted.

18 changes: 15 additions & 3 deletions packages/extension-installer/src/PackagesFileGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,26 @@ public function generate(): void
}

$path = $this->installationManager->getInstallPath($package);

if ($path === null) {
continue;
}

$installedPackages[$package->getName()] = [
'name' => $package->getName(),
'path' => $path,
'version' => $package->getFullPrettyVersion(),
];
}

self::write($installedPackages, $this->fileToGenerate);
}

/**
* @param array<string, array{'path': string}> $installedPackages
*/
public static function write(array $installedPackages, string $fileToGenerate): void
{
$installedPackagesCode = var_export($installedPackages, true);

file_put_contents($this->fileToGenerate, sprintf(self::FILE_TEMPLATE, $installedPackagesCode));
file_put_contents($fileToGenerate, sprintf(self::FILE_TEMPLATE, $installedPackagesCode));
}
}
Loading