staticka / console
Terminal-based package for Staticka.
Requires
- php: >=5.3.0
- rougin/blueprint: ~0.7
- staticka/staticka: ~0.4
Requires (Dev)
- phpunit/phpunit: ~4.2|~5.7|~6.0|~7.0|~8.0|~9.0
- sanmai/phpunit-legacy-adapter: ~6.1|~8.0
This package is auto-updated.
Last update: 2024-12-09 16:53:47 UTC
README
Console
is a terminal-based package of Staticka which allows creating and building of pages through a terminal.
Installation
Installing the Console
package is possible through Composer:
$ composer require staticka/console
Basic Usage
To create a new page, use the create
command with its title:
$ vendor/bin/staticka create "Hello world!" [PASS] "Hello world!" page successfully created!
<!-- pages/20241028202552_hello-world.md --> --- name: Hello world! link: /hello-world title: Hello world! description: tags: category: --- # Hello world!
ciacme/
├── pages/
│ └── 20241028202552_hello-world.md
├── vendor/
└── composer.json
After adding some text to the newly created page, use the build
command to compile the .md
files to .html
:
$ vendor/bin/staticka build
[PASS] Pages successfully compiled!
ciacme/
├── build/
│ └── hello-world/
│ └── index.html
├── pages/
│ └── 20241028202552_hello-world.md
├── vendor/
└── composer.json
<!-- build/hello-world/index.html --> <h1>Hello world!</h1>
Note
Console
will try to create the required directories (e.g., build
, pages
) if they do not exists in the current working directory.
Using staticka.yml
Console
typically works out of the box without any configuration. But if there is a need to change the path of its other supported directories or needs to extend the core functionalities of Console
, the staticka.yml
file can be used in those kind of scenarios:
# staticka.yml root_path: %%CURRENT_DIRECTORY%% timezone: Asia/Manila assets_path: %%CURRENT_DIRECTORY%%/assets build_path: %%CURRENT_DIRECTORY%%/build config_path: %%CURRENT_DIRECTORY%%/config pages_path: %%CURRENT_DIRECTORY%%/pages plates_path: %%CURRENT_DIRECTORY%%/plates scripts_path: %%CURRENT_DIRECTORY%%/scripts styles_path: %%CURRENT_DIRECTORY%%/styles
To create the said staticka.yml
file, simply run the initialize
command:
$ vendor/bin/staticka initialize [PASS] "staticka.yml" added successfully!
After successfully creating the said file, it will provide the following properties below:
root_path
This property specifies the current working directory. By default, it uses the %%CURRENT_DIRECTORY%%
placeholder that returns the current directory of the staticka.yml
file:
# staticka.yml root_path: %%CURRENT_DIRECTORY%%/Sample # ...
timezone
This allows to change the timezone to be used when creating timestamps of a new page. If not specified, Console
will use the default timezone specified in the php.ini
file:
# staticka.yml timezone: Asia/Tokyo # ...
assets_path
This specifies the path for all other web assets like images (.jpg
, .png
) and PDF files (.pdf
). Console
does not use this specified path but it might be useful to locate the directory for organizing asset files:
# staticka.yml assets_path: %%CURRENT_DIRECTORY%%/assets # ...
build_path
This is the property that will be used by Console
to determine the destination directory of the compiled pages:
# staticka.yml build_path: %%CURRENT_DIRECTORY%%/build # ...
config_path
One of the properties of Console
that locates the directory for storing configuration files. If defined, it will load its .php
files to a Configuration
class. The said class is useful when creating extensions to Console
:
# staticka.yml config_path: %%CURRENT_DIRECTORY%%/config # ...
// config/parser.php return array( /** * @var \Staticka\Filter\FilterInterface[] */ 'filters' => array( 'Staticka\Expresso\Filters\GithubFilter', 'Staticka\Expresso\Filters\ReadmeFilter', ), );
// src/Package.php namespace Ciacme; use Rougin\Slytherin\Container\ContainerInterface; use Rougin\Slytherin\Container\ReflectionContainer; use Rougin\Slytherin\Integration\Configuration; use Rougin\Slytherin\Integration\IntegrationInterface; class Package implements IntegrationInterface { public function define(ContainerInterface $container, Configuration $config) { // Will try to access the "config/parser.php" file --- /** @var class-string[] */ $filters = $config->get('parser.filters', array()); // --------------------------------------------------- // ... } }
Note
To allow custom packages for Console
, kindly add the specified package class in staticka.yml
. Please see the Extending Console
section below for more information.
pages_path
This is the location of the generated pages from create
command:
# staticka.yml pages_path: %%CURRENT_DIRECTORY%%/pages # ...
plates_path
One of the special variables of Console
to specify a directory that can be used for third-party templating engines (RenderInterface
):
# staticka.yml plates_path: %%CURRENT_DIRECTORY%%/plates # ...
scripts_path
This is the property for the directory path of script files (.js
, .ts
). Although not being used internally by Console
, this property can be used when extending core functionalities (e.g., compiling .js
files through Webpack when running the build
command):
# staticka.yml scripts_path: %%CURRENT_DIRECTORY%%/scripts # ...
styles_path
Same as scripts_path
, this property specifies the directory path for styling files (.css
, .sass
):
# staticka.yml styles_path: %%CURRENT_DIRECTORY%%/styles # ...
Extending Console
Console
is based on the Slytherin PHP micro-framework which provides an easy way to integrate custom packages through IntegrationInterface
. The said interface can be used to create instances related to Staticka
:
// src/Package.php namespace Ciacme; use Rougin\Slytherin\Container\ContainerInterface; use Rougin\Slytherin\Container\ReflectionContainer; use Rougin\Slytherin\Integration\Configuration; use Rougin\Slytherin\Integration\IntegrationInterface; use Staticka\Filter\HtmlMinifier; use Staticka\Layout; class Package implements IntegrationInterface { /** * This sample package will always minify the compiled HTML files. * * @param \Rougin\Slytherin\Container\ContainerInterface $container * @param \Rougin\Slytherin\Integration\Configuration $config * * @return \Rougin\Slytherin\Container\ContainerInterface */ public function define(ContainerInterface $container, Configuration $config) { $layout = new Layout; $layout->addFilter(new HtmlMinifier); $container->set(get_class($layout), $layout); return $container; } }
To add the specified custom package, kindly add it to the staticka.yml
file:
# staticka.yml root_path: %%CURRENT_DIRECTORY%% # ... packages: - Ciacme\Package
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
The unit tests of Console
can be run using the phpunit
command:
$ vendor/bin/phpunit
Credits
License
The MIT License (MIT). Please see LICENSE for more information.