build: use non-esm version of execa

PaulRBerg · PaulRBerg · commit 67b58e51af61 · 2025-06-19T16:20:22.000+03:00
refactor: run prettier after autogen graphql
refactor: update autogen graphql docs
diff --git a/bun.lock b/bun.lock
diff --git a/cli/commands/autogen/graphql.ts b/cli/commands/autogen/graphql.ts
@@ -2,7 +2,7 @@ import fs from "node:fs";
 import { join } from "node:path";
 import { getSablierIndexerEnvio, type Indexer } from "@sablier/indexers";
 import { Command } from "commander";
-import { $ } from "execa";
+import $ from "execa";
 import * as yaml from "js-yaml";
 import _ from "lodash";
 import type { CliOptions } from "../../types";
@@ -66,6 +66,7 @@ export async function generateGraphQL(options: GraphQLOptions): Promise<void> {
   }
 
   cleanupDocs(basePaths);
+  await runPrettier(basePaths);
 }
 
 /* -------------------------------------------------------------------------- */
@@ -114,27 +115,32 @@ function cleanupDocs(basePaths: string[]): void {
 }
 
 async function generateEnvio(protocol: Indexer.Protocol): Promise<string> {
-  const base = `./docs/api/${protocol}/graphql/envio`;
+  const basePath = `./docs/api/${protocol}/graphql/envio`;
   const schemaURL = getSablierIndexerEnvio({ chainId: CHAIN_ID_SEPOLIA, protocol }).endpoint.url;
 
-  await runCommand(base, schemaURL);
+  await runGenerator(basePath, schemaURL);
   console.log(`✔️ Generated GraphQL docs for Envio vendor and ${_.capitalize(protocol)} protocol\n`);
-  return base;
+  return basePath;
 }
 
 async function generateGraph(protocol: Indexer.Protocol): Promise<string> {
-  const base = `./docs/api/${protocol}/graphql/the-graph`;
+  const basePath = `./docs/api/${protocol}/graphql/the-graph`;
   const schemaURL = `https://api.studio.thegraph.com/query/112500/sablier-${protocol}-experimental/version/latest`;
 
-  await runCommand(base, schemaURL);
+  await runGenerator(basePath, schemaURL);
   console.log(`✔️ Generated GraphQL docs for The Graph vendor and ${_.capitalize(protocol)} protocol\n`);
-  return base;
+  return basePath;
 }
 
 /**
  * @see https://graphql-markdown.dev/docs/settings#baseurl
  * @see {@link file://./../../../config/plugins.ts}
  */
-async function runCommand(base: string, schema: string): Promise<void> {
-  await $({ stdio: "inherit" })`bun docusaurus graphql-to-doc --base ${base} --schema ${schema}`;
+async function runGenerator(base: string, schema: string): Promise<void> {
+  await $("bun", ["docusaurus", "graphql-to-doc", "--base", base, "--schema", schema], { stdio: "inherit" });
+}
+
+async function runPrettier(targetPaths: string[]): Promise<void> {
+  const patterns = targetPaths.map((path) => `${path}/**/*.{md,mdx,yml,yaml}`);
+  await $("bun", ["prettier", "--write", ...patterns]);
 }
diff --git a/docs/api/flow/graphql/the-graph/objects/action.mdx b/docs/api/flow/graphql/the-graph/objects/action.mdx
@@ -87,7 +87,7 @@ type Action {
 
 #### [<code style={{ fontWeight: 'normal' }}>Action.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/flow/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;txHash&#x007D;-&#x007B;blockLogIndex&#x007D;
+Unique identifier: `{txHash}-{blockLogIndex}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Action.<b>subgraphId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/flow/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/flow/graphql/the-graph/objects/batch.mdx b/docs/api/flow/graphql/the-graph/objects/batch.mdx
@@ -62,7 +62,7 @@ export const Details = ({ dataOpen, dataClose, children, startOpen = false }) =>
 };
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
@@ -88,7 +88,7 @@ type Batch {
 
 #### [<code style={{ fontWeight: 'normal' }}>Batch.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/flow/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;chainId&#x007D;-&#x007B;txHash&#x007D;-&#x007B;batcher&#x007D;
+Unique identifier: `{chainId}-{txHash}-{batcher}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Batch.<b>hash</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Bytes</b></code>](/docs/api/flow/graphql/the-graph/scalars/bytes.mdx) <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/flow/graphql/the-graph/objects/batcher.mdx b/docs/api/flow/graphql/the-graph/objects/batcher.mdx
@@ -81,7 +81,7 @@ type Batcher {
 
 #### [<code style={{ fontWeight: 'normal' }}>Batcher.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/flow/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;chainId&#x007D;-&#x007B;sender&#x007D;
+Unique identifier: `{chainId}-{sender}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Batcher.<b>batchCounter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/flow/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/flow/graphql/the-graph/objects/stream.mdx b/docs/api/flow/graphql/the-graph/objects/stream.mdx
@@ -114,11 +114,11 @@ type Stream {
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/flow/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;contractAddress&#x007D;-&#x007B;chainId&#x007D;-&#x007B;tokenId&#x007D;
+Unique identifier: `{contractAddress}-{chainId}-{tokenId}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>alias</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/flow/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Like the id: &#x007B;contractAlias&#x007D;-&#x007B;chainId&#x007D;-&#x007B;tokenId&#x007D;
+Like the id: `{contractAlias}-{chainId}-{tokenId}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>chainId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/flow/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/flow/graphql/the-graph/queries/batch.mdx b/docs/api/flow/graphql/the-graph/queries/batch.mdx
@@ -88,7 +88,7 @@ Set to `allow` to receive data even if the subgraph has skipped over errors whil
 #### [<code style={{ fontWeight: 'normal' }}><b>Batch</b></code>](/docs/api/flow/graphql/the-graph/objects/batch.mdx) <Badge class="badge badge--secondary " text="object"/>
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
diff --git a/docs/api/flow/graphql/the-graph/queries/batches.mdx b/docs/api/flow/graphql/the-graph/queries/batches.mdx
@@ -100,7 +100,7 @@ Set to `allow` to receive data even if the subgraph has skipped over errors whil
 #### [<code style={{ fontWeight: 'normal' }}><b>Batch</b></code>](/docs/api/flow/graphql/the-graph/objects/batch.mdx) <Badge class="badge badge--secondary " text="object"/>
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
diff --git a/docs/api/lockup/graphql/the-graph/objects/action.mdx b/docs/api/lockup/graphql/the-graph/objects/action.mdx
@@ -87,7 +87,7 @@ type Action {
 
 #### [<code style={{ fontWeight: 'normal' }}>Action.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;txHash&#x007D;-&#x007B;blockLogIndex&#x007D;
+Unique identifier: `{txHash}-{blockLogIndex}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Action.<b>subgraphId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/objects/batch.mdx b/docs/api/lockup/graphql/the-graph/objects/batch.mdx
@@ -62,7 +62,7 @@ export const Details = ({ dataOpen, dataClose, children, startOpen = false }) =>
 };
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
@@ -88,7 +88,7 @@ type Batch {
 
 #### [<code style={{ fontWeight: 'normal' }}>Batch.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;chainId&#x007D;-&#x007B;txHash&#x007D;-&#x007B;batcher&#x007D;
+Unique identifier: `{chainId}-{txHash}-{batcher}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Batch.<b>hash</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Bytes</b></code>](/docs/api/lockup/graphql/the-graph/scalars/bytes.mdx) <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/objects/batcher.mdx b/docs/api/lockup/graphql/the-graph/objects/batcher.mdx
@@ -81,7 +81,7 @@ type Batcher {
 
 #### [<code style={{ fontWeight: 'normal' }}>Batcher.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;chainId&#x007D;-&#x007B;sender&#x007D;
+Unique identifier: `{chainId}-{sender}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Batcher.<b>batchCounter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/objects/segment.mdx b/docs/api/lockup/graphql/the-graph/objects/segment.mdx
@@ -82,7 +82,7 @@ type Segment {
 
 #### [<code style={{ fontWeight: 'normal' }}>Segment.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;streamId&#x007D;-&#x007B;position&#x007D;
+Unique identifier: `{streamId}-{position}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Segment.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
@@ -99,7 +99,7 @@ Alias for the `milestone` field.
 #### [<code style={{ fontWeight: 'normal' }}>Segment.<b>exponent</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
 Exponent used for the streamed amount calculations.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/types/DataTypes.sol#L279-L288
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/types/DataTypes.sol#L279-L288
 
 #### [<code style={{ fontWeight: 'normal' }}>Segment.<b>milestone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/objects/stream.mdx b/docs/api/lockup/graphql/the-graph/objects/stream.mdx
@@ -132,11 +132,11 @@ type Stream {
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;contractAddress&#x007D;-&#x007B;chainId&#x007D;-&#x007B;tokenId&#x007D;
+Unique identifier: `{contractAddress}-{chainId}-{tokenId}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>alias</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Like the id: &#x007B;contractAlias&#x007D;-&#x007B;chainId&#x007D;-&#x007B;tokenId&#x007D;
+Like the id: `{contractAlias}-{chainId}-{tokenId}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Stream.<b>chainId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/objects/tranche.mdx b/docs/api/lockup/graphql/the-graph/objects/tranche.mdx
@@ -81,7 +81,7 @@ type Tranche {
 
 #### [<code style={{ fontWeight: 'normal' }}>Tranche.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
-Unique identifier: &#x007B;streamId&#x007D;-&#x007B;position&#x007D;
+Unique identifier: `{streamId}-{position}`
 
 #### [<code style={{ fontWeight: 'normal' }}>Tranche.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BigInt!</b></code>](/docs/api/lockup/graphql/the-graph/scalars/big-int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>
 
diff --git a/docs/api/lockup/graphql/the-graph/queries/batch.mdx b/docs/api/lockup/graphql/the-graph/queries/batch.mdx
@@ -88,7 +88,7 @@ Set to `allow` to receive data even if the subgraph has skipped over errors whil
 #### [<code style={{ fontWeight: 'normal' }}><b>Batch</b></code>](/docs/api/lockup/graphql/the-graph/objects/batch.mdx) <Badge class="badge badge--secondary " text="object"/>
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
diff --git a/docs/api/lockup/graphql/the-graph/queries/batches.mdx b/docs/api/lockup/graphql/the-graph/queries/batches.mdx
@@ -100,7 +100,7 @@ Set to `allow` to receive data even if the subgraph has skipped over errors whil
 #### [<code style={{ fontWeight: 'normal' }}><b>Batch</b></code>](/docs/api/lockup/graphql/the-graph/objects/batch.mdx) <Badge class="badge badge--secondary " text="object"/>
 
 Creating streams in bulk is possible using the SablierBatchLockup contract.
-See https://github.com/sablier-labs/lockup/blob/v2.0.1/src/SablierBatchLockup.sol
+See https://github.com/sablier-labs/lockup/blob/v2.0/src/SablierBatchLockup.sol
 
 The entity can be immutable because a batch is only updated in the same block.
 See https://thegraph.com/docs/en/subgraphs/developing/creating/ql-schema/#defining-entities
diff --git a/package.json b/package.json
@@ -62,7 +62,7 @@
     "commander": "^14.0",
     "eslint": "^9.29",
     "eslint-plugin-mdx": "^3.5",
-    "execa": "^9.6.0",
+    "execa": "5.1.1",
     "husky": "^9.1",
     "js-yaml": "^4.1.0",
     "lint-staged": "^16.1",
