Skip to content

Clean up typescript-app example and document TypeScript action support#15

Merged
pru55e11 merged 1 commit intomasterfrom
fix/typescript-app-docs-and-cleanup
Mar 26, 2026
Merged

Clean up typescript-app example and document TypeScript action support#15
pru55e11 merged 1 commit intomasterfrom
fix/typescript-app-docs-and-cleanup

Conversation

@pru55e11
Copy link
Copy Markdown
Contributor

@pru55e11 pru55e11 commented Mar 26, 2026

Summary

The typescript-app quickstart already uses the ts-loader Webpack approach for TypeScript runtime actions, but the README only documented TypeScript for UI components (.tsx). This caused confusion — it looked like TypeScript actions required manual tsc compilation with duplicated source directories.

  • Rewrote README to properly document the ts-loader setup for runtime actions (webpack config, tsconfig, app.config.yaml pointing to .ts files), alongside the existing UI TypeScript guidance
  • Removed output.filename from webpack-config.js — App Builder overrides this as an immutable option, so including it was misleading
  • Cleaned up tsAction/index.ts — fixed the function signature to match the actual Runtime action contract (single params argument), removed unused variable and type

Context

This was identified during work on AdobeDocs/app-builder#521, which adds TypeScript runtime actions documentation to the public docs. A reviewer noted that linking to this quickstart was confusing because the README didn't explain the TypeScript action setup.

Original discussion: #app-builder Slack thread

Test plan

  • Verify aio app build succeeds with the updated webpack-config.js (no output.filename)
  • Verify the tsAction builds and deploys correctly with the cleaned-up index.ts
  • Verify README renders correctly on GitHub

Made with Cursor

The typescript-app quickstart already uses the ts-loader approach for
TypeScript runtime actions, but the README only mentioned TypeScript
for UI components. This was causing confusion — people thought the
example used manual tsc compilation with duplicated source directories.

Changes:
- Rewrite README to document the ts-loader setup for runtime actions,
  including webpack config, tsconfig, and app.config.yaml usage
- Remove unnecessary output.filename from webpack-config.js (App Builder
  overrides this as an immutable option)
- Clean up tsAction/index.ts: fix the function signature to match the
  actual Runtime action contract, remove unused variable and type

Made-with: Cursor
pru55e11 pushed a commit to AdobeDocs/app-builder that referenced this pull request Mar 26, 2026
Remove the caveat about the quickstart using a manual tsc approach,
since adobe/appbuilder-quickstarts#15 updates the example to properly
document the ts-loader method.

Made-with: Cursor
@pru55e11 pru55e11 merged commit 59e5655 into master Mar 26, 2026
2 checks passed
@pru55e11 pru55e11 deleted the fix/typescript-app-docs-and-cleanup branch March 26, 2026 19:43
pru55e11 added a commit to AdobeDocs/app-builder that referenced this pull request Mar 26, 2026
… up (#522)

Remove the caveat about the quickstart using a manual tsc approach,
since adobe/appbuilder-quickstarts#15 updates the example to properly
document the ts-loader method.
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