TASK: Script: Rename all import style from "./style.css" to style.module.css

[mhsdesign]

Currently any build stack gets confused by our "normal" style.css files, as they are not named style.module.css.
Sure we can work against that but its clearly better to stick to the conventions

Renamed "108" files
Replaced "124" imports

FYI the build works perfectly ;)

No worries it has been done by a script - and can be done again ^^

Show me the wizard who did this:

<?php

/*
 * Script to rename all import style from "./style.css" to style.module.css
 *
 * !!! Operates on ./packages in the current __DIR__
 *
 * Build for linux - should work on Mac - don't even try it on windoofs
 */

function renameStrategy(string $filename, string $extension): string {
    return $filename . '.module.css';
}

(function () {
    die("enable me");

    $regex = <<<'REGEX'
    /import[ ]+[a-zA-Z0-9]+[ ]+from[ ]+["'](?P<imported>.*\.css)["']/
    REGEX;

    $fileIterator = recursiveIterator(__DIR__ . "/packages");

    /**
     * Indexed by realpath of 'from' to rename. Value is 'to' be renamed to.
     * @var array<string,string> $filesToRename
     */
    $filesToRename = [];

    $replacedImports = 0;

    foreach (iterateOverFilesAndSelectByFileEnding($fileIterator, [".js", ".ts"]) as $file) {
        $contents = file_get_contents($file);

        $currentFileDir = dirname($file);

        $newContents = preg_replace_callback($regex, function ($matches) use ($currentFileDir, $file, &$filesToRename, &$replacedImports) {
            $rawImported = $matches["imported"];

            if (str_starts_with($rawImported, "@neos-project/")) {
                // package import `@neos-project/neos-ui-guest-frame/src/style.css`
                $import = substr_replace($rawImported, __DIR__ . "/packages/", 0, \strlen("@neos-project/"));
            } else {
                // relative import `../../style.css`
                $import = $currentFileDir . '/' . $rawImported;
            }

            if (!file_exists($import)) {
                echo <<<MSG
                --------
                import '$rawImported';
                File $import does not exist or this simplified dependency resolution does not work.
                It was imported in $file
                --------
                MSG;
                return $matches[0];
            }

            [
                'basename' => $basename,
                'dirname' => $dirname,
                'extension' => $extension,
                'filename' => $filename
            ] = pathinfo($import);

            $newFileNameWithExtension = renameStrategy($filename, $extension);
            $newFilePath = $dirname . '/' . $newFileNameWithExtension;


            $importRealPath = realpath($import);

            if (isset($filesToRename[$importRealPath]) === false) {
                $filesToRename[$importRealPath] = $newFilePath;
            }

            $replacedImports++;

            return str_replace($basename, $newFileNameWithExtension, $matches[0]);
        }, $contents, -1, $count);

        if ($count) {
            $success = file_put_contents($file, $newContents);
            if ($success === false) {
                echo <<<MSG
                --------
                $count could not be written to  $file
                --------
                MSG;
            }
        }
    }

    $renamedFiles = 0;
    foreach ($filesToRename as $from => $to) {
        $success = rename($from, $to);
        if (!$success) {
            echo <<<MSG
            --------
            Rename from $from to $to failed
            --------
            MSG;
        }
        $renamedFiles ++;
    }

    echo <<<MSG
    --------
    Renamed "$renamedFiles" files
    Replaced "$replacedImports" imports
    --------
    MSG;
})();

function recursiveIterator(string $basePath): \Iterator {
    $recursiveDirectoryIterator = new \RecursiveDirectoryIterator($basePath);
    return new \RecursiveIteratorIterator($recursiveDirectoryIterator);
}

/**
 * @param \Iterator|\SplFileInfo[] $fileIterator
 */
function iterateOverFilesAndSelectByFileEnding(\Iterator $fileIterator, array $fileEndings): \Generator {
    foreach ($fileIterator as $fileInfo) {
        if ($fileInfo->isDir()) {
            continue;
        }
        if (str_contains($fileInfo->getPath(), "/node_modules/")) {
            continue;
        }
        if (str_contains($fileInfo->getPath(), "/dist/")) {
            continue;
        }
        $pathAndFilename = $fileInfo->getPathname();
        foreach ($fileEndings as $ending) {
            if (str_ends_with($pathAndFilename, $ending)) {
                yield $pathAndFilename;
            }
        }
    }
}

[mhsdesign]

Must be regenerated

[mhsdesign]

thats why we dit it, we dont need that ugly logic anymore as we rely on conventions