v0.69.1

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Alfa integrations changelog
 
+## [0.69.1](../../compare/v0.69.0...v0.69.1) (2024-08-08)
+
+### Added
+
+- [@siteimprove/alfa-test-utils](packages/alfa-test-utils/CHANGELOG.md#0691): Documentation for the `@siteimprove/alfa-test-utils` package. ([#66](https://github.com/Siteimprove/alfa-integrations/pull/66))
+
+- [@siteimprove/alfa-test-utils](packages/alfa-test-utils/CHANGELOG.md#0691): Add utilities for pretty-printing console output. ([#64](https://github.com/Siteimprove/alfa-integrations/pull/64))
+
 ## [0.69.0](../../compare/v0.68.4...v0.69.0) (2024-08-07)
 
 ### Added

docs/api/alfa-test-utils.commitinformation.author.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [Author](./alfa-test-utils.commitinformation.author.md)
+
+## CommitInformation.Author property
+
+The name of the author of the latest commit.
+
+**Signature:**
+
+```typescript
+Author: string | undefined;
+```

docs/api/alfa-test-utils.commitinformation.branchname.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [BranchName](./alfa-test-utils.commitinformation.branchname.md)
+
+## CommitInformation.BranchName property
+
+The name of the current branch.
+
+**Signature:**
+
+```typescript
+BranchName: string;
+```

docs/api/alfa-test-utils.commitinformation.commithash.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [CommitHash](./alfa-test-utils.commitinformation.commithash.md)
+
+## CommitInformation.CommitHash property
+
+The hash of the latest commit.
+
+**Signature:**
+
+```typescript
+CommitHash: string | undefined;
+```

docs/api/alfa-test-utils.commitinformation.committimestamp.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [CommitTimestamp](./alfa-test-utils.commitinformation.committimestamp.md)
+
+## CommitInformation.CommitTimestamp property
+
+The timestamp of the latest commit.
+
+**Signature:**
+
+```typescript
+CommitTimestamp: string | undefined;
+```

docs/api/alfa-test-utils.commitinformation.email.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [Email](./alfa-test-utils.commitinformation.email.md)
+
+## CommitInformation.Email property
+
+The email of the author of the latest commit.
+
+**Signature:**
+
+```typescript
+Email: string | undefined;
+```

docs/api/alfa-test-utils.commitinformation.gitorigin.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [GitOrigin](./alfa-test-utils.commitinformation.gitorigin.md)
+
+## CommitInformation.GitOrigin property
+
+The origin's URL. This may vary depending on whether the repository was cloned using `http` or `ssh` protocol.
+
+**Signature:**
+
+```typescript
+GitOrigin: string | undefined;
+```

docs/api/alfa-test-utils.commitinformation.md

@@ -0,0 +1,170 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md)
+
+## CommitInformation interface
+
+
+**Signature:**
+
+```typescript
+export interface CommitInformation 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Author](./alfa-test-utils.commitinformation.author.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The name of the author of the latest commit.
+
+
+</td></tr>
+<tr><td>
+
+[BranchName](./alfa-test-utils.commitinformation.branchname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the current branch.
+
+
+</td></tr>
+<tr><td>
+
+[CommitHash](./alfa-test-utils.commitinformation.commithash.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The hash of the latest commit.
+
+
+</td></tr>
+<tr><td>
+
+[CommitTimestamp](./alfa-test-utils.commitinformation.committimestamp.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The timestamp of the latest commit.
+
+
+</td></tr>
+<tr><td>
+
+[Email](./alfa-test-utils.commitinformation.email.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The email of the author of the latest commit.
+
+
+</td></tr>
+<tr><td>
+
+[GitOrigin](./alfa-test-utils.commitinformation.gitorigin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The origin's URL. This may vary depending on whether the repository was cloned using `http` or `ssh` protocol.
+
+
+</td></tr>
+<tr><td>
+
+[Message](./alfa-test-utils.commitinformation.message.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The message of the latest commit.
+
+
+</td></tr>
+</tbody></table>

docs/api/alfa-test-utils.commitinformation.message.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [CommitInformation](./alfa-test-utils.commitinformation.md) &gt; [Message](./alfa-test-utils.commitinformation.message.md)
+
+## CommitInformation.Message property
+
+The message of the latest commit.
+
+**Signature:**
+
+```typescript
+Message: string | undefined;
+```

docs/api/alfa-test-utils.logging.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [Logging](./alfa-test-utils.logging.md)
+
+## Logging namespace
+
+Handling pretty-printing of console output.
+
+**Signature:**
+
+```typescript
+export declare namespace Logging 
+```
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[prepare(audit)](./alfa-test-utils.logging.prepare.md)
+
+
+</td><td>
+
+Prepare logging information
+
+
+</td></tr>
+<tr><td>
+
+[result(audit, pageReportURL)](./alfa-test-utils.logging.result.md)
+
+
+</td><td>
+
+Print results of an audit.
+
+
+</td></tr>
+</tbody></table>

docs/api/alfa-test-utils.logging.prepare.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@siteimprove/alfa-test-utils](./alfa-test-utils.md) &gt; [Logging](./alfa-test-utils.logging.md) &gt; [prepare](./alfa-test-utils.logging.prepare.md)
+
+## Logging.prepare() function
+
+Prepare logging information
+
+**Signature:**
+
+```typescript
+function prepare(audit: Audit.Result): Record<string, number>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+audit
+
+
+</td><td>
+
+[Audit.Result](./alfa-test-utils.audit.result.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Record&lt;string, number&gt;
+