Skip to content

Conversation

@jamescmartinez
Copy link
Contributor

  • Switch to TypeScript project references
  • Clean up "development" imports
  • Switch benchmarks and examples to use ts project references
  • Remove rootDir from tsconfigs
  • Remove outDir from base tsconfig
  • Remove test files from tsconfig exclusion
  • Add ts project references doc link
  • Add project-wide settings to root tsconfig
  • Set dashboard tsconfig to noEmit to resolve TS6310
  • Add dist outDir/exclude to project tsconfig
  • Add tsconfig.test.json for references workaround
  • Disable allowImportingTsExtensions in dashboard tsconfig
  • Include openworkflow package tests in root tsconfig
  • Add exclusion for test suite files in coverage configuration

Copilot AI review requested due to automatic review settings January 20, 2026 21:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR refactors the TypeScript configuration to use TypeScript project references, which enables better build performance and type checking across the monorepo. The changes remove custom "development" condition imports, standardize tsconfig structure by introducing a shared base configuration, and add proper project references throughout the codebase.

Changes:

  • Introduced tsconfig.base.json as a shared base configuration and converted root tsconfig.json to use project references
  • Added TypeScript project references to package tsconfigs (openworkflow, backend-*, cli, dashboard)
  • Removed "development" export conditions from all package.json files
  • Added exclusion for test suite files in vitest coverage configuration
  • Created tsconfig.test.json workaround for openworkflow package to handle circular dependencies

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tsconfig.json Converted to project references structure with file list and references to all packages/examples/benchmarks
tsconfig.base.json New shared base configuration extracted from root tsconfig with common compiler options
vitest.config.ts Added exclusion for *.testsuite.ts files from coverage
packages/openworkflow/tsconfig.json Updated to extend base config and exclude test files with reference to test config
packages/openworkflow/tsconfig.test.json New workaround config for test files to reference backend-postgres without circular dependency
packages/openworkflow/package.json Removed "development" export conditions
packages/dashboard/tsconfig.json Added project references and disabled noEmit/allowImportingTsExtensions
packages/cli/tsconfig.json Added project reference to openworkflow and updated to extend base config
packages/cli/package.json Removed "development" export conditions
packages/backend-*/tsconfig.json Added project references to openworkflow and updated to extend base config
packages/backend-*/package.json Removed "development" export conditions
examples/*/tsconfig.json Updated to extend base config and standardized outDir configuration
benchmarks/basic/tsconfig.json Updated to extend base config
Comments suppressed due to low confidence (5)

examples/basic/tsconfig.json:8

  • Missing TypeScript project references. Since this example depends on "openworkflow" and "@openworkflow/backend-postgres" packages (as seen in package.json), the tsconfig should include a "references" field to properly reference these packages for TypeScript's project references feature. This ensures proper build ordering and type checking.

Add a "references" field after line 5 with paths to the dependent packages.

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["**/*.ts"],
  "exclude": ["dist"]
}

examples/declare-workflow/tsconfig.json:8

  • Missing TypeScript project references. Since this example depends on "openworkflow" and "@openworkflow/backend-postgres" packages (as seen in package.json), the tsconfig should include a "references" field to properly reference these packages for TypeScript's project references feature. This ensures proper build ordering and type checking.

Add a "references" field after line 5 with paths to the dependent packages.

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["**/*.ts"],
  "exclude": ["dist"]
}

examples/with-schema-validation/tsconfig.json:8

  • Missing TypeScript project references. Since this example depends on "openworkflow" and "@openworkflow/backend-postgres" packages (as seen in package.json), the tsconfig should include a "references" field to properly reference these packages for TypeScript's project references feature. This ensures proper build ordering and type checking.

Add a "references" field after line 5 with paths to the dependent packages.

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["**/*.ts"],
  "exclude": ["dist"]
}

examples/workflow-discovery/tsconfig.json:8

  • Missing TypeScript project references. Since this example depends on "openworkflow" and "@openworkflow/backend-sqlite" packages (as seen in package.json), the tsconfig should include a "references" field to properly reference these packages for TypeScript's project references feature. This ensures proper build ordering and type checking.

Add a "references" field after line 5 with paths to the dependent packages.

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["**/*.ts"],
  "exclude": ["dist"]
}

benchmarks/basic/tsconfig.json:8

  • Missing TypeScript project references. Since this benchmark depends on "openworkflow" and "@openworkflow/backend-postgres" packages (as seen in package.json), the tsconfig should include a "references" field to properly reference these packages for TypeScript's project references feature. This ensures proper build ordering and type checking.

Add a "references" field after line 5 with paths to the dependent packages.

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["**/*.ts"],
  "exclude": ["dist"]
}

Copilot AI review requested due to automatic review settings January 20, 2026 22:01
@codecov
Copy link

codecov bot commented Jan 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 20 out of 21 changed files in this pull request and generated 8 comments.

@@ -1,9 +1,9 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all package tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,9 +1,9 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all package tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,7 +1,6 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field across the project. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,7 +1,6 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field across the project. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,7 +1,6 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field across the project. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,7 +1,7 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field across the project. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,7 +1,6 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field across the project. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@@ -1,9 +1,9 @@
{
"extends": ["../../tsconfig.json"],
"extends": "../../tsconfig.base.json",
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

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

Inconsistent format for "extends" field. Some tsconfig files use a string format while others use an array format. For consistency, consider using the same format across all package tsconfig files (preferably array format to allow for easier future additions).

Suggested change
"extends": "../../tsconfig.base.json",
"extends": ["../../tsconfig.base.json"],

Copilot uses AI. Check for mistakes.
@jamescmartinez jamescmartinez merged commit fc098d7 into main Jan 20, 2026
12 checks passed
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