Skip to content

Add KB article: TypeScript build fails for CommonJS with verbatimModuleSyntax - #3158

Merged
anastasiaguspan merged 6 commits into
mainfrom
docs/weave-ts-commonjs-verbatim-kb
Sep 1, 2026
Merged

Add KB article: TypeScript build fails for CommonJS with verbatimModuleSyntax#3158
anastasiaguspan merged 6 commits into
mainfrom
docs/weave-ts-commonjs-verbatim-kb

Conversation

@anastasiaguspan

Copy link
Copy Markdown
Contributor

Summary

  • New Weave support KB article for customers who hit a TypeScript build error (TS1295/TS1287) when following the CommonJS setup in the TypeScript SDK integration guide with verbatimModuleSyntax: true in their tsconfig.json.
  • Fix confirmed by local reproduction against weave@0.16.3 / typescript@6.0.3: setting verbatimModuleSyntax: false (alongside module: CommonJS) resolves it.
  • Grounded in DOCS-2554; no tag/keywords assigned in frontmatter, per current KB tagging process (backend-generated).

Test plan

  • Confirm the article renders correctly in the docs preview
  • Confirm the link to /weave/guides/integrations/js resolves

…leSyntax

Customers following the CommonJS setup in the TS SDK integration guide
hit TS1295/TS1287 if their tsconfig sets verbatimModuleSyntax: true.
Reproduced against weave 0.16.3 / TypeScript 6.0.3; fix is to set it
back to false. Ref DOCS-2554.
@anastasiaguspan
anastasiaguspan requested a review from a team as a code owner August 31, 2026 16:57
@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Aug 31, 2026, 5:01 PM

Page Change
Typescript Build Fails After Commonjs Setup Added · +32 −0
Typescript Added · +10 −0
Support Changed · +1 −1
Weave Changed · +3 −0

Updated 2026-09-01 20:56:43 UTC for deployment · 2c99dd9.

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Knowledgebase navigation update

  • Keywords not on the allowed list: 2 distinct keywords.

Generator warnings

  • Unknown keyword Python API used in support/models/articles/how-do-i-delete-many-artifacts-at-once.mdx. Add it to docengine-site/knowledgebase.yaml to suppress this warning.
  • Unknown keyword TypeScript used in support/weave/articles/typescript-build-fails-after-commonjs-setup.mdx. Add it to docengine-site/knowledgebase.yaml to suppress this warning.

From workflow run 33558116558

@w-b-hivemind

w-b-hivemind Bot commented Aug 31, 2026

Copy link
Copy Markdown

HiveMind Sessions

2 sessions · 25m · $2.39

Session Agent Duration Tokens Cost Lines
Fix Optional Fields Style on Page cursor 1m 357.1K $0.00 +10 -10
TypeScript CommonJS Build Issue FAQ Article
e8795ab1-8b3e-49f3-a72d-a36ebf1ad0fd
claude 23m 37.2K $2.39 +85 -3
Total 25m 394.3K $2.39 +95 -13

View all sessions in HiveMind →

Run claude --resume e8795ab1-8b3e-49f3-a72d-a36ebf1ad0fd to pickup where you left off.

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 1 changed page: +0.0 (unchanged).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
support.mdx 7.9 7.9 +0.0 +0.0 unchanged
support/weave.mdx too little prose to score
support/weave/articles/typescript-build-fails-after-commonjs-setup.mdx 11.1 n/a
support/weave/tags/typescript.mdx too little prose to score

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
support.mdx 2 2 +0
support/weave/articles/typescript-build-fails-after-commonjs-setup.mdx 3

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 33558116698

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-docs-weave-ts-commonjs-verbatim-kb.mintlify.site

anastasiaguspan and others added 2 commits August 31, 2026 13:26
Adds keywords: ["TypeScript"] so the nav generator creates a category
for it; no existing tag (System Info, weave.op, etc.) fit a build/tsconfig issue.

The setting defaults to `false`, which the TypeScript SDK integration guide assumes.

Set it back to `false` alongside your CommonJS `module` setting:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Set it back to `false` alongside your CommonJS `module` setting:
Set the `verbatimModuleSyntax` field to `false`, and ensure that the project's `module` setting to `CommonJS`:

Comment thread support/weave/articles/typescript-build-fails-after-commonjs-setup.mdx Outdated
@anastasiaguspan
anastasiaguspan merged commit a1eee60 into main Sep 1, 2026
12 checks passed
@anastasiaguspan
anastasiaguspan deleted the docs/weave-ts-commonjs-verbatim-kb branch September 1, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants