chore: emit compiled TS to build/ instead of next to sources by X-Guardian · Pull Request #116 · open-constructs/cdk-terrain

X-Guardian · 2026-04-23T22:33:58Z

Related issue

Fixes #115

Description

Redirect TypeScript compilation to a dedicated build/ folder in the seven @cdktn/* packages so that .js/.d.ts no longer land next to .ts sources. Each package now sets rootDir: ./src and outDir: ./build, with main/types pointing at build/.
Rename lib/ → src/ in @cdktn/provider-generator, @cdktn/hcl2cdk, and @cdktn/hcl2json so every package consistently uses src/ for sources and build/ for output.
Fix stale subpath imports exposed by the rename: @cdktn/hcl2cdk no longer imports @cdktn/hcl2json/lib/syntax-tree (collapsed onto the existing TFExpressionSyntaxTree namespace import), and three hcl2json test files move from ../lib to ../src.

Changes per package

Package	Notes
`@cdktn/cli-core`	`main`: `src/lib/index.js` → `build/lib/index.js`
`@cdktn/commons`	—
`@cdktn/provider-schema`	—
`@cdktn/hcl-tools`	Go WASM glue in `wasm/` untouched; `build-go.sh` unchanged
`@cdktn/provider-generator`	`lib`→`src` rename; `postbuild` path updated; dropped vestigial cross-package include for `../commons/src/module-schema.ts` (commons re-exports it via `index.ts`)
`@cdktn/hcl2cdk`	`lib`→`src` rename; narrowed tsconfig `include` from `*/.ts` to `src/*/.ts` so `test/` is no longer compiled to disk (ts-jest runs tests directly)
`@cdktn/hcl2json`	`lib`→`src` rename; Go WASM glue untouched

Checklist

I have updated the PR title to match CDKTN's style guide
I have run the linter on my code locally
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation if applicable
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works if applicable
New and existing unit tests pass locally with my changes

so0k · 2026-04-27T06:40:29Z

I agree splitting emit target is a good practice, but not sure if modifying workspaced packages to use the build output is the best approach across all packages?

X-Guardian · 2026-04-27T10:29:59Z

Hi @so0k, thanks for the comment. Can you clarify what your concern is? The workspace packages were already using the build output already, this PR doesn't change that.

jsteinich · 2026-04-27T14:05:53Z

I've been going a bit back and forth on this.

In regards to the src changes:

The consistency is nice
Looking into historical changes is slightly harder (some tools handle the git rename nicely while others get lost)
Small concern of possibly breaking changes. I wouldn't expect so, but I haven't validated each package's exports
Is there some other benefit?

In regards to the build changes:

It's definitely common in other languages. I'm less certain about TypeScript.
Is there likely to be any impact to performance (builds / tests) either positively or negatively)?
I want to checkout the branch and see how my IDE handles it (just a note for myself as the current structure is handled very nicely)

X-Guardian · 2026-04-28T13:09:45Z

Thanks for the feedback @jsteinich. In response to your comments:

Changes from `lib` to `src`

Purely for consistency. As a new comer to the repo, It was confusing for me to have inconsistent source file directories for the different packages.

`build` changes

All major Typescript repos, especially monorepos, that I have worked on always output their build files to a separate directory, keeping them away from the source files. I thought that was pretty much standard practice now. Take a look at Nx's typescript-template repo for an example.
There is no performance impact either way.
I had several issues whilst I was creating my first changes to the repo with stale javascript files alongside the typescript files confusing VSCode's tooling.

I'm happy to split the two changes into separate pull requests if you would like.

jsteinich · 2026-04-28T14:21:12Z

I'm fine with the changes.
@so0k any remaining concerns?

so0k · 2026-04-28T14:30:26Z

it’s ok, my main concern was the requirement that you’d have to build before cross pkg TS resolver works? but maybe the tsconfig already takes care of this

i’m more familiar with TurboRepo recommended set up where internal pkgs are JIT compiled (package.json points to src/*ts files instead of build

but i think all of the CDKTF pkgs are published so they all need to build if you want to avoid heavy lifting in tsconfig / eslint set up

i haven’t tried the changes locally but if you have no concerns then I withdraw my concern

X-Guardian · 2026-04-28T15:48:19Z

For info, you had to build the packages already before this change, as their package.json types reference index.d.ts which only exists once the package is built.

**Breaking changes** ### Python 3.8 is no longer supported We have dropped support for Python 3.8, please update to Python 3.9 or higher. ### Go 1.18-1.24 are no longer supported We have dropped support for Go 1.18 - 1.24, please update to Go 1.25 or higher. ### TypeScript versions less than 4.5 are no longer suppored Provider generation now uses features from TypeScript 4.5. Note that there isn't an official minimum supported TypeScript at this time and using the latest 5.x version is recommended. **Upcoming Breaking Changes** Node version 22.x will become the minimum in an upcoming release as 20.x is now EoL. ### feat - feat(provider-generator): use type modifier on imports [\#150](#150) - feat(lib): add StringMapMap class [\#110](#110) ### chore - chore: clean up yarn install warnings [\#149](#149) - chore(deps): bump the github-actions-backward-compatible group with 6 updates [\#146](#146) - chore: Fix eslint warnings - phase 5 [\#140](#140) - chore: Fix eslint warnings - phase 4 [\#139](#139) - chore: Fix eslint warnings - phase 3 [\#138](#138) - chore: Fix eslint warnings - phase 2 [\#137](#137) - chore: Fix eslint warnings - phase 1 [\#135](#135) - chore(provider-generator): Update retry to terraform init for transient GitHub errors [\#134](#134) - chore: Remove unused dependencies from packages - phase 1 [\#133](#133) - chore(provider-generator): Add retry to terraform init for transient GitHub errors [\#132](#132) - chore(provider-generator): enable typescript declarationMap [\#131](#131) - chore: Fix Java flaky integration test [\#130](#130) - chore: Add missing dependencies to packages [\#129](#129) - chore: Standardise test scripts to only run tests [\#128](#128) - chore: Remove edited from the examples workflow pull_request types [\#127](#127) - chore: Add retry to build-example [\#126](#126) - chore: Bump verdaccio version and add npm install retries [\#122](#122) - chore: Remove `edited` from the test workflow pull_request types [\#121](#121) - chore: Replace depcheck CI check with knip [\#120](#120) - chore: Update test providers to support darwin arm64 [\#119](#119) - chore: Refine eslint configuration [\#118](#118) - chore: emit compiled TS to build/ instead of next to sources [\#116](#116) - chore: Add VSCode Settings and Extension Recommendations [\#114](#114) - chore: Fix eslint auto-fixable issues [\#113](#113) - chore: use new docker image in builds [\#108](#108) - chore: Update docker image to have Go 1.25 and Node 22 [\#97](#97) - chore: Upgrade dependencies for all [\#91](#91) - chore: Upgrade jest to v30 [\#89](#89) - chore(deps): bump the github-actions-backward-compatible group with 4 updates [\#88](#88) - chore(deps): bump the github-actions-breaking group with 5 updates [\#87](#87) - chore: add migration context to bug report issue templates [skip ci] [\#86](#86) - chore: npm-check-updates && yarn upgrade [\#84](#84) - chore: Upgrade dependencies for all [\#83](#83) - chore(lib): add test showing no failure if resource scoped to app [\#73](#73) - chore(deps): Run npx yarn-audit-fix --force [\#59](#59) - chore(cli): Replace node-pty with simple interactive process [\#55](#55) - chore: Upgrade dependencies for JSII [\#20](#20) ### fix - fix(cli): anchor jest testPathIgnorePatterns in typescript template [\#147](#147) - fix(tests): Fix app.test and json-to-hcl.test race condition [\#125](#125) - fix(lib): ForExpression missing iteratorContext and OperatorExpression drops falsy right operands [\#112](#112) - fix(cli): support pre-built provider metadata with cdktn key [\#107](#107) - fix(cli): don't check cdktf-cli version [\#99](#99) - fix(deps): replace archiver with yazl [\#95](#95) - fix(lib): fail on constructs outside of stacks (under feature flag) [\#93](#93) - fix(gha): Fix GitHub release creation [\#90](#90)

### Description ## Summary Migrates the `cdktn` package to the standard `src/` (sources) + `lib/` (build output) layout used by every other workspace package. Sources and compile output were previously co-located in `lib/`, which caused stale `.js`/`.d.ts` artifacts to confuse knip after every local `yarn build` (false-positive "unused dependency" reports for `json-stable-stringify`, `yazl`, `@types/json-stable-stringify`, `@types/semver` because TS module resolution was preferring the stale `.d.ts` typings over the actual `.ts` sources). ## Why - After [#116](#116) migrated other packages to `src/` → `build/`, `cdktn` was the only holdout still emitting compiled output next to sources. - Mixed layout meant `knip` would silently fail locally after a build, even though it was clean in CI (CI runs knip on a fresh checkout with no compiled artifacts). ## What changed **Source layout:** - 85 `.ts` source files moved: `packages/cdktn/lib/**/*.ts` → `packages/cdktn/src/**/*.ts` (subdir layout preserved: `backends/`, `functions/`, `hcl/`, `private/`, `synthesize/`, `testing/`, `tokens/`, `validations/`) - `package.json` `"main"` and `"types"` continue to point at `lib/index.js` / `lib/index.d.ts` — distribution surface is unchanged. **Build configuration ([packages/cdktn/package.json](packages/cdktn/package.json)):** - Added `"jsii"."tsc": { "outDir": "lib", "rootDir": "src" }` — JSII regenerates `tsconfig.json` to compile from `src/` and emit to `lib/`. - Added `"jsii"."excludeTypescript": ["src/**/__tests__/**"]` — three colocated `__tests__` files inside `src/testing/` import from `test/helper/` (outside `rootDir`); excluding them keeps JSII's `rootDir` constraint satisfied. Jest still picks them up via `testMatch`. **Test wiring:** - 33 test files + 5 helpers updated: `from "../lib"` → `from "../src"` (and `../../lib` → `../../src` for nested `test/helper/` and `test/tokens/` files). - Added [packages/cdktn/tsconfig.test.json](packages/cdktn/tsconfig.test.json) — extends the JSII-generated `tsconfig.json` but widens `rootDir` to `.` and excludes `lib/**/*.d.ts`. Required because (a) test files live outside `rootDir: src` and ts-jest can't compute output paths for out-of-tree files, and (b) without excluding `lib/`, ts-jest sees both `src/terraform-count.ts` and `lib/terraform-count.d.ts` as separate type declarations and rejects assignment between them. - Updated [jest.config.js](packages/cdktn/jest.config.js) to point ts-jest at `tsconfig.test.json`. **Knip + docs:** - [knip.jsonc](knip.jsonc) — `packages/cdktn` workspace project glob updated to `["src/**/*.ts", "test/**/*.ts"]`; entry list dropped (knip auto-detects `src/index.ts`). - [CLAUDE.md](CLAUDE.md), [CONTRIBUTING.md](CONTRIBUTING.md), [tools/generate-function-bindings/README.md](tools/generate-function-bindings/README.md) — `cdktn/lib/...` paths in docs updated to `cdktn/src/...`. ### Checklist - [x] I have updated the PR title to match [CDKTN's style guide](https://github.com/open-constructs/cdk-terrain/blob/main/CONTRIBUTING.md#pull-requests-1) - [x] I have run the linter on my code locally - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the [documentation](https://github.com/open-constructs/cdk-terrain/tree/main/website) if applicable - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works if applicable - [x] New and existing unit tests pass locally with my changes  --------- Co-authored-by: Simon Heather <simon.heather@yulife.com>

github-actions · 2026-06-06T05:03:04Z

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

X-Guardian force-pushed the ts-compile-change branch from 10cb0c1 to 4b15713 Compare April 25, 2026 17:18

X-Guardian marked this pull request as ready for review April 26, 2026 19:27

X-Guardian requested a review from a team as a code owner April 26, 2026 19:27

Simon Heather added 3 commits April 27, 2026 11:30

chore: emit compiled TS to build/ instead of next to sources

cd1e589

Add EOF LFs

c2521bf

Update paths in hcl2cdk tests

ea36697

X-Guardian force-pushed the ts-compile-change branch from 4b15713 to ea36697 Compare April 27, 2026 10:32

Simon Heather and others added 2 commits April 27, 2026 16:12

Update knip.jsonc

b8aa472

Merge branch 'main' into ts-compile-change

7ff8937

jsteinich approved these changes Apr 28, 2026

View reviewed changes

jsteinich merged commit 898926b into open-constructs:main Apr 29, 2026
664 of 666 checks passed

X-Guardian mentioned this pull request May 1, 2026

chore(lib): Move cdktn package to src/ and lib/ layout #145

Merged

5 of 8 tasks

jsteinich mentioned this pull request May 5, 2026

chore: prepare v0.23.0 release #164

Merged

github-actions Bot locked as resolved and limited conversation to collaborators Jun 6, 2026

Navigation Menu

Repository navigation

chore: emit compiled TS to build/ instead of next to sources - #116

chore: emit compiled TS to build/ instead of next to sources#116
jsteinich merged 5 commits into
open-constructs:mainfrom
X-Guardian:ts-compile-change

X-Guardian commented Apr 23, 2026 •

edited

Loading

Uh oh!

so0k commented Apr 27, 2026

Uh oh!

X-Guardian commented Apr 27, 2026

Uh oh!

jsteinich commented Apr 27, 2026

Uh oh!

X-Guardian commented Apr 28, 2026

Uh oh!

jsteinich commented Apr 28, 2026

Uh oh!

so0k commented Apr 28, 2026

Uh oh!

X-Guardian commented Apr 28, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jun 6, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

X-Guardian commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issue

Description

Changes per package

Checklist

Uh oh!

so0k commented Apr 27, 2026

Uh oh!

X-Guardian commented Apr 27, 2026

Uh oh!

jsteinich commented Apr 27, 2026

Uh oh!

X-Guardian commented Apr 28, 2026

Changes from lib to src

build changes

Uh oh!

jsteinich commented Apr 28, 2026

Uh oh!

so0k commented Apr 28, 2026

Uh oh!

X-Guardian commented Apr 28, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jun 6, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

X-Guardian commented Apr 23, 2026 •

edited

Loading

Changes from `lib` to `src`

`build` changes