Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

fix(docs): escape pipes in generated text

jkomynoc0880764cf6b
diff --git a/ts/packages/core/scripts/generate-docs.ts b/ts/packages/core/scripts/generate-docs.ts
index a989db362..19a5f183b 100644
--- a/ts/packages/core/scripts/generate-docs.ts
+++ b/ts/packages/core/scripts/generate-docs.ts
@@ -1007,6 +1007,7 @@ function toKebabCase(str: string): string {
export function escapeTextForMdx(str: string): string {
return str
.replace(/\\/g, '\\\\')
+ .replace(/\|/g, '\\|')
.replace(/\{/g, '\\{')
.replace(/\}/g, '\\}')
.replace(/</g, '&lt;')
diff --git a/ts/packages/core/test/scripts/generate-docs.test.ts b/ts/packages/core/test/scripts/generate-docs.test.ts
index 779150b4f..1d6d8ef68 100644
--- a/ts/packages/core/test/scripts/generate-docs.test.ts
+++ b/ts/packages/core/test/scripts/generate-docs.test.ts
@@ -38,9 +38,9 @@ describe('generate-docs type rendering', () => {
expect(escapeTypeForMdx(String.raw`{ pattern: '\|' }`)).toBe(String.raw`\{ pattern: '\\\|' \}`);
});
- it('escapes existing backslashes before MDX text metacharacters', () => {
- expect(escapeTextForMdx(String.raw`Use \{value\} or <literal>`)).toBe(
- String.raw`Use \\\{value\\\} or &lt;literal&gt;`
+ it('escapes existing backslashes before MDX text and table metacharacters', () => {
+ expect(escapeTextForMdx(String.raw`Use \{value\}, \|, or <literal>`)).toBe(
+ String.raw`Use \\\{value\\\}, \\\|, or &lt;literal&gt;`
);
});