configure.php 7.88 KB
Newer Older
Niels's avatar
Niels committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#!/usr/bin/env php
<?php

function ask(string $question, string $default = ''): string {
    $answer = readline($question . ($default ? " ({$default})" : null) . ': ');

    if (! $answer) {
        return $default;
    }

    return $answer;
}

function confirm(string $question, bool $default = false): bool {
    $answer = ask($question . ' (' . ($default ? 'Y/n' : 'y/N') . ')');

    if (! $answer) {
        return $default;
    }

    return strtolower($answer) === 'y';
}

function writeln(string $line): void {
    echo $line . PHP_EOL;
}

function run(string $command): string {
    return trim(shell_exec($command));
}

function str_after(string $subject, string $search): string {
    $pos = strrpos($subject, $search);

    if ($pos === false) {
        return $subject;
    }

    return substr($subject, $pos + strlen($search));
}

function slugify(string $subject): string {
    return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $subject), '-'));
}

function title_case(string $subject): string {
    return str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $subject)));
}

function replace_in_file(string $file, array $replacements): void {
    $contents = file_get_contents($file);

    file_put_contents(
        $file,
        str_replace(
            array_keys($replacements),
            array_values($replacements),
            $contents
        )
    );
}

Niels's avatar
Niels committed
63
64
65
66
67
68
69
70
function remove_prefix(string $prefix, string $content): string {
    if (str_starts_with($content, $prefix)) {
        return substr($content, strlen($prefix));
    }

    return $content;
}

71
72
function remove_composer_deps(array $names) {
    $data = json_decode(file_get_contents(__DIR__.'/composer.json'), true);
73

74
75
76
77
78
    foreach($data['require-dev'] as $name => $version) {
        if (in_array($name, $names, true)) {
            unset($data['require-dev'][$name]);
        }
    }
79

80
81
82
83
84
    file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
}

function remove_composer_script($scriptName) {
    $data = json_decode(file_get_contents(__DIR__.'/composer.json'), true);
85

86
87
88
89
90
91
    foreach($data['scripts'] as $name => $script) {
        if ($scriptName === $name) {
            unset($data['scripts'][$name]);
            break;
        }
    }
92

93
94
95
    file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
}

96
97
98
99
100
101
102
103
104
function remove_readme_paragraphs(string $file): void {
    $contents = file_get_contents($file);

    file_put_contents(
        $file,
        preg_replace('/<!--delete-->.*<!--\/delete-->/s', '', $contents) ?: $contents
    );
}

105
106
107
108
109
110
function safeUnlink(string $filename) {
    if (file_exists($filename) && is_file($filename)) {
        unlink($filename);
    }
}

111
112
113
function determineSeparator(string $path): string {
    return str_replace('/', DIRECTORY_SEPARATOR, $path);
}
114

IGedeon's avatar
IGedeon committed
115
function replaceForWindows(): array {
116
    return preg_split('/\\r\\n|\\r|\\n/', run('dir /S /B * | findstr /v /i .git\ | findstr /v /i vendor | findstr /v /i '.basename(__FILE__).' | findstr /r /i /M /F:/ ":author :vendor :package VendorName skeleton vendor_name vendor_slug author@domain.com"'));
IGedeon's avatar
IGedeon committed
117
118
119
}

function replaceForAllOtherOSes(): array {
120
    return explode(PHP_EOL, run('grep -E -r -l -i ":author|:vendor|:package|VendorName|skeleton|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v ' . basename(__FILE__)));
IGedeon's avatar
IGedeon committed
121
122
}

Niels's avatar
Niels committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
$gitName = run('git config user.name');
$authorName = ask('Author name', $gitName);

$gitEmail = run('git config user.email');
$authorEmail = ask('Author email', $gitEmail);

$usernameGuess = explode(':', run('git config remote.origin.url'))[1];
$usernameGuess = dirname($usernameGuess);
$usernameGuess = basename($usernameGuess);
$authorUsername = ask('Author username', $usernameGuess);

$vendorName = ask('Vendor name', $authorUsername);
$vendorSlug = slugify($vendorName);
$vendorNamespace = ucwords($vendorName);
$vendorNamespace = ask('Vendor namespace', $vendorNamespace);

$currentDirectory = getcwd();
$folderName = basename($currentDirectory);

$packageName = ask('Package name', $folderName);
$packageSlug = slugify($packageName);
Niels's avatar
Niels committed
144
$packageSlugWithoutPrefix = remove_prefix('laravel-', $packageSlug);
Niels's avatar
Niels committed
145
146
147
148
149

$className = title_case($packageName);
$className = ask('Class name', $className);
$description = ask('Package description', "This is my package {$packageSlug}");

150
151
152
153
$usePhpStan = confirm('Enable PhpStan?', true);
$usePhpCsFixer = confirm('Enable PhpCsFixer?', true);
$useUpdateChangelogWorkflow = confirm('Use automatic changelog updater workflow?', true);

Niels's avatar
Niels committed
154
155
156
157
158
159
writeln('------');
writeln("Author     : {$authorName} ({$authorUsername}, {$authorEmail})");
writeln("Vendor     : {$vendorName} ({$vendorSlug})");
writeln("Package    : {$packageSlug} <{$description}>");
writeln("Namespace  : {$vendorNamespace}\\{$className}");
writeln("Class name : {$className}");
160
161
162
163
164
writeln("---");
writeln("Packages & Utilities");
writeln("Use PhpCsFixer       : " . ($usePhpCsFixer ? 'yes' : 'no'));
writeln("Use Larastan/PhpStan : " . ($usePhpStan ? 'yes' : 'no'));
writeln("Use Auto-Changelog   : " . ($useUpdateChangelogWorkflow ? 'yes' : 'no'));
Niels's avatar
Niels committed
165
166
167
168
169
170
171
172
writeln('------');

writeln('This script will replace the above values in all relevant files in the project directory.');

if (! confirm('Modify files?', true)) {
    exit(1);
}

IGedeon's avatar
IGedeon committed
173
$files = (str_starts_with(strtoupper(PHP_OS), 'WIN') ? replaceForWindows() : replaceForAllOtherOSes());
Niels's avatar
Niels committed
174
175
176
177
178
179
180
181
182
183
184

foreach ($files as $file) {
    replace_in_file($file, [
        ':author_name' => $authorName,
        ':author_username' => $authorUsername,
        'author@domain.com' => $authorEmail,
        ':vendor_name' => $vendorName,
        ':vendor_slug' => $vendorSlug,
        'VendorName' => $vendorNamespace,
        ':package_name' => $packageName,
        ':package_slug' => $packageSlug,
freek's avatar
freek committed
185
        ':package_slug_without_prefix' => $packageSlugWithoutPrefix,
Niels's avatar
Niels committed
186
        'Skeleton' => $className,
Emincan Ozcan's avatar
Emincan Ozcan committed
187
        'skeleton' => $packageSlug,
Niels's avatar
Niels committed
188
189
190
191
        ':package_description' => $description,
    ]);

    match (true) {
192
193
194
195
196
197
198
        str_contains($file, determineSeparator('src/Skeleton.php')) => rename($file, determineSeparator('./src/' . $className . '.php')),
        str_contains($file, determineSeparator('src/SkeletonServiceProvider.php')) => rename($file, determineSeparator('./src/' . $className . 'ServiceProvider.php')),
        str_contains($file, determineSeparator('src/Facades/Skeleton.php')) => rename($file, determineSeparator('./src/Facades/' . $className . '.php')),
        str_contains($file, determineSeparator('src/Commands/SkeletonCommand.php')) => rename($file, determineSeparator('./src/Commands/' . $className . 'Command.php')),
        str_contains($file, determineSeparator('database/migrations/create_skeleton_table.php.stub')) => rename($file, determineSeparator('./database/migrations/create_' . $packageSlugWithoutPrefix . '_table.php.stub')),
        str_contains($file, determineSeparator('config/skeleton.php')) => rename($file, determineSeparator('./config/' . $packageSlugWithoutPrefix . '.php')),
        str_contains($file, 'README.md') => remove_readme_paragraphs($file),
Niels's avatar
Niels committed
199
200
201
202
        default => [],
    };
}

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
if (! $usePhpCsFixer) {
    safeUnlink(__DIR__ . '/.php_cs.dist.php');
    safeUnlink(__DIR__ . '/.github/workflows/php-cs-fixer.yml');
}

if (! $usePhpStan) {
    safeUnlink(__DIR__ . '/phpstan.neon.dist');
    safeUnlink(__DIR__ . '/phpstan-baseline.neon');
    safeUnlink(__DIR__ . '/.github/workflows/phpstan.yml');

    remove_composer_deps([
        'phpstan/extension-installer',
        'phpstan/phpstan-deprecation-rules',
        'phpstan/phpstan-phpunit',
        'nunomaduro/larastan',
    ]);
219

220
221
222
223
224
225
226
    remove_composer_script('phpstan');
}

if (! $useUpdateChangelogWorkflow) {
    safeUnlink(__DIR__ . '/.github/workflows/update-changelog.yml');
}

Niels's avatar
Niels committed
227
228
229
confirm('Execute `composer install` and run tests?') && run('composer install && composer test');

confirm('Let this script delete itself?', true) && unlink(__FILE__);