styling

Author: Baptouuuu

documentation/advanced/logging.md

@@ -2,8 +2,8 @@
 
 If you want to trace everything that is done on your operating system you can use the logger decorator that will automatically write to your log file (almost) all operations.
 
-> [!NOTE]
-> data and actions done on a socket are not logged as well as processes output to prevent logging too much data (at least for now).
+!!! note ""
+    Data and actions done on a socket are not logged as well as processes output to prevent logging too much data (at least for now).
 
 ```php
 use Innmind\OperatingSystem\OperatingSystem\Logger;

documentation/index.md

@@ -1,3 +1,9 @@
+---
+hide:
+    - navigation
+    - toc
+---
+
 # Getting started
 
 This library is here to help abstract all the operations that involve the operating system the PHP code run on.
@@ -8,8 +14,8 @@ The other advantage to use higher level abstractions is to enable end user to bu
 
 For concrete examples have a look at the use cases available in the sidebar.
 
-> [!NOTE]
-> this library is a small overlay on top of a set of individual libraries that contain the concrete abstractions. So you can start using only a subset of abstractions in your code as a starting point.
+!!! note ""
+    This library is a small overlay on top of a set of individual libraries that contain the concrete abstractions. So you can start using only a subset of abstractions in your code as a starting point.
 
 ## Installation
 
@@ -27,21 +33,5 @@ $os = Factory::build();
 
 There's nothing more to add to start using this abstraction. Head toward the use cases to understand all the things you can do with it.
 
-> [!WARNING]
-> This library doesn't work on windows environments.
-
-## Use cases
-
-- [Manipulating time](use_cases/time.md)
-- [Filesystem](use_cases/filesystem.md)
-- [HTTP Client](use_cases/http.md)
-- [Processes](use_cases/processes.md)
-- [Inter Process Communication](use_cases/ipc.md)
-- [Socket communication](use_cases/socket.md)
-- [Handling process signals](use_cases/signals.md)
-- [SQL connection](use_cases/sql.md)
-
-## Advanced usage
-
-- [Logging all operations](advanced/logging.md)
-- [Extensions](advanced/extensions.md)
+!!! warning ""
+    This library doesn't work on windows environments.

documentation/use_cases/filesystem.md

@@ -37,7 +37,11 @@ use Innmind\Filesystem\{
 use Innmind\Url\Path;
 use Innmind\Immutable\Predicate\Instance;
 
-$addUserPicture = function(Adapter $filesystem, string $userId, File $picture): void {
+$addUserPicture = function(
+    Adapter $filesystem,
+    string $userId,
+    File $picture,
+): void {
     $filesystem
         ->get(Name::of($userId))
         ->keep(Instance::of(Directory::class))
@@ -73,7 +77,9 @@ Example of checking if a `maintenance.lock` exist to prevent your webapp from ru
 ```php
 use Innmind\Url\Path;
 
-if ($os->filesystem()->contains(Path::of('/path/to/project/maintenance.lock'))) {
+$path = Path::of('/path/to/project/maintenance.lock');
+
+if ($os->filesystem()->contains($path)) {
     throw new \RuntimeException('Application still in maintenance');
 }
 
@@ -85,7 +91,9 @@ Or you could check the existence of a directory that is required for another sub
 ```php
 use Innmind\Url\Path;
 
-if (!$os->filesystem()->contains(Path::of('/path/to/some/required/folder/'))) {
+$path = Path::of('/path/to/some/required/folder/');
+
+if (!$os->filesystem()->contains($path)) {
     $os->control()->processes()->execute($mkdirCommand);
 }
 
@@ -116,20 +124,23 @@ use Innmind\FileWatch\Continuation;
 
 $runTests = $os->filesystem()->watch(Path::of('/path/to/project/src/'));
 
-$count = $runTests(0, function(int $count, Continuation $continuation) use ($os): Continuation {
-    if ($count === 42) {
-        return $continuation->stop($count);
-    }
+$count = $runTests(
+    0,
+    function(int $count, Continuation $continuation) use ($os): Continuation {
+        if ($count === 42) {
+            return $continuation->stop($count);
+        }
 
-    $os->control()->processes()->execute($phpunitCommand);
+        $os->control()->processes()->execute($phpunitCommand);
 
-    return $continuation->continue(++$count);
-});
+        return $continuation->continue(++$count);
+    },
+);
 ```
 
 Here it will run phpunit tests every time the `src/` folder changes. Concrete examples of this pattern can be found in [`innmind/lab-station`](https://github.com/Innmind/LabStation/blob/develop/src/Agent/WatchSources.php#L38) to run a suite of tools when sources change.
 
 This operation is a bit like an `array_reduce` as you can keep a state record between each calls of the callable via the first argument (here `0`, but it can be anything) and the argument of your callable will be the previous value returned by `$continuation->continue()`.
 
-> [!WARNING]
-> since there is no builtin way to watch for changes in a directory it checks the directory every second, so use it with care. Watching an individual file is a bit safer as it uses the `tail` command so there is no `sleep()` used.
+!!! warning ""
+    Since there is no builtin way to watch for changes in a directory it checks the directory every second, so use it with care. Watching an individual file is a bit safer as it uses the `tail` command so there is no `sleep()` used.

documentation/use_cases/http.md

@@ -28,8 +28,8 @@ $response instanceof Response; // true
 
 All elements of a request/response call is built using objects to enforce correctness of the formatted messages.
 
-> [!NOTE]
-> since request and responses messages can be viewed either from a client or a server the model is abstracted in the standalone [`innmind/http` library](https://github.com/innmind/http).
+!!! note ""
+    Since request and responses messages can be viewed either from a client or a server the model is abstracted in the standalone [`innmind/http` library](https://github.com/innmind/http).
 
 ## Resiliency in a distributed system
 
@@ -63,5 +63,5 @@ $response = $http($request);
 $response = $http($request);
 ```
 
-> [!NOTE]
-> the circuit breaker works on host per host basis meaning if `server1.com` fails then calls to `server2.com` will still be sent.
+!!! note ""
+    The circuit breaker works on host per host basis meaning if `server1.com` fails then calls to `server2.com` will still be sent.

documentation/use_cases/ipc.md

@@ -4,8 +4,8 @@ To communicate between processes on a same system there is 2 approaches: sharing
 
 The later is the safest of the two (but not exempt of problems) and you will find here the building blocks to communicate via a socket.
 
-> [!TIP]
-> the adage `share state through messages and not messages through state` is a pillar of the [actor model](https://en.wikipedia.org/wiki/Actor_model) and [initially of object oriented programming](https://www.youtube.com/watch?v=7erJ1DV_Tlo).
+!!! tip ""
+    The adage `share state through messages and not messages through state` is a pillar of the [actor model](https://en.wikipedia.org/wiki/Actor_model) and [initially of object oriented programming](https://www.youtube.com/watch?v=7erJ1DV_Tlo).
 
 ```php
 # process acting as a server
@@ -61,5 +61,5 @@ echo $client
 
 In the case the server is started first then the client would print `Hello`.
 
-> [!WARNING]
-> this is a very rough implementation of communication between processes. **DO NOT** use this simple implementation in your code, instead use a higher level API such as [`innmind/ipc`](https://github.com/innmind/ipc).
+!!! warning ""
+    This is a very rough implementation of communication between processes. **DO NOT** use this simple implementation in your code, instead use a higher level API such as [`innmind/ipc`](https://github.com/innmind/ipc).

documentation/use_cases/processes.md

@@ -90,7 +90,11 @@ $backupRunning = $os
     ->status()
     ->processes()
     ->all()
-    ->any(fn($process): bool => $process->command()->matches(RegExp::of('~my-backup-tool~')));
+    ->any(
+        fn($process): bool => $process
+            ->command()
+            ->matches(RegExp::of('~my-backup-tool~')),
+    );
 
 if (!$backupRunning) {
     $os->control()->processes()->execute(

documentation/use_cases/signals.md

@@ -19,15 +19,21 @@ use Innmind\Immutable\{
     Str,
 };
 
-$client = $os->remote()->socket(Transport::tcp(), Ur::of('tcp://127.0.0.1:8080')->authority())->match(
-    static fn($client) => $client,
-    static fn() => throw new \RuntimeException('Unable to connect to the server'),
-);
+$client = $os
+    ->remote()
+    ->socket(Transport::tcp(), Url::of('tcp://127.0.0.1:8080')->authority())
+    ->match(
+        static fn($client) => $client,
+        static fn() => throw new \RuntimeException('Unable to connect to the server'),
+    );
 $watch = $os->sockets()->watch(new ElapsedPeriod(1000))->forRead($client);
 $signaled = true;
-$os->process()->signals()->listen(Signal::terminate, function() use (&$signaled) {
-    $signaled = false;
-});
+$os
+    ->process()
+    ->signals()
+    ->listen(Signal::terminate, function() use (&$signaled) {
+        $signaled = false;
+    });
 
 $receivedData = $client
     ->timeoutAfter(ElapsedPeriod::of(1_000))
@@ -52,8 +58,8 @@ $client->unwrap()->close();
 
 When the process receive the `SIGTERM` signal it will be paused then the anonymous function will be called and the process will then be resumed.
 
-> [!NOTE]
-> signal handling is already performed when using [`innmind/ipc`](https://github.com/innmind/ipc) or [`innmind/amqp`](https://github.com/innmind/amqp) so you don't have to think about it.
+!!! note ""
+    Signal handling is already performed when using [`innmind/ipc`](https://github.com/innmind/ipc) or [`innmind/amqp`](https://github.com/innmind/amqp) so you don't have to think about it.
 
 ## Prevent process from being stopped
 

documentation/use_cases/socket.md

@@ -17,10 +17,13 @@ use Innmind\Socket\Internet\Transport;
 use Innmind\IP\IPv4;
 use Innmind\TimeContinuum\Earth\ElapsedPeriod;
 
-$server = $os->ports()->open(Transport::tcp(), IPv4::localhost(), Port::of(8080))->match(
-    static fn($server) => $server,
-    static fn() => throw new \RuntimeException('Unable to start the server'),
-);
+$server = $os
+    ->ports()
+    ->open(Transport::tcp(), IPv4::localhost(), Port::of(8080))
+    ->match(
+        static fn($server) => $server,
+        static fn() => throw new \RuntimeException('Unable to start the server'),
+    );
 
 while (true) {
     $server
@@ -44,10 +47,13 @@ use Innmind\Url\Url;
 use Innmind\IO\Readable\Frame;
 use Innmind\Socket\Internet\Transport;
 
-$client = $os->remote()->socket(Transport::tcp(), Url::of('tcp://127.0.0.1:8080')->authority())->match(
-    static fn($client) => $client,
-    static fn() => throw new \RuntimeException('Unable to connect to the client'),
-);
+$client = $os
+    ->remote()
+    ->socket(Transport::tcp(), Url::of('tcp://127.0.0.1:8080')->authority())
+    ->match(
+        static fn($client) => $client,
+        static fn() => throw new \RuntimeException('Unable to connect to the client'),
+    );
 
 $receivedData = $client
     ->watch()

documentation/use_cases/sql.md

@@ -6,7 +6,9 @@ You can build a connection to a SQL server like so:
 use Innmind\Url\Url;
 use Formal\AccessLayer\Connection;
 
-$connection = $os->remote()->sql(Url::of('mysql://127.0.0.1:3306/database_name'));
+$connection = $os
+    ->remote()
+    ->sql(Url::of('mysql://127.0.0.1:3306/database_name'));
 
 $connection instanceof Connection; // true
 ```

documentation/use_cases/time.md

@@ -2,8 +2,8 @@
 
 Directly accessing time in a PHP code is straightforward (either via `DateTime` or time functions) but it prevents you to build testable code or require to use some hard to understand hacks. Instead it is simpler to think of time as another dependency that you need to inject in your code, thus easier to change the implementation when testing.
 
-> [!TIP]
-> for a more in length presentation of why directly accessing time is problematic you can watch this [talk](https://www.youtube.com/watch?v=T_I6HhP9-6w) (in french).
+??? tip
+    For a more in length presentation of why directly accessing time is problematic you can watch this [talk](https://www.youtube.com/watch?v=T_I6HhP9-6w) (in french).
 
 ## Accessing time
 
@@ -36,8 +36,8 @@ $crawl = function(CurrentProcess $process, string ...$urls): void {
         // crawl the $url and do something with the result
 
         // here for the sake of simplicity we specify 1 second but it can be
-        // any instance of Innmind\TimeContinuum\Period and you could build it
-        // from a robots.txt Crawler-Delay directive
+        // any instance of Innmind\TimeContinuum\Period and you could build
+        // it from a robots.txt Crawler-Delay directive
         $process->halt(new Second(1));
     }
 };