Add internal HydeFronts automation scripts to lint and handle releases and versions

.github/workflows/continuous-integration.yml

@@ -106,10 +106,6 @@ jobs:
         working-directory: 'packages/hydefront'
         run: npm run prod
 
-      - name: Add copyright text to compiled file
-        # add '/*! HydeFront v3.3.0 | MIT License | https://hydephp.com*/' to the top of the packages/hydefront/dist/hyde.css file
-        run: sed -i '1s/^/\/\*! HydeFront v3.3.0 | MIT License | https:\/\/hydephp.com\*\/\n/' packages/hydefront/dist/hyde.css
-
       - name: Upload artifacts
         uses: actions/upload-artifact@v1
         with:
@@ -588,3 +584,16 @@ jobs:
         uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: snyk.sarif
+
+
+  hydefront-lint:
+    name: HydeFront Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run linter
+        run: php packages/hydefront/.github/scripts/post-build.php

packages/hydefront/.github/scripts/minima.php

@@ -0,0 +1,4 @@
+<?php
+
+// This file is part of Minima.
+interface Minima{const VERSION='v0.1.0-dev';}interface Console{const INPUT=STDIN;const OUTPUT=STDOUT;}interface ANSI extends ANSI_EXT,XML_ANSI{const BLACK="\033[30m";const RED="\033[31m";const GREEN="\033[32m";const YELLOW="\033[33m";const BLUE="\033[34m";const MAGENTA="\033[35m";const CYAN="\033[36m";const WHITE="\033[37m";const GRAY="\033[90m";const RESET="\033[0m";}interface ANSI_EXT{const BRIGHT_RED="\033[91m";const BRIGHT_GREEN="\033[92m";const BRIGHT_YELLOW="\033[93m";const BRIGHT_BLUE="\033[94m";const BRIGHT_MAGENTA="\033[95m";const BRIGHT_CYAN="\033[96m";const BRIGHT_WHITE="\033[97m";}interface XML_ANSI{const INFO=ANSI::GREEN;const WARNING=ANSI::YELLOW;const ERROR=ANSI::RED;const COMMENT=ANSI::GRAY;const RESET=ANSI::RESET;}trait InteractsWithIO{public function write(string $string):void{Output::write($string);}public function line(string $message=''):void{Output::write($message."\n");}public function info(string $message):void{$this->line(XML_ANSI::INFO.$message.ANSI::RESET);}public function warning(string $message):void{$this->line(XML_ANSI::WARNING.$message.ANSI::RESET);}public function error(string $message):void{$this->line(XML_ANSI::ERROR.$message.ANSI::RESET);}public function formatted(string $message,bool $newLine=true):void{$startTags=['<info>'=>XML_ANSI::INFO,'<warning>'=>XML_ANSI::WARNING,'<error>'=>XML_ANSI::ERROR,'<comment>'=>XML_ANSI::COMMENT,'<reset>'=>XML_ANSI::RESET,'<red>'=>ANSI::RED,'<green>'=>ANSI::GREEN,'<blue>'=>ANSI::BLUE,'<yellow>'=>ANSI::YELLOW,'<magenta>'=>ANSI::MAGENTA,'<cyan>'=>ANSI::CYAN,];$endTags=['</info>'=>XML_ANSI::RESET,'</warning>'=>XML_ANSI::RESET,'</error>'=>XML_ANSI::RESET,'</comment>'=>XML_ANSI::RESET,'</reset>'=>XML_ANSI::RESET,'</>'=>XML_ANSI::RESET,'</red>'=>ANSI::RESET,'</green>'=>ANSI::RESET,'</blue>'=>ANSI::RESET,'</yellow>'=>ANSI::RESET,'</magenta>'=>ANSI::RESET,'</cyan>'=>ANSI::RESET,];$formatted=str_replace(array_keys($startTags),array_values($startTags),$message);$formatted=str_replace(array_keys($endTags),array_values($endTags),$formatted);if($newLine){$this->line($formatted);}else{$this->write($formatted);}}public function ask(string $question,string $default=''):string{return Input::readline(ANSI::YELLOW."$question: ".ANSI::RESET)?:$default;}}trait AccessesArguments{protected function options():array{return $this->options;}protected function arguments():array{return $this->arguments;}protected function hasOption(string $name):bool{return isset($this->options[$name]);}protected function hasArgument(string $name):bool{return isset($this->arguments[$name])||isset(array_flip(array_values($this->arguments))[$name]);}protected function getOption(string $name,mixed $default=null):mixed{return $this->options[$name]?? $default;}protected function getArgument(string $name,mixed $default=null):mixed{return $this->arguments[$name]?? $this->getArgumentByValue($name)?? $default;}private function getArgumentByValue(string $value):?string{$index=array_flip(array_values($this->arguments))[$value]?? null;return $this->arguments[$index]?? null;}private static function parseOptions(array $options):array{$formatted=[];foreach($options as $index=>$option){$option=ltrim($option,'-');if(str_contains($option,'=')){$parts=explode('=',$option);$formatted[$parts[0]]=$parts[1];}else{$formatted[$option]=true;}}return $formatted;}private static function parseArguments(array $arguments):array{$formatted=[];foreach($arguments as $index=>$argument){if(str_contains($argument,'=')){$parts=explode('=',$argument);$formatted[$parts[0]]=$parts[1];}else{$formatted[$index]=$argument;}}return $formatted;}private static function parseCommandArguments():array{global $argc;global $argv;$options=[];$arguments=[];for($i=1;$i<$argc;$i++){if(str_starts_with($argv[$i],'-')){$options[]=$argv[$i];}else{$arguments[]=$argv[$i];}}return[self::parseOptions($options),self::parseArguments($arguments)];}}class Output{public static function write(string $string):void{file_put_contents('php://output',$string);}}class Input{public static function readline(?string $prompt=null):string{return readline($prompt);}public static function getline():string{return trim(fgets(Console::INPUT));}}class Command{use InteractsWithIO;use AccessesArguments;protected Output $output;protected array $options;protected array $arguments;protected function __construct(){$this->output=new Output();[$this->options,$this->arguments]=$this->parseCommandArguments();}public static function main(Closure $logic):int{$command=new static();$logic=$logic->bindTo($command,static::class);return $logic()?? 0;}}class Dumper{public static int $arrayBreakLevel=2;const INDENT='  ';const ARRAY_OPEN=ANSI::WHITE.'['.ANSI::RESET;const ARRAY_CLOSE=ANSI::WHITE.']'.ANSI::RESET;const STRING_OPEN=ANSI::BLUE."'".ANSI::GREEN;const STRING_CLOSE=ANSI::BLUE."'".ANSI::RESET;const INTEGER_OPEN=ANSI::YELLOW;const INTEGER_CLOSE=ANSI::RESET;const BOOLEAN_OPEN=ANSI::RED;const BOOLEAN_CLOSE=ANSI::RESET;const OBJECT_OPEN=ANSI::YELLOW;const OBJECT_CLOSE=ANSI::RESET;const NULL=ANSI::RED.'null'.ANSI::RESET;protected int $indentationLevel=0;protected bool $inOpenArray=false;public static function highlight(mixed $data):string{return(new static())->runHighlighter($data);}protected function runHighlighter(mixed $data):string{if(is_null($data)){return $this->null($data);}if(is_string($data)){return $this->string($data);}if(is_int($data)){return $this->int($data);}if(is_bool($data)){return $this->bool($data);}if(is_array($data)){return $this->array($data);}if(is_object($data)){return static::OBJECT_OPEN.$data::class.static::OBJECT_CLOSE;}return (string) $data;}protected function null(null|string $value):string{return static::NULL;}protected function string(string $value):string{return static::STRING_OPEN.$value.static::STRING_CLOSE;}protected function int(int $value):string{return static::INTEGER_OPEN.$value.static::INTEGER_CLOSE;}protected function bool(bool $value):string{return static::BOOLEAN_OPEN.($value?'true':'false').static::BOOLEAN_CLOSE;}protected function array(array $array):string{$this->indentationLevel++;if($this->indentationLevel>=static::$arrayBreakLevel-1){$this->inOpenArray=true;}$parts=[];foreach($array as $key=>$value){if($this->inOpenArray){$indent=str_repeat(self::INDENT,$this->indentationLevel);}else{$indent='';}if(is_int($key)){$parts[]=$indent.$this->runHighlighter($value);}else{$parts[]=$indent.$this->string($key).' => '.$this->runHighlighter($value);}}if($this->inOpenArray){$this->indentationLevel--;$indent=str_repeat(self::INDENT,$this->indentationLevel);return static::ARRAY_OPEN."\n".implode(",\n",$parts)."\n$indent".static::ARRAY_CLOSE;}else{return static::ARRAY_OPEN.''.implode(', ',$parts).''.static::ARRAY_CLOSE;}}}if(!function_exists('main')){function main(Closure $logic):int{return Command::main($logic);}}if(!function_exists('dump')){function dump(mixed $value,bool $highlight=false):void{if($highlight){echo Dumper::highlight($value)."\n";}else{var_dump($value);}}}if(!function_exists('dd')){function dd(mixed $value,bool $highlight=false):never{dump($value,$highlight);exit(1);}}if(!function_exists('task')){function task(string $name,callable $task):void{$timeStart=microtime(true);global $argv;if(in_array('--skip-tasks',$argv)){putenv('SKIP_TASKS=true');$setLocation='option';}Output::write(ANSI::GREEN.'Running task '.ANSI::YELLOW."$name".ANSI::GREEN.'...'.ANSI::RESET.' ');if(!getenv('SKIP_TASKS')){ob_start();$task();$buffer=ob_get_clean();$time=round((microtime(true)-$timeStart)*1000,2);Output::write(ANSI::GREEN.'Done! '.ANSI::GRAY."(took {$time}ms)"." \n".ANSI::RESET);}else{$setLocation=$setLocation ?? 'environment variable';Output::write(ANSI::YELLOW.'Skipped '.ANSI::GRAY."(as set in $setLocation)\n".ANSI::RESET);}if(!empty($buffer)){foreach(explode("\n",trim($buffer))as $line){Output::write("  $line\n");}}}}

packages/hydefront/.github/scripts/post-build.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/minima.php';
+
+exit(main(function (): int {
+    $baseDir = __DIR__.'/../../';
+
+    if ($this->hasOption('inject-version')) {
+        $package = json_decode(file_get_contents($baseDir.'package.json'), true);
+        $version = $package['version'];
+        $css = file_get_contents($baseDir.'dist/hyde.css');
+
+        if (str_contains($css, '/*! HydeFront')) {
+            $this->error('Version already injected in dist/hyde.css');
+            return 1;
+        }
+
+        $template = '/*! HydeFront v{{ $version }} | MIT License | https://hydephp.com*/';
+        $versionString = str_replace('{{ $version }}', $version, $template);
+        $css = "$versionString\n$css";
+        file_put_contents($baseDir.'dist/hyde.css', $css);
+
+        return 0;
+    }
+
+    $this->info('Verifying build files...');
+    $exitCode = 0;
+
+    $package = json_decode(file_get_contents($baseDir.'package.json'), true);
+    $version = $package['version'];
+    $this->line("Found version '$version' in package.json");
+
+    $hydeCssVersion = getCssVersion($baseDir.'dist/hyde.css');
+    $this->line("Found version '$hydeCssVersion' in dist/hyde.css");
+
+    $appCssVersion = getCssVersion($baseDir.'dist/app.css');
+    $this->line("Found version '$appCssVersion' in dist/app.css");
+
+    if ($this->hasOption('fix')) {
+        $this->info('Fixing build files...');
+
+        if ($version !== $hydeCssVersion) {
+            $this->line(' > Updating dist/hyde.css...');
+            $contents = file_get_contents($baseDir.'dist/hyde.css');
+            $contents = str_replace($hydeCssVersion, $version, $contents);
+            file_put_contents($baseDir.'dist/hyde.css', $contents);
+            $filesChanged = true;
+        }
+
+        if ($version !== $appCssVersion) {
+            $this->line(' > Updating dist/app.css...');
+            $contents = file_get_contents($baseDir.'dist/app.css');
+            $contents = str_replace($appCssVersion, $version, $contents);
+            file_put_contents($baseDir.'dist/app.css', $contents);
+            $filesChanged = true;
+        }
+
+        if (isset($filesChanged)) {
+            $this->info('Build files fixed');
+
+            // Run the script again to verify the changes, but without the --fix option
+            $this->info('Verifying build files again...');
+            $this->line('---');
+            passthru('php packages/hydefront/.github/scripts/post-build.php', $verifyExitCode);
+            return $verifyExitCode;
+        } else {
+            $this->warning('Nothing to fix!');
+            return 0;
+        }
+    }
+
+    if ($version !== $hydeCssVersion) {
+        $this->error('Version mismatch in package.json and dist/hyde.css:');
+        $this->warning("Expected hyde.css to have version '$version', but found '$hydeCssVersion'");
+        $exitCode = 1;
+    }
+
+    if ($version !== $appCssVersion) {
+        $this->error('Version mismatch in package.json and dist/app.css:');
+        $this->warning("Expected app.css to have version '$version', but found '$appCssVersion'");
+        $exitCode = 1;
+    }
+
+    if ($exitCode > 0) {
+        $this->error('Exiting with errors.');
+    } else {
+        $this->info('Build files verified. All looks good!');
+    }
+
+    return $exitCode;
+}));
+
+function getCssVersion(string $path): string
+{
+    $contents = file_get_contents($path);
+    $prefix = '/*! HydeFront v';
+    if (! str_starts_with($contents, $prefix)) {
+        throw new Exception('Invalid CSS file');
+    }
+    $contents = substr($contents, strlen($prefix));
+    // Get everything before  |
+    $pipePos = strpos($contents, '|');
+    if ($pipePos === false) {
+        throw new Exception('Invalid CSS file');
+    }
+    $contents = substr($contents, 0, $pipePos);
+    return trim($contents);
+}

packages/hydefront/.github/scripts/version.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/minima.php';
+
+exit(main(function (): int {
+    if (! is_dir(getcwd() . '/packages')) {
+        $this->error('This script must be run from the root of the monorepo');
+        $this->warning('Current working directory: ' . getcwd());
+        return 1;
+    }
+
+    global $argv;
+    $versionType = $argv[1] ?? null;
+    if ($versionType === null) {
+        $this->error('Missing version type (supply as first argument)');
+        return 1;
+    }
+    /** @noinspection SpellCheckingInspection */
+    $nodeJsVersions = ['major', 'minor', 'patch', 'premajor', 'preminor', 'prepatch', 'prerelease'];
+    if (! in_array($versionType, $nodeJsVersions)) {
+        $this->error('Invalid version type: ' . $versionType);
+        $this->warning('Must be one of: '.implode(', ', $nodeJsVersions));
+        return 1;
+    }
+
+    $this->info("Creating a new HydeFront $versionType version...");
+    $version = trim(shell_exec('cd packages/hydefront && npm version ' . $versionType . ' --no-git-tag-version'));
+    $this->line("Updated package.json version to $version");
+
+    $this->info('Updating version in dist files...');
+    $this->line('---');
+    passthru('php packages/hydefront/.github/scripts/post-build.php --fix', $fixExitCode);
+    if ($fixExitCode !== 0) {
+        $this->error('Failed to update version in dist files');
+        return $fixExitCode;
+    }
+    $this->line('---');
+
+    $this->info('Committing changes in monorepo...');
+    passthru('git add packages/hydefront && git commit -m "Create HydeFront ' . $version . '"');
+
+    $this->info('Committing changes in HydeFront...');
+    passthru('cd packages/hydefront && git add . && git commit -m "HydeFront ' . $version . '"');
+
+    $this->info('All done!');
+    $this->warning("Don't forget to verify the changes, tag them, push them, then publish the NPM package and create the release on GitHub!");
+
+    if (! str_contains($versionType, 'patch')) {
+        $this->warning('This is not a patch version, so you should also update the version in the monorepo package.json');
+    }
+
+    return 0;
+}));

packages/hydefront/.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: Lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run linter
+        run: php .github/scripts/post-build.php

packages/hydefront/.github/workflows/node.js.yml

@@ -26,10 +26,6 @@ jobs:
       - name: Build assets for production
         run: npm run prod
 
-      - name: Add copyright text to compiled file
-        # add '/*! HydeFront v3.3.0 | MIT License | https://hydephp.com*/' to the top of the dist/hyde.css file
-        run: sed -i '1s/^/\/\*! HydeFront v3.3.0 | MIT License | https:\/\/hydephp.com\*\/\n/' dist/hyde.css
-
       - name: Upload artifacts
         uses: actions/upload-artifact@v1
         with: