11 Commits

Author SHA1 Message Date
Morten Olsen
cef969dfd6 feat: add javascript code block support (#13) 2025-05-19 10:28:57 +02:00
morten-olsen
bf14ef97b8 docs: generated README 2025-05-19 07:15:52 +00:00
Morten Olsen
ab2bb38f39 docs: add road-map 2025-05-19 09:14:47 +02:00
Morten Olsen
1d055e49f1 feat: rename 2025-05-19 09:07:21 +02:00
Morten Olsen
b308c7f9fe fix: align yaml option with documentation 2025-05-18 22:36:25 +02:00
Morten Olsen
ba56b66222 fix: yaml parsing 2025-05-18 22:29:50 +02:00
Morten Olsen
e0707e74fb docs: stuff 2025-05-18 22:18:15 +02:00
Morten Olsen
6b74a28989 docs: improved docs 2025-05-18 21:26:05 +02:00
morten-olsen
ad342e5f10 docs: generated README 2025-05-18 19:12:53 +00:00
Morten Olsen
5d485acc97 fix: fix parsing issue 2025-05-18 21:11:51 +02:00
morten-olsen
68f5025527 docs: generated README 2025-05-18 18:56:34 +00:00
22 changed files with 945 additions and 173 deletions

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
/node_modules/ /node_modules/
/dist/ /dist/
/*.html

437
README.md
View File

@@ -2,31 +2,69 @@
**`http.md` is a powerful tool that transforms your markdown files into living, executable API documentation and testing suites. Write your HTTP requests directly within markdown, see their responses, and use templating to build dynamic examples and test flows.** **`http.md` is a powerful tool that transforms your markdown files into living, executable API documentation and testing suites. Write your HTTP requests directly within markdown, see their responses, and use templating to build dynamic examples and test flows.**
It allows developers to create API documentation that is always accurate and up-to-date because the documentation itself _is_ the set of executable requests. This ensures that your examples work and your tests run directly from the documents you share. It allows developers to create API documentation that is always accurate and up-to-date because the documentation itself *is* the set of executable requests. This ensures that your examples work and your tests run directly from the documents you share.
## Key Features ## Key Features
- **Markdown-Native:** Define HTTP requests using familiar markdown code blocks. * **Markdown-Native:** Define HTTP requests using familiar markdown code blocks.
- **Live Requests:** Execute requests and embed their responses directly into your documentation. * **Live Requests:** Execute requests and embed their responses directly into your documentation.
- **Templating:** Use Handlebars syntax to chain requests, extract data from responses, and use external inputs. * **Templating:** Use Handlebars syntax to chain requests, extract data from responses, and use external inputs.
- **File Embedding:** Include and reuse requests from other markdown files. * **File Embedding:** Include and reuse requests from other markdown files.
- **Terminal & File Output:** View live previews in your terminal or build static markdown files for sharing or static site generation. * **Terminal & File Output:** View live previews in your terminal or build static markdown files for sharing or static site generation.
- **Watch Mode:** Automatically re-render documents on file changes for a fast development loop. * **Watch Mode:** Automatically re-render documents on file changes for a fast development loop.
- **Flexible Configuration:** Control request execution, output formatting, and visibility. * **Flexible Configuration:** Control request execution, output formatting, and visibility.
## Use Cases ## Use Cases
- **API Documentation:** Create clear, executable examples that users can trust. * **API Documentation:** Create clear, executable examples that users can trust.
- **Integration Testing:** Write simple integration test suites that verify API behavior. * **Integration Testing:** Write simple integration test suites that verify API behavior.
- **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output. * **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output.
- **Rapid Prototyping:** Quickly experiment with APIs and document your findings. * **Rapid Prototyping:** Quickly experiment with APIs and document your findings.
## Roadmap
* **Programmatic API** Use `http.md` inside existing scripts and pipelines
* **Environment Varaiables** Support using the runners environment variables in templates
* **JavaScript script support** Add JavaScript code blocks with execution, which will allow more advanced use-cases
* **Asserts** Add the ability to make HTTP assertions to use the document for testing
* **Templates** Write re-usable templates which can be used in documents
## Content
* [Key Features](#key-features)
* [Use Cases](#use-cases)
* [Roadmap](#roadmap)
* [Content](#content)
* [Installation](#installation)
* [Getting Started](#getting-started)
* [Your First Request](#your-first-request)
* [Rendering Documents](#rendering-documents)
* [Core Concepts](#core-concepts)
* [HTTP Request Blocks](#http-request-blocks)
* [The `::response` Directive](#the-response-directive)
* [Request IDs](#request-ids)
* [Templating with Handlebars](#templating-with-handlebars)
* [Available Variables for Templating](#available-variables-for-templating)
* [Templating Examples](#templating-examples)
* [Managing Documents](#managing-documents)
* [Embedding Other Documents (`::md`)](#embedding-other-documents-md)
* [Advanced Usage](#advanced-usage)
* [Using Input Variables](#using-input-variables)
* [HTTP Block Configuration Options](#http-block-configuration-options)
* [Directive Options](#directive-options)
* [`::response` Directive Options](#response-directive-options)
* [`::md[{file}]` Directive Options](#mdfile-directive-options)
* [`::input[{name}]` Directive Options](#inputname-directive-options)
* [Command-Line Interface (CLI)](#command-line-interface-cli)
* [`http.md dev <source_file.md>`](#httpmd-dev-source_filemd)
* [`http.md build <source_file.md> <output_file.md>`](#httpmd-build-source_filemd-output_filemd)
## Installation ## Installation
Install `http.md` globally using npm: Install `http.md` globally using npm:
```shell ```shell
npm i -g @morten-olsen/httpmd npm i -g @morten-olsen/http.md
``` ```
## Getting Started ## Getting Started
@@ -52,6 +90,7 @@ Content-Type: application/json
And here is the response: And here is the response:
::response ::response
```` ````
### Rendering Documents ### Rendering Documents
@@ -62,13 +101,13 @@ You have two primary ways to render your `http.md` file:
For a development server that outputs to your terminal and watches for changes: For a development server that outputs to your terminal and watches for changes:
```shell ```shell
httpmd dev example.md http.md dev example.md
``` ```
With watch mode: With watch mode:
```shell ```shell
httpmd dev --watch example.md http.md dev --watch example.md
``` ```
This command will process `example.md`, execute the HTTP requests, and print the resulting markdown (with responses filled in) to the terminal. With `--watch`, any changes to `example.md` will trigger a re-run. This command will process `example.md`, execute the HTTP requests, and print the resulting markdown (with responses filled in) to the terminal. With `--watch`, any changes to `example.md` will trigger a re-run.
@@ -77,13 +116,13 @@ You have two primary ways to render your `http.md` file:
To generate a new markdown file with the responses and templated values rendered: To generate a new markdown file with the responses and templated values rendered:
```shell ```shell
httpmd build example.md output.md http.md build example.md output.md
``` ```
With watch mode: With watch mode:
```shell ```shell
httpmd build --watch example.md output.md http.md build --watch example.md output.md
``` ```
This creates `output.md`, which is a static snapshot of `example.md` after all requests have been executed and templating applied. This file is suitable for version control, sharing, or integration with static site generators. This creates `output.md`, which is a static snapshot of `example.md` after all requests have been executed and templating applied. This file is suitable for version control, sharing, or integration with static site generators.
@@ -104,14 +143,14 @@ Content-Type: application/json
And here is the response: And here is the response:
``` ```http
HTTP/200 OK HTTP/200 OK
access-control-allow-credentials: true access-control-allow-credentials: true
access-control-allow-origin: * access-control-allow-origin: *
connection: keep-alive connection: keep-alive
content-length: 559 content-length: 559
content-type: application/json content-type: application/json
date: Sun, 18 May 2025 18:31:46 GMT date: Mon, 19 May 2025 07:15:17 GMT
server: gunicorn/19.9.0 server: gunicorn/19.9.0
{ {
@@ -128,18 +167,20 @@ server: gunicorn/19.9.0
"Host": "httpbin.org", "Host": "httpbin.org",
"Sec-Fetch-Mode": "cors", "Sec-Fetch-Mode": "cors",
"User-Agent": "node", "User-Agent": "node",
"X-Amzn-Trace-Id": "Root=1-682a2792-7df702ce77a3b3696937eaeb" "X-Amzn-Trace-Id": "Root=1-682ada85-516dfea550431bd2238aa456"
}, },
"json": { "json": {
"greeting": "Hello, http.md!" "greeting": "Hello, http.md!"
}, },
"origin": "172.214.199.239",
"url": "https://httpbin.org/post" "url": "https://httpbin.org/post"
} }
``` ```
```` ````
_(Note: Actual headers and some response fields might vary.)_ *(Note: Actual headers and some response fields might vary.)*
## Core Concepts ## Core Concepts
@@ -180,8 +221,8 @@ All requests in a document are executed sequentially from top to bottom by defau
The `::response` directive is used to render the full HTTP response (status line, headers, and body) of an HTTP request. The `::response` directive is used to render the full HTTP response (status line, headers, and body) of an HTTP request.
- **Implicit Last:** If used without any arguments (i.e., `::response`), it renders the response of the most recently defined `http` block above it. * **Implicit Last:** If used without any arguments (i.e., `::response`), it renders the response of the most recently defined `http` block above it.
- **Explicit by ID:** You can render the response of a specific request by referencing its ID (see [Request IDs](https://www.google.com/search?q=%23request-ids)). * **Explicit by ID:** You can render the response of a specific request by referencing its ID (see [Request IDs](https://www.google.com/search?q=%23request-ids)).
### Request IDs ### Request IDs
@@ -190,23 +231,23 @@ You can assign a unique ID to an `http` request block. This allows you to:
1. Reference its specific response in a `::response` directive. 1. Reference its specific response in a `::response` directive.
2. Access its request and response data in [Templating](https://www.google.com/search?q=%23templating-with-handlebars) via the `requests` and `responses` dictionaries. 2. Access its request and response data in [Templating](https://www.google.com/search?q=%23templating-with-handlebars) via the `requests` and `responses` dictionaries.
To add an ID, include `id=yourUniqueId` in the `http` block's info string: To add an ID, include `#yourUniqueId` or `id=yourUniqueId` in the `http` block's info string:
````markdown ````markdown
# Document with Multiple Requests # Document with Multiple Requests
First, create a resource: First, create a resource:
```http id=createUser ```http #createUser,yaml,json
POST https://httpbin.org/post POST https://httpbin.org/post
Content-Type: application/json Content-Type: application/json
{"username": "alpha"} username: alpha
``` ```
Then, fetch a different resource: Then, fetch a different resource:
```http id=getItem ```http #getItem
GET https://httpbin.org/get?item=123 GET https://httpbin.org/get?item=123
``` ```
@@ -215,8 +256,99 @@ Response from creating the user:
Response from getting the item: Response from getting the item:
::response{#getItem} ::response{#getItem}
```` ````
<details>
<summary>Output</summary>
````markdown
# Document with Multiple Requests
First, create a resource:
```http
POST https://httpbin.org/post
Content-Type: application/json
{"username":"alpha"}
```
Then, fetch a different resource:
```http
GET https://httpbin.org/get?item=123
```
Response from creating the user:
```http
HTTP/200 OK
access-control-allow-credentials: true
access-control-allow-origin: *
connection: keep-alive
content-length: 504
content-type: application/json
date: Mon, 19 May 2025 07:15:18 GMT
server: gunicorn/19.9.0
{
"args": {},
"data": "username: alpha",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "br, gzip, deflate",
"Accept-Language": "*",
"Content-Length": "15",
"Content-Type": "application/json",
"Host": "httpbin.org",
"Sec-Fetch-Mode": "cors",
"User-Agent": "node",
"X-Amzn-Trace-Id": "Root=1-682ada85-5841d69c253c03e450c0cfc8"
},
"json": null,
"origin": "172.214.199.239",
"url": "https://httpbin.org/post"
}
```
Response from getting the item:
```http
HTTP/200 OK
access-control-allow-credentials: true
access-control-allow-origin: *
connection: keep-alive
content-length: 385
content-type: application/json
date: Mon, 19 May 2025 07:15:18 GMT
server: gunicorn/19.9.0
{
"args": {
"item": "123"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "br, gzip, deflate",
"Accept-Language": "*",
"Host": "httpbin.org",
"Sec-Fetch-Mode": "cors",
"User-Agent": "node",
"X-Amzn-Trace-Id": "Root=1-682ada86-50ccd79351313f742de31921"
},
"origin": "172.214.199.239",
"url": "https://httpbin.org/get?item=123"
}
```
````
</details>
## Templating with Handlebars ## Templating with Handlebars
`http.md` uses [Handlebars](https://handlebarsjs.com/) for templating, allowing you to create dynamic content within your markdown files. You can inject data from request responses, input variables, and other requests into your HTTP blocks or general markdown text. `http.md` uses [Handlebars](https://handlebarsjs.com/) for templating, allowing you to create dynamic content within your markdown files. You can inject data from request responses, input variables, and other requests into your HTTP blocks or general markdown text.
@@ -227,47 +359,47 @@ Templating syntax uses double curly braces: `{{expression}}`.
Within your markdown document, the following variables are available in the Handlebars context: Within your markdown document, the following variables are available in the Handlebars context:
- **`request`** (Object): Details of the most recently processed HTTP request _before_ it's sent. * **`request`** (Object): Details of the most recently processed HTTP request *before* it's sent.
- `request.method` (String): The HTTP method (e.g., "GET", "POST"). * `request.method` (String): The HTTP method (e.g., "GET", "POST").
- `request.url` (String): The request URL. * `request.url` (String): The request URL.
- `request.headers` (Object): An object containing request headers. * `request.headers` (Object): An object containing request headers.
- `request.body` (String): The raw request body. * `request.body` (String): The raw request body.
- **`response`** (Object): Details of the most recently received HTTP response. * **`response`** (Object): Details of the most recently received HTTP response.
- `response.status` (Number): The HTTP status code (e.g., 200, 404). * `response.status` (Number): The HTTP status code (e.g., 200, 404).
- `response.statusText` (String): The HTTP status message (e.g., "OK", "Not Found"). * `response.statusText` (String): The HTTP status message (e.g., "OK", "Not Found").
- `response.headers` (Object): An object containing response headers. * `response.headers` (Object): An object containing response headers.
- `response.body` (String/Object): The response body. If the `http` block had the `json` option and the response was valid JSON, this will be a parsed JSON object. Otherwise, it's a raw string. * `response.body` (String/Object): The response body. If the `http` block had the `json` option and the response was valid JSON, this will be a parsed JSON object. Otherwise, it's a raw string.
- `response.rawBody` (String): The raw response body as a string, regardless of parsing. * `response.rawBody` (String): The raw response body as a string, regardless of parsing.
- _(In case of network errors or non-HTTP errors, `status` and `body` might reflect error information.)_ * *(In case of network errors or non-HTTP errors, `status` and `body` might reflect error information.)*
- **`requests`** (Object): A dictionary mapping request IDs to their respective `request` objects (as defined above). * **`requests`** (Object): A dictionary mapping request IDs to their respective `request` objects (as defined above).
- Example: `{{requests.createUser.url}}` * Example: `{{requests.createUser.url}}`
- **`responses`** (Object): A dictionary mapping request IDs to their respective `response` objects (as defined above). * **`responses`** (Object): A dictionary mapping request IDs to their respective `response` objects (as defined above).
- Example: `{{responses.createUser.status}}`, `{{responses.createUser.body.id}}` (if `body` is a parsed JSON object). * Example: `{{responses.createUser.status}}`, `{{responses.createUser.body.id}}` (if `body` is a parsed JSON object).
- **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag. * **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag.
- Example: If you run `httpmd dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`. * Example: If you run `http.md dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`.
### Templating Examples ### Templating Examples
**1. Using a value from a previous response in a new request:** **1. Using a value from a previous response in a new request:**
````markdown ````markdown
```http id=createItem json ```http #createItem,json
POST https://httpbin.org/post POST https://httpbin.org/post
Content-Type: application/json Content-Type: application/json
{"name": "My New Item"} {"name": "My New Item"}
``` ```
The new item ID is: {{responses.createItem.body.json.name}} The new item ID is: {{response.body.json.name}}
Now, let's fetch the item using a (mocked) ID from the response: Now, let's fetch the item using a (mocked) ID from the response:
@@ -276,9 +408,65 @@ GET https://httpbin.org/anything/{{responses.createItem.body.json.name}}
``` ```
::response{#fetchItem} ::response{#fetchItem}
```` ````
_(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)_ <details>
<summary>Output</summary>
````markdown
```http
POST https://httpbin.org/post
Content-Type: application/json
{"name": "My New Item"}
```
The new item ID is: My New Item
Now, let's fetch the item using a (mocked) ID from the response:
```http
GET https://httpbin.org/anything/My New Item
```
```http
HTTP/200 OK
access-control-allow-credentials: true
access-control-allow-origin: *
connection: keep-alive
content-length: 455
content-type: application/json
date: Mon, 19 May 2025 07:15:18 GMT
server: gunicorn/19.9.0
{
"args": {},
"data": "",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "br, gzip, deflate",
"Accept-Language": "*",
"Host": "httpbin.org",
"Sec-Fetch-Mode": "cors",
"User-Agent": "node",
"X-Amzn-Trace-Id": "Root=1-682ada86-5c212bfd7fd8d81a7749fe52"
},
"json": null,
"method": "GET",
"origin": "172.214.199.239",
"url": "https://httpbin.org/anything/My New Item"
}
```
````
</details>
*(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)*
**2. Displaying a status code in markdown text:** **2. Displaying a status code in markdown text:**
@@ -287,7 +475,7 @@ _(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response
GET https://httpbin.org/status/201 GET https://httpbin.org/status/201
``` ```
The request to `/status/201` completed with status code: \*\*\*\*. The request to `/status/201` completed with status code: ****.
```` ````
## Managing Documents ## Managing Documents
@@ -305,9 +493,10 @@ The requests from the embedded document are processed, and their `request` and `
Assume `_shared_requests.md` contains: Assume `_shared_requests.md` contains:
````markdown ````markdown
```http id=sharedGetRequest ```http #sharedGetRequest
GET https://httpbin.org/get GET https://httpbin.org/get
``` ```
```` ````
Then, in `main.md`: Then, in `main.md`:
@@ -319,7 +508,7 @@ Let's include some shared requests:
::md[./_shared_requests.md] ::md[./_shared_requests.md]
The shared GET request returned: The shared GET request returned: {{response.statusText}}
Now, a request specific to this document: Now, a request specific to this document:
@@ -327,12 +516,76 @@ Now, a request specific to this document:
POST https://httpbin.org/post POST https://httpbin.org/post
Content-Type: application/json Content-Type: application/json
{"dataFromMain": "someValue", "sharedUrl": ""} {"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
``` ```
::response ::response
```` ````
<details>
<summary>Output</summary>
````markdown
# Main Document
Let's include some shared requests:
```http
GET https://httpbin.org/get
```
The shared GET request returned: OK
Now, a request specific to this document:
```http
POST https://httpbin.org/post
Content-Type: application/json
{"dataFromMain": "someValue", "sharedUrl": "https://httpbin.org/get"}
```
```http
HTTP/200 OK
access-control-allow-credentials: true
access-control-allow-origin: *
connection: keep-alive
content-length: 644
content-type: application/json
date: Mon, 19 May 2025 07:15:18 GMT
server: gunicorn/19.9.0
{
"args": {},
"data": "{\"dataFromMain\": \"someValue\", \"sharedUrl\": \"https://httpbin.org/get\"}",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "br, gzip, deflate",
"Accept-Language": "*",
"Content-Length": "69",
"Content-Type": "application/json",
"Host": "httpbin.org",
"Sec-Fetch-Mode": "cors",
"User-Agent": "node",
"X-Amzn-Trace-Id": "Root=1-682ada86-4c99fed83b21605713289d8a"
},
"json": {
"dataFromMain": "someValue",
"sharedUrl": "https://httpbin.org/get"
},
"origin": "172.214.199.239",
"url": "https://httpbin.org/post"
}
```
````
</details>
When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating. When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating.
## Advanced Usage ## Advanced Usage
@@ -344,7 +597,7 @@ You can pass external data into your `http.md` documents using the `-i` (or `--i
**CLI Command:** **CLI Command:**
```shell ```shell
httpmd build mydoc.md output.md -i baseUrl=https://api.production.example.com -i apiKey=YOUR_SECRET_KEY http.md build mydoc.md output.md -i baseUrl=https://api.production.example.com -i apiKey=YOUR_SECRET_KEY
``` ```
**Markdown Usage (`mydoc.md`):** **Markdown Usage (`mydoc.md`):**
@@ -364,17 +617,17 @@ Authorization: Bearer
You can configure the behavior of each `http` code block by adding options to its info string, separated by commas. You can configure the behavior of each `http` code block by adding options to its info string, separated by commas.
- `id={your-id}`: Assigns a unique ID to the request. This ID can be used to reference the request's response in the `::response` directive and in templating variables (`requests.your-id`, `responses.your-id`). * `id={your-id}`: Assigns a unique ID to the request. This ID can be used to reference the request's response in the `::response` directive and in templating variables (`requests.your-id`, `responses.your-id`).
- Example: ` ```http id=getUser,json ` * Example: ` ```http id=getUser,json `
- `json`: If present, `http.md` will attempt to parse the **response body** as JSON. If successful, `response.body` (and `responses.id.body`) will be the parsed JavaScript object/array, making it easier to access its properties in templates (e.g., `{{response.body.fieldName}}`). * `json`: If present, `http.md` will attempt to parse the **response body** as JSON. If successful, `response.body` (and `responses.id.body`) will be the parsed JavaScript object/array, making it easier to access its properties in templates (e.g., `{{response.body.fieldName}}`).
- Example: ` ```http json ` * Example: ` ```http json `
- `yaml`: If present, the **request body** written in YAML format within the code block will be automatically converted to JSON before the request is sent. This allows for writing complex request bodies in a more human-readable YAML syntax. You should still set the `Content-Type` header appropriately (e.g., to `application/json`) if the server expects JSON. * `yaml`: If present, the **request body** written in YAML format within the code block will be automatically converted to JSON before the request is sent. This allows for writing complex request bodies in a more human-readable YAML syntax. You should still set the `Content-Type` header appropriately (e.g., to `application/json`) if the server expects JSON.
- Example: * Example:
````markdown ````markdown
```http yaml ```http yaml
@@ -389,13 +642,13 @@ You can configure the behavior of each `http` code block by adding options to it
``` ```
```` ````
- `disable`: If present, the HTTP request will **not** be executed. No actual network call will be made. The corresponding `response` variable will be undefined or empty, and `::response` will typically render a "Request disabled" message or similar. * `disable`: If present, the HTTP request will **not** be executed. No actual network call will be made. The corresponding `response` variable will be undefined or empty, and `::response` will typically render a "Request disabled" message or similar.
- Example: ` ```http disable ` * Example: ` ```http disable `
- `hidden`: If present, the `http` code block itself will **not be included** in the rendered output document. However, the request _is still made_ (unless `disable` is also specified), and its response data can be used in templates or displayed with an explicit `::response{#id}` directive. This is useful for prerequisite requests (like authentication) whose details you don't want to clutter the main documentation. * `hidden`: If present, the `http` code block itself will **not be included** in the rendered output document. However, the request *is still made* (unless `disable` is also specified), and its response data can be used in templates or displayed with an explicit `::response{#id}` directive. This is useful for prerequisite requests (like authentication) whose details you don't want to clutter the main documentation.
- Example: ` ```http id=authRequest,hidden ` * Example: ` ```http id=authRequest,hidden `
**Combined Example:** **Combined Example:**
@@ -421,12 +674,12 @@ Directives can also have options, specified similarly.
#### `::response` Directive Options #### `::response` Directive Options
- `id={id}` (or `#{id}` as a shorthand): Renders the output of a specific request identified by `{id}`. * `id={id}` (or `#{id}` as a shorthand): Renders the output of a specific request identified by `{id}`.
- Example: `::response{#getUser}` or `::response{id=getUser}` * Example: `::response{#getUser}` or `::response{id=getUser}`
- `yaml`: Renders the (typically JSON) response body formatted as YAML. This is for display purposes. * `yaml`: Renders the (typically JSON) response body formatted as YAML. This is for display purposes.
- Example: `::response{yaml}` * Example: `::response{yaml}`
- `truncate={chars}`: Truncates the displayed **response body** to the specified number of characters. Headers and status line are not affected. * `truncate={chars}`: Truncates the displayed **response body** to the specified number of characters. Headers and status line are not affected.
- Example: `::response{truncate=100}` * Example: `::response{truncate=100}`
**Combined Example for `::response`:** **Combined Example for `::response`:**
`::response{#getUser,yaml,truncate=500}` - Displays the response for request `getUser`, formats its body as YAML, and truncates the body display to 500 characters. `::response{#getUser,yaml,truncate=500}` - Displays the response for request `getUser`, formats its body as YAML, and truncates the body display to 500 characters.
@@ -435,52 +688,52 @@ Directives can also have options, specified similarly.
The `::md` directive embeds another markdown document. The `::md` directive embeds another markdown document.
- **File Path:** The first argument (required) is the path to the markdown file to embed. * **File Path:** The first argument (required) is the path to the markdown file to embed.
- Example: `::md[./includes/authentication.md]` * Example: `::md[./includes/authentication.md]`
- `hidden`: If present, the actual content (markdown) of the embedded document will not be rendered in the output. However, any `http` requests within the embedded document _are still processed_, and their `request` and `response` data become available in the parent document's templating context (via `requests.id` and `responses.id`). This is useful if you only want to execute the requests from an included file (e.g., a common setup sequence) and use their results, without displaying the embedded file's content. * `hidden`: If present, the actual content (markdown) of the embedded document will not be rendered in the output. However, any `http` requests within the embedded document *are still processed*, and their `request` and `response` data become available in the parent document's templating context (via `requests.id` and `responses.id`). This is useful if you only want to execute the requests from an included file (e.g., a common setup sequence) and use their results, without displaying the embedded file's content.
- Example: `::md[./setup_requests.md]{hidden}` * Example: `::md[./setup_requests.md]{hidden}`
#### `::input[{name}]` Directive Options #### `::input[{name}]` Directive Options
The `::input` directive is used to declare expected input variables The `::input` directive is used to declare expected input variables
- **Variable Name:** The first argument (required) is the name of the variable * **Variable Name:** The first argument (required) is the name of the variable
- Example: `::input[myVariable]` will define `input.myVariable` * Example: `::input[myVariable]` will define `input.myVariable`
- `required`: If present it will require that the variable is provided * `required`: If present it will require that the variable is provided
- `default={value}`: Defines the default value if no value has been provided * `default={value}`: Defines the default value if no value has been provided
- `format=string|number|bool|json|date`: If provided the value will be parsed using the specified format * `format=string|number|bool|json|date`: If provided the value will be parsed using the specified format
- \`\` * \`\`
## Command-Line Interface (CLI) ## Command-Line Interface (CLI)
The `httpmd` tool provides the following commands: The `http.md` tool provides the following commands:
### `httpmd dev <source_file.md>` ### `http.md dev <source_file.md>`
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**.
- **Purpose:** Useful for live development and quick previews. * **Purpose:** Useful for live development and quick previews.
- **Options:** * **Options:**
- `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-renders the output to the terminal. * `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-renders the output to the terminal.
- `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating (see [Using Input Variables](https://www.google.com/search?q=%23using-input-variables)). Can be specified multiple times for multiple variables. * `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating (see [Using Input Variables](https://www.google.com/search?q=%23using-input-variables)). Can be specified multiple times for multiple variables.
**Example:** **Example:**
```shell ```shell
httpmd dev api_tests.md --watch -i host=localhost:3000 http.md dev api_tests.md --watch -i host=localhost:3000
``` ```
### `httpmd build <source_file.md> <output_file.md>` ### `http.md build <source_file.md> <output_file.md>`
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`.
- **Purpose:** Generates a static, shareable markdown file with all dynamic content resolved. Ideal for version control, static site generation, or distributing documentation. * **Purpose:** Generates a static, shareable markdown file with all dynamic content resolved. Ideal for version control, static site generation, or distributing documentation.
- **Options:** * **Options:**
- `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-builds the `<output_file.md>`. * `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-builds the `<output_file.md>`.
- `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating. * `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating.
**Example:** **Example:**
```shell ```shell
httpmd build official_api_docs.md public/api_docs_v1.md -i version=v1.0 http.md build official_api_docs.md public/api_docs_v1.md -i version=v1.0
``` ```

View File

@@ -21,12 +21,24 @@ It allows developers to create API documentation that is always accurate and up-
- **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output. - **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output.
- **Rapid Prototyping:** Quickly experiment with APIs and document your findings. - **Rapid Prototyping:** Quickly experiment with APIs and document your findings.
## Roadmap
- **Programmatic API** Use `http.md` inside existing scripts and pipelines
- **Environment Varaiables** Support using the runners environment variables in templates
- **JavaScript script support** Add JavaScript code blocks with execution, which will allow more advanced use-cases
- **Asserts** Add the ability to make HTTP assertions to use the document for testing
- **Templates** Write re-usable templates which can be used in documents
## Content
::toc
## Installation ## Installation
Install `http.md` globally using npm: Install `http.md` globally using npm:
```shell ```shell
npm i -g @morten-olsen/httpmd npm i -g @morten-olsen/http.md
``` ```
## Getting Started ## Getting Started
@@ -47,13 +59,13 @@ You have two primary ways to render your `http.md` file:
For a development server that outputs to your terminal and watches for changes: For a development server that outputs to your terminal and watches for changes:
```shell ```shell
httpmd dev example.md http.md dev example.md
``` ```
With watch mode: With watch mode:
```shell ```shell
httpmd dev --watch example.md http.md dev --watch example.md
``` ```
This command will process `example.md`, execute the HTTP requests, and print the resulting markdown (with responses filled in) to the terminal. With `--watch`, any changes to `example.md` will trigger a re-run. This command will process `example.md`, execute the HTTP requests, and print the resulting markdown (with responses filled in) to the terminal. With `--watch`, any changes to `example.md` will trigger a re-run.
@@ -62,13 +74,13 @@ You have two primary ways to render your `http.md` file:
To generate a new markdown file with the responses and templated values rendered: To generate a new markdown file with the responses and templated values rendered:
```shell ```shell
httpmd build example.md output.md http.md build example.md output.md
``` ```
With watch mode: With watch mode:
```shell ```shell
httpmd build --watch example.md output.md http.md build --watch example.md output.md
``` ```
This creates `output.md`, which is a static snapshot of `example.md` after all requests have been executed and templating applied. This file is suitable for version control, sharing, or integration with static site generators. This creates `output.md`, which is a static snapshot of `example.md` after all requests have been executed and templating applied. This file is suitable for version control, sharing, or integration with static site generators.
@@ -128,10 +140,17 @@ You can assign a unique ID to an `http` request block. This allows you to:
1. Reference its specific response in a `::response` directive. 1. Reference its specific response in a `::response` directive.
2. Access its request and response data in [Templating](https://www.google.com/search?q=%23templating-with-handlebars) via the `requests` and `responses` dictionaries. 2. Access its request and response data in [Templating](https://www.google.com/search?q=%23templating-with-handlebars) via the `requests` and `responses` dictionaries.
To add an ID, include `id=yourUniqueId` in the `http` block's info string: To add an ID, include `#yourUniqueId` or `id=yourUniqueId` in the `http` block's info string:
::raw-md[./examples/with-multiple-requests.md] ::raw-md[./examples/with-multiple-requests.md]
<details>
<summary>Output</summary>
::raw-md[./examples/with-multiple-requests.md]{render}
</details>
## Templating with Handlebars ## Templating with Handlebars
`http.md` uses [Handlebars](https://handlebarsjs.com/) for templating, allowing you to create dynamic content within your markdown files. You can inject data from request responses, input variables, and other requests into your HTTP blocks or general markdown text. `http.md` uses [Handlebars](https://handlebarsjs.com/) for templating, allowing you to create dynamic content within your markdown files. You can inject data from request responses, input variables, and other requests into your HTTP blocks or general markdown text.
@@ -168,7 +187,7 @@ Within your markdown document, the following variables are available in the Hand
- **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag. - **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag.
- Example: If you run `httpmd dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`. - Example: If you run `http.md dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`.
### Templating Examples ### Templating Examples
@@ -176,6 +195,13 @@ Within your markdown document, the following variables are available in the Hand
::raw-md[./examples/with-template.md] ::raw-md[./examples/with-template.md]
<details>
<summary>Output</summary>
::raw-md[./examples/with-template.md]{render}
</details>
_(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)_ _(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)_
**2. Displaying a status code in markdown text:** **2. Displaying a status code in markdown text:**
@@ -185,7 +211,7 @@ _(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response
GET https://httpbin.org/status/201 GET https://httpbin.org/status/201
``` ```
The request to `/status/201` completed with status code: **{{response.status}}**. The request to `/status/201` completed with status code: **{{{response.status}}}**.
```` ````
## Managing Documents ## Managing Documents
@@ -202,34 +228,18 @@ The requests from the embedded document are processed, and their `request` and `
Assume `_shared_requests.md` contains: Assume `_shared_requests.md` contains:
````markdown ::raw-md[./examples/_shared_requests.md]
```http id=sharedGetRequest
GET https://httpbin.org/get
```
````
Then, in `main.md`: Then, in `main.md`:
````markdown ::raw-md[./examples/with-shared-requests.md]
# Main Document
Let's include some shared requests: <details>
<summary>Output</summary>
::md[./_shared_requests.md] ::raw-md[./examples/with-shared-requests.md]{render}
The shared GET request returned: {{responses.sharedGetRequest.status}} </details>
Now, a request specific to this document:
```http
POST https://httpbin.org/post
Content-Type: application/json
{"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
```
::response
````
When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating. When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating.
@@ -242,15 +252,15 @@ You can pass external data into your `http.md` documents using the `-i` (or `--i
**CLI Command:** **CLI Command:**
```shell ```shell
httpmd build mydoc.md output.md -i baseUrl=https://api.production.example.com -i apiKey=YOUR_SECRET_KEY http.md build mydoc.md output.md -i baseUrl=https://api.production.example.com -i apiKey=YOUR_SECRET_KEY
``` ```
**Markdown Usage (`mydoc.md`):** **Markdown Usage (`mydoc.md`):**
````markdown ````markdown
```http ```http
GET {{input.baseUrl}}/users/1 GET {{{input.baseUrl}}}/users/1
Authorization: Bearer {{input.apiKey}} Authorization: Bearer {{{input.apiKey}}}
``` ```
::response ::response
@@ -258,6 +268,33 @@ Authorization: Bearer {{input.apiKey}}
**Security Note:** For sensitive data like API keys, using input variables is highly recommended over hardcoding them in your markdown files. Avoid committing files with plaintext secrets; instead, provide them at runtime via the CLI. **Security Note:** For sensitive data like API keys, using input variables is highly recommended over hardcoding them in your markdown files. Avoid committing files with plaintext secrets; instead, provide them at runtime via the CLI.
### JavaScript Execution
You can execute `javascript` blocks by adding a `run` option which allows programmatically changing the context, making request assertions and solve other more advanced use cases
**Example:**
::raw-md[./examples/with-javascript.md]
<details>
<summary>Output</summary>
::raw-md[./examples/with-javascript.md]{run}
</details>
**Options:**
- `run`: If present the code block will be executed
- Example: ` ```javascript run `
- `hidden`: If present the code block will not be included in the resulting output
- Example: ` ```javascript hidden `
- `output`: If present the code blocks return value will be rendered as a `yaml` code block
### HTTP Block Configuration Options ### HTTP Block Configuration Options
You can configure the behavior of each `http` code block by adding options to its info string, separated by commas. You can configure the behavior of each `http` code block by adding options to its info string, separated by commas.
@@ -299,8 +336,8 @@ You can configure the behavior of each `http` code block by adding options to it
````markdown ````markdown
```http id=complexRequest,json,yaml,hidden ```http id=complexRequest,json,yaml,hidden
POST {{input.apiEndpoint}}/data POST {{{input.apiEndpoint}}}/data
X-API-Key: {{input.apiKey}} X-API-Key: {{{input.apiKey}}}
Content-Type: application/json Content-Type: application/json
# Request body written in YAML, will be converted to JSON # Request body written in YAML, will be converted to JSON
@@ -351,9 +388,9 @@ The `::input` directive is used to declare expected input variables
## Command-Line Interface (CLI) ## Command-Line Interface (CLI)
The `httpmd` tool provides the following commands: The `http.md` tool provides the following commands:
### `httpmd dev <source_file.md>` ### `http.md dev <source_file.md>`
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**.
@@ -365,10 +402,10 @@ Processes the `<source_file.md>`, executes all HTTP requests, resolves templates
**Example:** **Example:**
```shell ```shell
httpmd dev api_tests.md --watch -i host=localhost:3000 http.md dev api_tests.md --watch -i host=localhost:3000
``` ```
### `httpmd build <source_file.md> <output_file.md>` ### `http.md build <source_file.md> <output_file.md>`
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`.
@@ -380,5 +417,5 @@ Processes the `<source_file.md>`, executes all HTTP requests, resolves templates
**Example:** **Example:**
```shell ```shell
httpmd build official_api_docs.md public/api_docs_v1.md -i version=v1.0 http.md build official_api_docs.md public/api_docs_v1.md -i version=v1.0
``` ```

View File

@@ -0,0 +1,3 @@
```http #sharedGetRequest
GET https://httpbin.org/get
```

View File

@@ -0,0 +1,17 @@
```javascript run
input.test = "Hello World";
```
::input[test]
```http json
POST https://httpbin.org/post
{"input": "{{input.test}}"}
```
```javascript run,hidden
// Use chai's `expect`, `assert` or `should` to make assumptions
expect(response.body.json.input).to.equal("Hello World");
```

View File

@@ -2,16 +2,16 @@
First, create a resource: First, create a resource:
```http id=createUser ```http #createUser,yaml,json
POST https://httpbin.org/post POST https://httpbin.org/post
Content-Type: application/json Content-Type: application/json
{"username": "alpha"} username: alpha
``` ```
Then, fetch a different resource: Then, fetch a different resource:
```http id=getItem ```http #getItem
GET https://httpbin.org/get?item=123 GET https://httpbin.org/get?item=123
``` ```

View File

@@ -0,0 +1,18 @@
# Main Document
Let's include some shared requests:
::md[./_shared_requests.md]
The shared GET request returned: {{response.statusText}}
Now, a request specific to this document:
```http
POST https://httpbin.org/post
Content-Type: application/json
{"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
```
::response

View File

@@ -1,11 +1,11 @@
```http id=createItem json ```http #createItem,json
POST https://httpbin.org/post POST https://httpbin.org/post
Content-Type: application/json Content-Type: application/json
{"name": "My New Item"} {"name": "My New Item"}
``` ```
The new item ID is: {{responses.createItem.body.json.name}} The new item ID is: {{response.body.json.name}}
Now, let's fetch the item using a (mocked) ID from the response: Now, let's fetch the item using a (mocked) ID from the response:

View File

@@ -1,11 +1,11 @@
{ {
"name": "@morten-olsen/httpmd", "name": "@morten-olsen/http.md",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"main": "dist/exports.js", "main": "dist/exports.js",
"type": "module", "type": "module",
"bin": { "bin": {
"httpmd": "./bin/cli.mjs" "http.md": "./bin/cli.mjs"
}, },
"files": [ "files": [
"dist", "dist",
@@ -17,6 +17,7 @@
"build": "pnpm run build:lib && pnpm run build:readme", "build": "pnpm run build:lib && pnpm run build:readme",
"build:lib": "tsc --build", "build:lib": "tsc --build",
"build:readme": "pnpm run cli build docs/README.md README.md", "build:readme": "pnpm run cli build docs/README.md README.md",
"build:readme-html": "pnpm run cli build docs/README.md README.html -f html",
"dev:readme": "pnpm run cli dev docs/README.md --watch", "dev:readme": "pnpm run cli dev docs/README.md --watch",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
@@ -26,6 +27,7 @@
"devDependencies": { "devDependencies": {
"@pnpm/find-workspace-packages": "^6.0.9", "@pnpm/find-workspace-packages": "^6.0.9",
"@types/blessed": "^0.1.25", "@types/blessed": "^0.1.25",
"@types/chai": "^5.2.2",
"@types/marked-terminal": "^6.1.1", "@types/marked-terminal": "^6.1.1",
"@types/mdast": "^4.0.4", "@types/mdast": "^4.0.4",
"@types/node": "^22.15.18", "@types/node": "^22.15.18",
@@ -35,6 +37,8 @@
}, },
"dependencies": { "dependencies": {
"blessed": "^0.1.81", "blessed": "^0.1.81",
"chai": "^5.2.0",
"chalk": "^5.4.1",
"commander": "^14.0.0", "commander": "^14.0.0",
"dotenv": "^16.5.0", "dotenv": "^16.5.0",
"eventemitter3": "^5.0.1", "eventemitter3": "^5.0.1",
@@ -44,7 +48,9 @@
"marked-terminal": "^7.3.0", "marked-terminal": "^7.3.0",
"mdast-util-to-markdown": "^2.1.2", "mdast-util-to-markdown": "^2.1.2",
"mdast-util-to-string": "^4.0.0", "mdast-util-to-string": "^4.0.0",
"mdast-util-toc": "^7.1.0",
"rehype-stringify": "^10.0.1", "rehype-stringify": "^10.0.1",
"remark-behead": "^3.1.0",
"remark-directive": "^4.0.0", "remark-directive": "^4.0.0",
"remark-gfm": "^4.0.1", "remark-gfm": "^4.0.1",
"remark-parse": "^11.0.0", "remark-parse": "^11.0.0",

187
pnpm-lock.yaml generated
View File

@@ -11,6 +11,12 @@ importers:
blessed: blessed:
specifier: ^0.1.81 specifier: ^0.1.81
version: 0.1.81 version: 0.1.81
chai:
specifier: ^5.2.0
version: 5.2.0
chalk:
specifier: ^5.4.1
version: 5.4.1
commander: commander:
specifier: ^14.0.0 specifier: ^14.0.0
version: 14.0.0 version: 14.0.0
@@ -38,9 +44,15 @@ importers:
mdast-util-to-string: mdast-util-to-string:
specifier: ^4.0.0 specifier: ^4.0.0
version: 4.0.0 version: 4.0.0
mdast-util-toc:
specifier: ^7.1.0
version: 7.1.0
rehype-stringify: rehype-stringify:
specifier: ^10.0.1 specifier: ^10.0.1
version: 10.0.1 version: 10.0.1
remark-behead:
specifier: ^3.1.0
version: 3.1.0
remark-directive: remark-directive:
specifier: ^4.0.0 specifier: ^4.0.0
version: 4.0.0 version: 4.0.0
@@ -75,6 +87,9 @@ importers:
'@types/blessed': '@types/blessed':
specifier: ^0.1.25 specifier: ^0.1.25
version: 0.1.25 version: 0.1.25
'@types/chai':
specifier: ^5.2.2
version: 5.2.2
'@types/marked-terminal': '@types/marked-terminal':
specifier: ^6.1.1 specifier: ^6.1.1
version: 6.1.1 version: 6.1.1
@@ -428,9 +443,15 @@ packages:
'@types/cardinal@2.1.1': '@types/cardinal@2.1.1':
resolution: {integrity: sha512-/xCVwg8lWvahHsV2wXZt4i64H1sdL+sN1Uoq7fAc8/FA6uYHjuIveDwPwvGUYp4VZiv85dVl6J/Bum3NDAOm8g==} resolution: {integrity: sha512-/xCVwg8lWvahHsV2wXZt4i64H1sdL+sN1Uoq7fAc8/FA6uYHjuIveDwPwvGUYp4VZiv85dVl6J/Bum3NDAOm8g==}
'@types/chai@5.2.2':
resolution: {integrity: sha512-8kB30R7Hwqf40JPiKhVzodJs2Qc1ZJ5zuT3uzw5Hq/dhNCl3G3l83jfpdI1e20BP348+fV7VIL/+FxaXkqBmWg==}
'@types/debug@4.1.12': '@types/debug@4.1.12':
resolution: {integrity: sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==} resolution: {integrity: sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==}
'@types/deep-eql@4.0.2':
resolution: {integrity: sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==}
'@types/hast@3.0.4': '@types/hast@3.0.4':
resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==} resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==}
@@ -455,6 +476,9 @@ packages:
'@types/terminal-kit@2.5.7': '@types/terminal-kit@2.5.7':
resolution: {integrity: sha512-IpbCBFSb3OqCEZBZlk368tGftqss88eNQaJdD9msEShRbksEiVahEqroONi60ppUt9/arLM6IDrHMx9jpzzCOw==} resolution: {integrity: sha512-IpbCBFSb3OqCEZBZlk368tGftqss88eNQaJdD9msEShRbksEiVahEqroONi60ppUt9/arLM6IDrHMx9jpzzCOw==}
'@types/ungap__structured-clone@1.2.0':
resolution: {integrity: sha512-ZoaihZNLeZSxESbk9PUAPZOlSpcKx81I1+4emtULDVmBLkYutTcMlCj2K9VNlf9EWODxdO6gkAqEaLorXwZQVA==}
'@types/unist@2.0.11': '@types/unist@2.0.11':
resolution: {integrity: sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==} resolution: {integrity: sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==}
@@ -510,6 +534,10 @@ packages:
as-table@1.0.55: as-table@1.0.55:
resolution: {integrity: sha512-xvsWESUJn0JN421Xb9MQw6AsMHRCUknCe0Wjlxvjud80mU4E6hQf1A6NzQKcYNmYw62MfzEtXc+badstZP3JpQ==} resolution: {integrity: sha512-xvsWESUJn0JN421Xb9MQw6AsMHRCUknCe0Wjlxvjud80mU4E6hQf1A6NzQKcYNmYw62MfzEtXc+badstZP3JpQ==}
assertion-error@2.0.1:
resolution: {integrity: sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==}
engines: {node: '>=12'}
bail@2.0.2: bail@2.0.2:
resolution: {integrity: sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==} resolution: {integrity: sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==}
@@ -552,6 +580,10 @@ packages:
ccount@2.0.1: ccount@2.0.1:
resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==}
chai@5.2.0:
resolution: {integrity: sha512-mCuXncKXk5iCLhfhwTc0izo0gtEmpz5CtG2y8GiOINBlMVS6v8TMRc5TaLWKS6692m9+dVVfzgeVxR5UxWHTYw==}
engines: {node: '>=12'}
chalk@4.1.2: chalk@4.1.2:
resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==} resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==}
engines: {node: '>=10'} engines: {node: '>=10'}
@@ -576,6 +608,10 @@ packages:
character-reference-invalid@2.0.1: character-reference-invalid@2.0.1:
resolution: {integrity: sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==} resolution: {integrity: sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==}
check-error@2.1.1:
resolution: {integrity: sha512-OAlb+T7V4Op9OwdkjmguYRqncdlx5JiofwOAUkmTF+jNdHwzTaTs4sRAGpzLF3oOz5xAyDGrPgeIDFQmDOTiJw==}
engines: {node: '>= 16'}
chroma-js@2.6.0: chroma-js@2.6.0:
resolution: {integrity: sha512-BLHvCB9s8Z1EV4ethr6xnkl/P2YRFOGqfgvuMG/MyCbZPrTA+NeiByY6XvgF0zP4/2deU2CXnWyMa3zu1LqQ3A==} resolution: {integrity: sha512-BLHvCB9s8Z1EV4ethr6xnkl/P2YRFOGqfgvuMG/MyCbZPrTA+NeiByY6XvgF0zP4/2deU2CXnWyMa3zu1LqQ3A==}
@@ -646,6 +682,10 @@ packages:
decode-named-character-reference@1.1.0: decode-named-character-reference@1.1.0:
resolution: {integrity: sha512-Wy+JTSbFThEOXQIR2L6mxJvEs+veIzpmqD7ynWxMXGpnk3smkHQOp6forLdHsKpAMW9iJpaBBIxz285t1n1C3w==} resolution: {integrity: sha512-Wy+JTSbFThEOXQIR2L6mxJvEs+veIzpmqD7ynWxMXGpnk3smkHQOp6forLdHsKpAMW9iJpaBBIxz285t1n1C3w==}
deep-eql@5.0.2:
resolution: {integrity: sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==}
engines: {node: '>=6'}
defaults@1.0.4: defaults@1.0.4:
resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==} resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==}
@@ -740,6 +780,9 @@ packages:
get-tsconfig@4.10.0: get-tsconfig@4.10.0:
resolution: {integrity: sha512-kGzZ3LWWQcGIAmg6iWvXn0ei6WDtV26wzHRMwDSzmAbcXrTEXxHy6IehI6/4eT6VRKyMP1eF1VqwrVUmE/LR7A==} resolution: {integrity: sha512-kGzZ3LWWQcGIAmg6iWvXn0ei6WDtV26wzHRMwDSzmAbcXrTEXxHy6IehI6/4eT6VRKyMP1eF1VqwrVUmE/LR7A==}
github-slugger@2.0.0:
resolution: {integrity: sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==}
glob-parent@5.1.2: glob-parent@5.1.2:
resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==}
engines: {node: '>= 6'} engines: {node: '>= 6'}
@@ -890,9 +933,15 @@ packages:
resolution: {integrity: sha512-gUD/epcRms75Cw8RT1pUdHugZYM5ce64ucs2GEISABwkRsOQr0q2wm/MV2TKThycIe5e0ytRweW2RZxclogCdQ==} resolution: {integrity: sha512-gUD/epcRms75Cw8RT1pUdHugZYM5ce64ucs2GEISABwkRsOQr0q2wm/MV2TKThycIe5e0ytRweW2RZxclogCdQ==}
engines: {node: '>=8'} engines: {node: '>=8'}
lodash.iteratee@4.7.0:
resolution: {integrity: sha512-yv3cSQZmfpbIKo4Yo45B1taEvxjNvcpF1CEOc0Y6dEyvhPIfEJE3twDwPgWTPQubcSgXyBwBKG6wpQvWMDOf6Q==}
longest-streak@3.1.0: longest-streak@3.1.0:
resolution: {integrity: sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==} resolution: {integrity: sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==}
loupe@3.1.3:
resolution: {integrity: sha512-kkIp7XSkP78ZxJEsSxW3712C6teJVoeHHwgo9zJ380de7IYyJ2ISlxojcH2pC5OFLewESmnRi/+XCDIEEVyoug==}
map-age-cleaner@0.1.3: map-age-cleaner@0.1.3:
resolution: {integrity: sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==} resolution: {integrity: sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==}
engines: {node: '>=6'} engines: {node: '>=6'}
@@ -959,6 +1008,9 @@ packages:
mdast-util-to-string@4.0.0: mdast-util-to-string@4.0.0:
resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==}
mdast-util-toc@7.1.0:
resolution: {integrity: sha512-2TVKotOQzqdY7THOdn2gGzS9d1Sdd66bvxUyw3aNpWfcPXCLYSJCCgfPy30sEtuzkDraJgqF35dzgmz6xlvH/w==}
mem@8.1.1: mem@8.1.1:
resolution: {integrity: sha512-qFCFUDs7U3b8mBDPyz5EToEKoAkgCzqquIgi9nkkR9bixxOVOre+09lbuH7+9Kn2NFpm56M3GUWVbU2hQgdACA==} resolution: {integrity: sha512-qFCFUDs7U3b8mBDPyz5EToEKoAkgCzqquIgi9nkkR9bixxOVOre+09lbuH7+9Kn2NFpm56M3GUWVbU2hQgdACA==}
engines: {node: '>=10'} engines: {node: '>=10'}
@@ -1173,6 +1225,10 @@ packages:
resolution: {integrity: sha512-cMMJTAZlion/RWRRC48UbrDymEIt+/YSD/l8NqjneyDw2rDOBQcP5yRkMB4CYGn47KMhZvbblBP7Z79OsMw72w==} resolution: {integrity: sha512-cMMJTAZlion/RWRRC48UbrDymEIt+/YSD/l8NqjneyDw2rDOBQcP5yRkMB4CYGn47KMhZvbblBP7Z79OsMw72w==}
engines: {node: '>=8.15'} engines: {node: '>=8.15'}
pathval@2.0.0:
resolution: {integrity: sha512-vE7JKRyES09KiunauX7nd2Q9/L7lhok4smP9RZTDeD4MVs72Dp2qNFVz39Nz5a0FVEW0BJR6C0DYrq6unoziZA==}
engines: {node: '>= 14.16'}
picocolors@1.1.1: picocolors@1.1.1:
resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==}
@@ -1227,6 +1283,10 @@ packages:
rehype-stringify@10.0.1: rehype-stringify@10.0.1:
resolution: {integrity: sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==} resolution: {integrity: sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==}
remark-behead@3.1.0:
resolution: {integrity: sha512-rKns7st91lgppaD5YaH58O4ECFVXTVnkyYQBuCw4ISRE2TFK/iVySMaKbvV2pVbUVIjAaDciugrTI/tyuPOlWQ==}
engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0}
remark-directive@4.0.0: remark-directive@4.0.0:
resolution: {integrity: sha512-7sxn4RfF1o3izevPV1DheyGDD6X4c9hrGpfdUpm7uC++dqrnJxIZVkk7CoKqcLm0VUMAuOol7Mno3m6g8cfMuA==} resolution: {integrity: sha512-7sxn4RfF1o3izevPV1DheyGDD6X4c9hrGpfdUpm7uC++dqrnJxIZVkk7CoKqcLm0VUMAuOol7Mno3m6g8cfMuA==}
@@ -1431,6 +1491,25 @@ packages:
resolution: {integrity: sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==} resolution: {integrity: sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==}
engines: {node: '>=8'} engines: {node: '>=8'}
unist-util-find-all-after@4.0.1:
resolution: {integrity: sha512-AO8++e6HJfwNoTrqkV7xSeW65e6uSsLRQST/9LWi8FmFSz1gS7TBd+DkL/CYiElsSZIQgT4J5U54v5/kJX5Nqg==}
unist-util-find-all-before@4.0.1:
resolution: {integrity: sha512-xg4UHtZ6VbcjQbfDtmLZch6kQYQFF3nfaW05Ie3+t2UectzeqSx/iqLmh/wWogwU+YDWnD40PjZKK7ORmCma+g==}
unist-util-find-all-between@2.1.0:
resolution: {integrity: sha512-OCCUtDD8UHKeODw3TPXyFDxPCbpgBzbGTTaDpR68nvxkwiVcawBqMVrokfBMvUi7ij2F5q7S4s4Jq5dvkcBt+w==}
engines: {node: '>=10'}
unist-util-find@1.0.4:
resolution: {integrity: sha512-T5vI7IkhroDj7KxAIy057VbIeGnCXfso4d4GoUsjbAmDLQUkzAeszlBtzx1+KHgdsYYBygaqUBvrbYCfePedZw==}
unist-util-is@4.1.0:
resolution: {integrity: sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg==}
unist-util-is@5.2.1:
resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==}
unist-util-is@6.0.0: unist-util-is@6.0.0:
resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==} resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==}
@@ -1440,9 +1519,21 @@ packages:
unist-util-stringify-position@4.0.0: unist-util-stringify-position@4.0.0:
resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==}
unist-util-visit-parents@3.1.1:
resolution: {integrity: sha512-1KROIZWo6bcMrZEwiH2UrXDyalAa0uqzWCxCJj6lPOvTve2WkfgCytoDTPaMnodXh1WrXOq0haVYHj99ynJlsg==}
unist-util-visit-parents@5.1.3:
resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==}
unist-util-visit-parents@6.0.1: unist-util-visit-parents@6.0.1:
resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==} resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==}
unist-util-visit@2.0.3:
resolution: {integrity: sha512-iJ4/RczbJMkD0712mGktuGpm/U4By4FfDonL7N/9tATGIF4imikjOuagyMY53tnZq3NP6BcmlrHhEKAfGWjh7Q==}
unist-util-visit@4.1.2:
resolution: {integrity: sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==}
unist-util-visit@5.0.0: unist-util-visit@5.0.0:
resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==} resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==}
@@ -1860,10 +1951,16 @@ snapshots:
'@types/cardinal@2.1.1': {} '@types/cardinal@2.1.1': {}
'@types/chai@5.2.2':
dependencies:
'@types/deep-eql': 4.0.2
'@types/debug@4.1.12': '@types/debug@4.1.12':
dependencies: dependencies:
'@types/ms': 2.1.0 '@types/ms': 2.1.0
'@types/deep-eql@4.0.2': {}
'@types/hast@3.0.4': '@types/hast@3.0.4':
dependencies: dependencies:
'@types/unist': 3.0.3 '@types/unist': 3.0.3
@@ -1895,6 +1992,8 @@ snapshots:
dependencies: dependencies:
'@types/nextgen-events': 1.1.4 '@types/nextgen-events': 1.1.4
'@types/ungap__structured-clone@1.2.0': {}
'@types/unist@2.0.11': {} '@types/unist@2.0.11': {}
'@types/unist@3.0.3': {} '@types/unist@3.0.3': {}
@@ -1942,6 +2041,8 @@ snapshots:
dependencies: dependencies:
printable-characters: 1.0.42 printable-characters: 1.0.42
assertion-error@2.0.1: {}
bail@2.0.2: {} bail@2.0.2: {}
better-path-resolve@1.0.0: better-path-resolve@1.0.0:
@@ -1986,6 +2087,14 @@ snapshots:
ccount@2.0.1: {} ccount@2.0.1: {}
chai@5.2.0:
dependencies:
assertion-error: 2.0.1
check-error: 2.1.1
deep-eql: 5.0.2
loupe: 3.1.3
pathval: 2.0.0
chalk@4.1.2: chalk@4.1.2:
dependencies: dependencies:
ansi-styles: 4.3.0 ansi-styles: 4.3.0
@@ -2003,6 +2112,8 @@ snapshots:
character-reference-invalid@2.0.1: {} character-reference-invalid@2.0.1: {}
check-error@2.1.1: {}
chroma-js@2.6.0: {} chroma-js@2.6.0: {}
cli-boxes@2.2.1: {} cli-boxes@2.2.1: {}
@@ -2072,6 +2183,8 @@ snapshots:
dependencies: dependencies:
character-entities: 2.0.2 character-entities: 2.0.2
deep-eql@5.0.2: {}
defaults@1.0.4: defaults@1.0.4:
dependencies: dependencies:
clone: 1.0.4 clone: 1.0.4
@@ -2182,6 +2295,8 @@ snapshots:
dependencies: dependencies:
resolve-pkg-maps: 1.0.0 resolve-pkg-maps: 1.0.0
github-slugger@2.0.0: {}
glob-parent@5.1.2: glob-parent@5.1.2:
dependencies: dependencies:
is-glob: 4.0.3 is-glob: 4.0.3
@@ -2313,8 +2428,12 @@ snapshots:
strip-bom: 4.0.0 strip-bom: 4.0.0
type-fest: 0.6.0 type-fest: 0.6.0
lodash.iteratee@4.7.0: {}
longest-streak@3.1.0: {} longest-streak@3.1.0: {}
loupe@3.1.3: {}
map-age-cleaner@0.1.3: map-age-cleaner@0.1.3:
dependencies: dependencies:
p-defer: 1.0.0 p-defer: 1.0.0
@@ -2466,6 +2585,16 @@ snapshots:
dependencies: dependencies:
'@types/mdast': 4.0.4 '@types/mdast': 4.0.4
mdast-util-toc@7.1.0:
dependencies:
'@types/mdast': 4.0.4
'@types/ungap__structured-clone': 1.2.0
'@ungap/structured-clone': 1.3.0
github-slugger: 2.0.0
mdast-util-to-string: 4.0.0
unist-util-is: 6.0.0
unist-util-visit: 5.0.0
mem@8.1.1: mem@8.1.1:
dependencies: dependencies:
map-age-cleaner: 0.1.3 map-age-cleaner: 0.1.3
@@ -2787,6 +2916,8 @@ snapshots:
dependencies: dependencies:
unique-string: 2.0.0 unique-string: 2.0.0
pathval@2.0.0: {}
picocolors@1.1.1: {} picocolors@1.1.1: {}
picomatch@2.3.1: {} picomatch@2.3.1: {}
@@ -2833,6 +2964,14 @@ snapshots:
hast-util-to-html: 9.0.5 hast-util-to-html: 9.0.5
unified: 11.0.5 unified: 11.0.5
remark-behead@3.1.0:
dependencies:
unist-util-find: 1.0.4
unist-util-find-all-after: 4.0.1
unist-util-find-all-before: 4.0.1
unist-util-find-all-between: 2.1.0
unist-util-visit: 4.1.2
remark-directive@4.0.0: remark-directive@4.0.0:
dependencies: dependencies:
'@types/mdast': 4.0.4 '@types/mdast': 4.0.4
@@ -3051,6 +3190,32 @@ snapshots:
dependencies: dependencies:
crypto-random-string: 2.0.0 crypto-random-string: 2.0.0
unist-util-find-all-after@4.0.1:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 5.2.1
unist-util-find-all-before@4.0.1:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 5.2.1
unist-util-find-all-between@2.1.0:
dependencies:
unist-util-find: 1.0.4
unist-util-is: 4.1.0
unist-util-find@1.0.4:
dependencies:
lodash.iteratee: 4.7.0
unist-util-visit: 2.0.3
unist-util-is@4.1.0: {}
unist-util-is@5.2.1:
dependencies:
'@types/unist': 2.0.11
unist-util-is@6.0.0: unist-util-is@6.0.0:
dependencies: dependencies:
'@types/unist': 3.0.3 '@types/unist': 3.0.3
@@ -3063,11 +3228,33 @@ snapshots:
dependencies: dependencies:
'@types/unist': 3.0.3 '@types/unist': 3.0.3
unist-util-visit-parents@3.1.1:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 4.1.0
unist-util-visit-parents@5.1.3:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 5.2.1
unist-util-visit-parents@6.0.1: unist-util-visit-parents@6.0.1:
dependencies: dependencies:
'@types/unist': 3.0.3 '@types/unist': 3.0.3
unist-util-is: 6.0.0 unist-util-is: 6.0.0
unist-util-visit@2.0.3:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 4.1.0
unist-util-visit-parents: 3.1.1
unist-util-visit@4.1.2:
dependencies:
'@types/unist': 2.0.11
unist-util-is: 5.2.1
unist-util-visit-parents: 5.1.3
unist-util-visit@5.0.0: unist-util-visit@5.0.0:
dependencies: dependencies:
'@types/unist': 3.0.3 '@types/unist': 3.0.3

View File

@@ -1,14 +1,15 @@
import { program } from 'commander'; import { program } from 'commander';
import { resolve } from 'node:path'; import { resolve } from 'node:path';
import { marked } from 'marked'; import { Marked } from 'marked';
import { markedTerminal } from 'marked-terminal'; import { markedTerminal } from 'marked-terminal';
import { execute } from '../execution/execution.js'; import { execute } from '../execution/execution.js';
import { Context } from '../context/context.js'; import { Context } from '../context/context.js';
import { writeFile } from 'node:fs/promises'; import { writeFile } from 'node:fs/promises';
import { Watcher } from '../watcher/watcher.js'; import { Watcher } from '../watcher/watcher.js';
import { UI } from './ui/ui.js';
import { wrapBody } from '../theme/theme.html.js';
marked.use(markedTerminal() as any);
program program
.command('dev') .command('dev')
@@ -17,11 +18,15 @@ program
.option('-w, --watch', 'watch for changes') .option('-w, --watch', 'watch for changes')
.option('-i, --input <input...>', 'input variables (-i foo=bar -i baz=qux)') .option('-i, --input <input...>', 'input variables (-i foo=bar -i baz=qux)')
.action(async (name, options) => { .action(async (name, options) => {
const marked = new Marked();
marked.use(markedTerminal() as any);
const { const {
watch = false, watch = false,
input: i = [], input: i = [],
} = options; } = options;
const ui = new UI();
const input = Object.fromEntries( const input = Object.fromEntries(
i.map((item: string) => { i.map((item: string) => {
const [key, value] = item.split('='); const [key, value] = item.split('=');
@@ -39,7 +44,7 @@ program
}); });
const markdown = await marked.parse(result.markdown); const markdown = await marked.parse(result.markdown);
console.log(markdown); ui.content = markdown;
return { return {
...result, ...result,
@@ -49,6 +54,10 @@ program
const result = await build(); const result = await build();
ui.screen.key(['r'], () => {
build();
});
if (watch) { if (watch) {
const watcher = new Watcher(); const watcher = new Watcher();
watcher.watchFiles(Array.from(result.context.files)); watcher.watchFiles(Array.from(result.context.files));
@@ -66,12 +75,14 @@ program
.argument('<name>', 'http.md file name') .argument('<name>', 'http.md file name')
.argument('<output>', 'output file name') .argument('<output>', 'output file name')
.description('Run a http.md document') .description('Run a http.md document')
.option('-f, --format <format>', 'output format (html, markdown)')
.option('-w, --watch', 'watch for changes') .option('-w, --watch', 'watch for changes')
.option('-i, --input <input...>', 'input variables (-i foo=bar -i baz=qux)') .option('-i, --input <input...>', 'input variables (-i foo=bar -i baz=qux)')
.action(async (name, output, options) => { .action(async (name, output, options) => {
const { const {
watch = false, watch = false,
input: i = [], input: i = [],
format = 'markdown',
} = options; } = options;
@@ -91,7 +102,15 @@ program
context, context,
}); });
await writeFile(output, result.markdown); if (format === 'html') {
const marked = new Marked();
const html = await marked.parse(result.markdown);
await writeFile(output, wrapBody(html));
} else if (format === 'markdown') {
await writeFile(output, result.markdown);
} else {
throw new Error('Invalid format');
}
return { return {
...result, ...result,
context, context,

70
src/cli/ui/ui.ts Normal file
View File

@@ -0,0 +1,70 @@
import blessed from 'blessed';
import chalk from 'chalk';
class UI {
#box: blessed.Widgets.BoxElement;
#screen: blessed.Widgets.Screen;
constructor() {
const screen = blessed.screen({
smartCSR: true,
title: 'Markdown Viewer'
});
const scrollableBox = blessed.box({ // Or blessed.scrollablebox
parent: screen,
top: 0,
left: 0,
width: '100%',
height: '100%',
content: '',
scrollable: true,
alwaysScroll: true,
keys: true,
vi: true, // vi-like keybindings
mouse: true,
scrollbar: {
ch: ' ',
track: {
bg: 'cyan'
},
style: {
inverse: true
}
},
style: {
fg: 'white',
bg: 'black'
}
});
this.#box = scrollableBox;
this.#screen = screen;
screen.key(['escape', 'q', 'C-c'], () => {
return process.exit(0);
});
scrollableBox.focus();
screen.render();
}
public get screen() {
return this.#screen;
}
public set content(content: string) {
const originalLines = content.split('\n');
const maxLineNoDigits = String(originalLines.length).length; // For padding
const linesWithNumbers = originalLines.map((line, index) => {
const lineNumber = String(index + 1).padStart(maxLineNoDigits, ' ');
const styledLineNumber = chalk.dim.yellow(`${lineNumber} | `);
return `${styledLineNumber}${line}`;
});
const contentWithLineNumbers = linesWithNumbers.join('\n');
this.#box.setContent(contentWithLineNumbers);
this.#screen.render();
}
}
export { UI };

View File

@@ -10,6 +10,7 @@ type Response = {
statusText: string; statusText: string;
headers: Record<string, string>; headers: Record<string, string>;
body?: string; body?: string;
rawBody?: string;
}; };
type AddRequestOptios = { type AddRequestOptios = {

View File

@@ -5,18 +5,12 @@ import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype' import remarkRehype from 'remark-rehype'
import remarkDirective from 'remark-directive' import remarkDirective from 'remark-directive'
import remarkStringify from 'remark-stringify' import remarkStringify from 'remark-stringify'
import behead from 'remark-behead';
import { unified } from 'unified' import { unified } from 'unified'
import { visit } from 'unist-util-visit' import { visit } from 'unist-util-visit'
import { Context } from "../context/context.js"; import { Context } from "../context/context.js";
import { handlers } from './handlers/handlers.js'; import { handlers, postHandlers } from './handlers/handlers.js';
const parser = unified()
.use(remarkParse)
.use(remarkGfm)
.use(remarkDirective)
.use(remarkStringify)
.use(remarkRehype);
type BaseNode = { type BaseNode = {
type: string; type: string;
@@ -53,6 +47,7 @@ type ExecutionHandler = (options: {
type ExexutionExecuteOptions = { type ExexutionExecuteOptions = {
context: Context; context: Context;
behead?: number;
} }
const execute = async (file: string, options: ExexutionExecuteOptions) => { const execute = async (file: string, options: ExexutionExecuteOptions) => {
@@ -61,6 +56,16 @@ const execute = async (file: string, options: ExexutionExecuteOptions) => {
const content = await readFile(file, 'utf-8'); const content = await readFile(file, 'utf-8');
const steps: Set<ExecutionStep> = new Set(); const steps: Set<ExecutionStep> = new Set();
const parser = unified()
.use(remarkParse)
.use(remarkGfm)
.use(remarkDirective)
.use(remarkStringify)
.use(remarkRehype)
.use(behead, {
depth: options.behead,
});
const root = parser.parse(content); const root = parser.parse(content);
visit(root, (node, index, parent) => { visit(root, (node, index, parent) => {
@@ -75,6 +80,18 @@ const execute = async (file: string, options: ExexutionExecuteOptions) => {
}); });
} }
}); });
visit(root, (node, index, parent) => {
for (const handler of postHandlers) {
handler({
addStep: (step) => steps.add(step),
node: node as BaseNode,
root,
parent: parent as BaseNode | undefined,
index,
file,
});
}
});
for (const step of steps) { for (const step of steps) {
const { node, action } = step; const { node, action } = step;

View File

@@ -5,7 +5,7 @@ const codeHandler: ExecutionHandler = ({
node, node,
addStep, addStep,
}) => { }) => {
if (node.type !== 'code' || node.lang === 'http') { if (node.type !== 'code' || node.lang === 'http' || node.lang === 'javascript') {
return; return;
} }
const optionParts = node.meta?.split(',') || []; const optionParts = node.meta?.split(',') || [];

View File

@@ -33,7 +33,8 @@ const httpHandler: ExecutionHandler = ({
const content = template(context); const content = template(context);
const [head, body] = content.split('\n\n'); const [head, body] = content.split('\n\n');
const [top, ...headerItems] = head.split('\n'); const [top, ...headerItems] = head.split('\n');
const [method, url] = top.split(' '); const [method, ...urlParts] = top.split(' ');
const url = urlParts.join(' ').trim();
const headers = Object.fromEntries( const headers = Object.fromEntries(
headerItems.map((header) => { headerItems.map((header) => {
@@ -43,7 +44,7 @@ const httpHandler: ExecutionHandler = ({
); );
let parsedBody = body; let parsedBody = body;
if (options.format === 'yaml') { if (options.yaml) {
try { try {
const parsed = YAML.parse(body); const parsed = YAML.parse(body);
parsedBody = JSON.stringify(parsed); parsedBody = JSON.stringify(parsed);
@@ -58,7 +59,8 @@ const httpHandler: ExecutionHandler = ({
body body
}); });
let responseText = await response.text(); const rawBody = await response.text();
let responseText = rawBody;
if (options.json) { if (options.json) {
try { try {
responseText = JSON.parse(responseText); responseText = JSON.parse(responseText);
@@ -67,7 +69,7 @@ const httpHandler: ExecutionHandler = ({
} }
} }
node.value = content; node.value = [head, parsedBody].filter(Boolean).join('\n\n');
node.meta = undefined; node.meta = undefined;
context.addRequest({ context.addRequest({
@@ -83,6 +85,7 @@ const httpHandler: ExecutionHandler = ({
statusText: response.statusText, statusText: response.statusText,
headers: Object.fromEntries(response.headers.entries()), headers: Object.fromEntries(response.headers.entries()),
body: responseText, body: responseText,
rawBody: rawBody,
}, },
}); });
}, },

View File

@@ -0,0 +1,73 @@
import Handlebars from "handlebars";
import YAML from "yaml";
import { should, expect, assert } from 'chai';
import { ExecutionHandler } from "../execution.js";
const javascriptHandler: ExecutionHandler = ({
node,
parent,
index,
addStep,
}) => {
if (node.type !== 'code' || node.lang !== 'javascript') {
return;
}
const optionParts = node.meta?.split(',') || [];
node.meta = undefined;
const options = Object.fromEntries(
optionParts.filter(Boolean).map((option) => {
const [key, value] = option.split('=');
return [key.trim(), value?.trim() || true];
})
);
addStep({
type: 'code',
node,
action: async ({ context }) => {
const template = Handlebars.compile(node.value);
const content = template(context);
node.value = content;
if (options['run'] === true) {
const api = {
assert,
should,
expect,
...context,
}
try {
// eslint-disable-next-line no-new-func
const asyncFunc = new Function(
...Object.keys(api),
`return (async () => { ${content} })()`
);
const result = await asyncFunc(...Object.values(api));
if (options.output === true && index !== undefined) {
if (result !== undefined) {
parent?.children?.splice(index + 1, 0, {
type: 'code',
lang: 'yaml',
value: YAML.stringify(result, null, 2),
meta: undefined,
});
}
}
} catch (error) {
if (index !== undefined) {
parent?.children?.splice(index + 1, 0, {
type: 'code',
value: `Error: ${error instanceof Error ? error.message : String(error)}`,
meta: undefined,
});
}
throw error;
}
}
if (options.hidden === true && parent && index !== undefined) {
parent.children?.splice(index, 1);
}
},
});
};
export { javascriptHandler };

View File

@@ -23,6 +23,7 @@ const fileHandler: ExecutionHandler = ({
} }
const { root: newRoot } = await execute(filePath, { const { root: newRoot } = await execute(filePath, {
context, context,
behead: node.attributes?.behead ? parseInt(node.attributes.behead) : undefined,
}); });
if (!parent) { if (!parent) {
throw new Error('Parent node is required'); throw new Error('Parent node is required');

View File

@@ -53,6 +53,7 @@ const responseHandler: ExecutionHandler = ({
const codeNode = { const codeNode = {
type: 'code', type: 'code',
lang: 'http',
value: responseContent, value: responseContent,
}; };
if (!parent || !('children' in parent) || index === undefined) { if (!parent || !('children' in parent) || index === undefined) {

View File

@@ -0,0 +1,29 @@
import { toc } from 'mdast-util-toc';
import { type ExecutionHandler } from '../execution.js';
const tocHandler: ExecutionHandler = ({
addStep,
node,
root,
parent,
index,
}) => {
if (node.type === 'leafDirective' && node.name === 'toc') {
addStep({
type: 'toc',
node,
action: async () => {
const result = toc(root, {
tight: true,
minDepth: 2,
})
if (!parent || !parent.children || index === undefined) {
throw new Error('Parent node is not valid');
}
parent.children.splice(index, 1, result.map as any);
},
})
}
}
export { tocHandler };

View File

@@ -6,6 +6,8 @@ import { rawMdHandler } from "./handlers.raw-md.js";
import { responseHandler } from "./handlers.response.js"; import { responseHandler } from "./handlers.response.js";
import { textHandler } from "./handlers.text.js"; import { textHandler } from "./handlers.text.js";
import { codeHandler } from "./handlers.code.js"; import { codeHandler } from "./handlers.code.js";
import { tocHandler } from "./handlers.toc.js";
import { javascriptHandler } from "./handlers.javascript.js";
const handlers = [ const handlers = [
fileHandler, fileHandler,
@@ -15,6 +17,11 @@ const handlers = [
inputHandler, inputHandler,
rawMdHandler, rawMdHandler,
codeHandler, codeHandler,
javascriptHandler,
] satisfies ExecutionHandler[]; ] satisfies ExecutionHandler[];
export { handlers }; const postHandlers = [
tocHandler,
] satisfies ExecutionHandler[];
export { handlers, postHandlers };

29
src/theme/theme.html.ts Normal file
View File

@@ -0,0 +1,29 @@
const wrapBody = (body: string) => {
return `<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.8.1/github-markdown.min.css" />
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
}
.markdown-body {
max-width: 800px;
padding: 20px;
margin: auto;
}
</style>
</head>
<body>
<article class="markdown-body">
${body}
</article>
</body>
</html>`;
};
export { wrapBody };