@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | { |
| 68 | 68 | $this->data->import($config, $mode); |
| 69 | 69 | $this->setFromEnv(); // override configuration with environment variables |
| 70 | - $this->validate(); // validate configuration |
|
| 70 | + $this->validate(); // validate configuration |
|
| 71 | 71 | } |
| 72 | 72 | |
| 73 | 73 | /** |
@@ -385,7 +385,7 @@ discard block |
||
| 385 | 385 | * |
| 386 | 386 | * @throws ConfigException |
| 387 | 387 | */ |
| 388 | - public function getOutputFormatProperty(string $name, string $property): string|array|null |
|
| 388 | + public function getOutputFormatProperty(string $name, string $property): string | array | null |
|
| 389 | 389 | { |
| 390 | 390 | $properties = array_column((array) $this->get('output.formats'), $property, 'name'); |
| 391 | 391 | if (empty($properties)) { |
@@ -265,10 +265,10 @@ discard block |
||
| 265 | 265 | public static function sanitizeKey(string $key): string |
| 266 | 266 | { |
| 267 | 267 | $key = str_replace(['https://', 'http://'], '', $key); // remove protocol (if URL) |
| 268 | - $key = Page::slugify($key); // slugify |
|
| 269 | - $key = trim($key, '/'); // remove leading/trailing slashes |
|
| 270 | - $key = str_replace(['\\', '/'], ['-', '-'], $key); // replace slashes by hyphens |
|
| 271 | - $key = substr($key, 0, 200); // truncate to 200 characters (NTFS filename length limit is 255 characters) |
|
| 268 | + $key = Page::slugify($key); // slugify |
|
| 269 | + $key = trim($key, '/'); // remove leading/trailing slashes |
|
| 270 | + $key = str_replace(['\\', '/'], ['-', '-'], $key); // replace slashes by hyphens |
|
| 271 | + $key = substr($key, 0, 200); // truncate to 200 characters (NTFS filename length limit is 255 characters) |
|
| 272 | 272 | |
| 273 | 273 | return $key; |
| 274 | 274 | } |
@@ -301,7 +301,7 @@ discard block |
||
| 301 | 301 | /** |
| 302 | 302 | * Convert the various expressions of a TTL value into duration in seconds. |
| 303 | 303 | */ |
| 304 | - protected function duration(\DateInterval|int|null $ttl): int |
|
| 304 | + protected function duration(\DateInterval | int | null $ttl): int |
|
| 305 | 305 | { |
| 306 | 306 | if ($ttl === null) { |
| 307 | 307 | return $this->duration; |
@@ -310,7 +310,7 @@ discard block |
||
| 310 | 310 | return $ttl; |
| 311 | 311 | } |
| 312 | 312 | if ($ttl instanceof \DateInterval) { |
| 313 | - return (int)$ttl->format('%s'); |
|
| 313 | + return (int) $ttl->format('%s'); |
|
| 314 | 314 | } |
| 315 | 315 | |
| 316 | 316 | throw new \InvalidArgumentException('TTL values must be one of null, int, \DateInterval'); |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | 'metatags' => [ |
| 66 | 66 | 'robots' => 'index,follow', // SEO robots default directive |
| 67 | 67 | ], |
| 68 | - 'pages' => [ // Markdown content management |
|
| 68 | + 'pages' => [// Markdown content management |
|
| 69 | 69 | 'dir' => 'pages', // pages files directory |
| 70 | 70 | 'ext' => ['md', 'markdown', 'mdown', 'mkdn', 'mkd', 'text', 'txt'], // supported files formats, by extension |
| 71 | 71 | 'exclude' => ['vendor', 'node_modules'], // directories, paths and files name to exclude (accepts globs, strings and regexes) |
@@ -99,12 +99,12 @@ discard block |
||
| 99 | 99 | 'caption' => false, // puts the image in a <figure> element and adds a <figcaption> containing the title |
| 100 | 100 | 'placeholder' => '', // fill <img> background before loading (`color` or `lqip`) |
| 101 | 101 | 'class' => '', // puts default CSS class(es) to each image |
| 102 | - 'remote' => [ // turns remote images into Assets to process them (disable with `false`) |
|
| 102 | + 'remote' => [// turns remote images into Assets to process them (disable with `false`) |
|
| 103 | 103 | 'fallback' => '', // path to the fallback image, stored in assets directory (empty by default) |
| 104 | 104 | ], |
| 105 | 105 | ], |
| 106 | 106 | 'links' => [ |
| 107 | - 'embed' => [ // turns links in embedded content if possible |
|
| 107 | + 'embed' => [// turns links in embedded content if possible |
|
| 108 | 108 | 'enabled' => false, |
| 109 | 109 | 'video' => ['mp4', 'webm'], // supported video file types, by extension |
| 110 | 110 | 'audio' => ['mp3', 'ogg', 'wav'], // supported audio file types, by extension |
@@ -125,16 +125,16 @@ discard block |
||
| 125 | 125 | // <position> => 'Cecil\Generator\<class>', |
| 126 | 126 | //], |
| 127 | 127 | ], |
| 128 | - 'data' => [ // data files |
|
| 128 | + 'data' => [// data files |
|
| 129 | 129 | 'dir' => 'data', // data files directory |
| 130 | 130 | 'ext' => ['yaml', 'yml', 'json', 'xml', 'csv'], // loaded files by extension |
| 131 | 131 | 'load' => true, // enables `site.data` collection |
| 132 | 132 | ], |
| 133 | - 'assets' => [ // assets: CSS, JS, images, etc. |
|
| 133 | + 'assets' => [// assets: CSS, JS, images, etc. |
|
| 134 | 134 | 'dir' => 'assets', // assets files directory |
| 135 | 135 | 'target' => 'assets', // where processed assets are saved (in output directory) |
| 136 | 136 | 'fingerprint' => true, // enables fingerprinting |
| 137 | - 'compile' => [ // Sass files compilation |
|
| 137 | + 'compile' => [// Sass files compilation |
|
| 138 | 138 | 'style' => 'expanded', // compilation style (`expanded` or `compressed`) |
| 139 | 139 | 'import' => ['sass', 'scss', 'node_modules'], // list of imported directories |
| 140 | 140 | 'sourcemap' => false, // enables sourcemap in debug mode |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | 'optimize' => false, // enables images optimization with JpegOptim, Optipng, Pngquant 2, SVGO 1, Gifsicle, cwebp, avifenc |
| 146 | 146 | 'quality' => 75, // image quality after optimization or resize |
| 147 | 147 | 'formats' => [], // creates and adds formats images as `source` (e.g.: ['webp', 'avif']) |
| 148 | - 'responsive' => [ // options of generated responsive images |
|
| 148 | + 'responsive' => [// options of generated responsive images |
|
| 149 | 149 | 'widths' => [480, 640, 768, 1024, 1366, 1600, 1920], // `srcset` widths |
| 150 | 150 | 'sizes' => ['default' => '100vw'] // default `sizes` attribute |
| 151 | 151 | ], |
@@ -159,26 +159,26 @@ discard block |
||
| 159 | 159 | //] |
| 160 | 160 | ], |
| 161 | 161 | ], |
| 162 | - 'static' => [ // static files |
|
| 162 | + 'static' => [// static files |
|
| 163 | 163 | 'dir' => 'static', // static files directory |
| 164 | 164 | 'target' => '', // subdirectory where files are copied |
| 165 | 165 | 'exclude' => ['sass', 'scss', '*.scss', 'package*.json', 'node_modules'], // excluded files by extension or pattern |
| 166 | 166 | 'load' => false, // enables `site.static` collection |
| 167 | 167 | ], |
| 168 | - 'layouts' => [ // layouts and templates |
|
| 168 | + 'layouts' => [// layouts and templates |
|
| 169 | 169 | 'dir' => 'layouts', // Twig templates directory |
| 170 | - 'images' => [ // how to handle images in templates |
|
| 170 | + 'images' => [// how to handle images in templates |
|
| 171 | 171 | 'formats' => [], // creates and adds formats images as `source` (e.g.: ['webp', 'avif']) |
| 172 | 172 | 'responsive' => false, // enables responsive images |
| 173 | 173 | ], |
| 174 | - 'translations' => [ // i18n |
|
| 174 | + 'translations' => [// i18n |
|
| 175 | 175 | 'dir' => 'translations', // translations files directory |
| 176 | 176 | 'formats' => ['yaml', 'mo'], // translations supported formats |
| 177 | 177 | ], |
| 178 | - 'extensions' => [ // list of Twig extensions class |
|
| 178 | + 'extensions' => [// list of Twig extensions class |
|
| 179 | 179 | //'<name>' => 'Cecil\Renderer\Extension\<class>', |
| 180 | 180 | ], |
| 181 | - 'components' => [ // components |
|
| 181 | + 'components' => [// components |
|
| 182 | 182 | 'dir' => 'components', // components directory |
| 183 | 183 | 'ext' => 'twig', // components files extension |
| 184 | 184 | ], |
@@ -186,7 +186,7 @@ discard block |
||
| 186 | 186 | // '<section>' => '<layout>', |
| 187 | 187 | //] |
| 188 | 188 | ], |
| 189 | - 'output' => [ // output formats and post process |
|
| 189 | + 'output' => [// output formats and post process |
|
| 190 | 190 | 'dir' => '_site', // output directory |
| 191 | 191 | //'formats' => [ // https://cecil.app/documentation/configuration/#formats |
| 192 | 192 | // [ |
@@ -197,7 +197,7 @@ discard block |
||
| 197 | 197 | // 'exclude' => ['variable1', 'variable2'], |
| 198 | 198 | // ], |
| 199 | 199 | //], |
| 200 | - 'pagetypeformats' => [ // formats applied by page type |
|
| 200 | + 'pagetypeformats' => [// formats applied by page type |
|
| 201 | 201 | 'page' => ['html'], |
| 202 | 202 | 'homepage' => ['html', 'atom'], |
| 203 | 203 | 'section' => ['html', 'atom'], |
@@ -208,12 +208,12 @@ discard block |
||
| 208 | 208 | // '<name>' => 'Cecil\Renderer\PostProcessor\<class>', |
| 209 | 209 | //], |
| 210 | 210 | ], |
| 211 | - 'cache' => [ // cache management, disable with `false` |
|
| 211 | + 'cache' => [// cache management, disable with `false` |
|
| 212 | 212 | 'dir' => '.cache', // cache files directory |
| 213 | 213 | 'templates' => true, // disable Twig templates cache with `false` |
| 214 | 214 | 'translations' => true, // disable translations dictionary cache with `false` |
| 215 | 215 | ], |
| 216 | - 'optimize' => [ // files optimization |
|
| 216 | + 'optimize' => [// files optimization |
|
| 217 | 217 | 'enabled' => false, // enables files optimization |
| 218 | 218 | 'html' => [ |
| 219 | 219 | 'enabled' => true, // enables HTML files optimization |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | * |
| 66 | 66 | * @throws RuntimeException |
| 67 | 67 | */ |
| 68 | - public function __construct(Builder $builder, string|array $paths, array|null $options = null) |
|
| 68 | + public function __construct(Builder $builder, string | array $paths, array | null $options = null) |
|
| 69 | 69 | { |
| 70 | 70 | $this->builder = $builder; |
| 71 | 71 | $this->config = $builder->getConfig(); |
@@ -86,19 +86,19 @@ discard block |
||
| 86 | 86 | } |
| 87 | 87 | }); |
| 88 | 88 | $this->data = [ |
| 89 | - 'file' => '', // absolute file path |
|
| 90 | - 'files' => [], // array of absolute files path |
|
| 91 | - 'path' => '', // public path |
|
| 92 | - 'url' => null, // URL if it's a remote file |
|
| 89 | + 'file' => '', // absolute file path |
|
| 90 | + 'files' => [], // array of absolute files path |
|
| 91 | + 'path' => '', // public path |
|
| 92 | + 'url' => null, // URL if it's a remote file |
|
| 93 | 93 | 'missing' => false, // if file not found but missing allowed: 'missing' is true |
| 94 | - 'ext' => '', // file extension |
|
| 95 | - 'type' => '', // file type (e.g.: image, audio, video, etc.) |
|
| 96 | - 'subtype' => '', // file media type (e.g.: image/png, audio/mp3, etc.) |
|
| 97 | - 'size' => 0, // file size (in bytes) |
|
| 98 | - 'width' => 0, // image width (in pixels) |
|
| 99 | - 'height' => 0, // image height (in pixels) |
|
| 100 | - 'exif' => [], // image exif data |
|
| 101 | - 'content' => '', // file content |
|
| 94 | + 'ext' => '', // file extension |
|
| 95 | + 'type' => '', // file type (e.g.: image, audio, video, etc.) |
|
| 96 | + 'subtype' => '', // file media type (e.g.: image/png, audio/mp3, etc.) |
|
| 97 | + 'size' => 0, // file size (in bytes) |
|
| 98 | + 'width' => 0, // image width (in pixels) |
|
| 99 | + 'height' => 0, // image height (in pixels) |
|
| 100 | + 'exif' => [], // image exif data |
|
| 101 | + 'content' => '', // file content |
|
| 102 | 102 | ]; |
| 103 | 103 | |
| 104 | 104 | // handles options |