From bcd876273308cacd8d9b9faa5b3496e4a7e2f61f Mon Sep 17 00:00:00 2001 From: Aimee Barciauskas Date: Fri, 12 Jun 2026 14:07:01 -0700 Subject: [PATCH 1/2] docs: document git submodule init step in DEVELOP.md Building without initialized submodules fails with a cryptic TS6053 error because morecantile's tsconfig references files in the spec submodule. Document the required init step. Co-Authored-By: Claude Opus 4.8 --- DEVELOP.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/DEVELOP.md b/DEVELOP.md index a4b163a2..9b388cfb 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -2,6 +2,14 @@ This is a monorepo managed with pnpm workspaces. +Some packages (e.g. `morecantile`, `geozarr`) reference files from git submodules. +Initialize them before building, otherwise `pnpm build` fails with `TS6053: File '...' not found`: + +```bash +# Initialize git submodules (required for the build) +git submodule update --init --recursive +``` + ```bash # Install dependencies pnpm install From 3362e0d2858176048754918f0c5a9cf9ac1c8e22 Mon Sep 17 00:00:00 2001 From: Aimee Barciauskas Date: Fri, 12 Jun 2026 14:37:49 -0700 Subject: [PATCH 2/2] Modified setup instructions --- DEVELOP.md | 10 +++++++--- examples/cog-basic/README.md | 13 +++---------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/DEVELOP.md b/DEVELOP.md index 9b388cfb..b875be0f 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -2,15 +2,15 @@ This is a monorepo managed with pnpm workspaces. +## Package setup + Some packages (e.g. `morecantile`, `geozarr`) reference files from git submodules. -Initialize them before building, otherwise `pnpm build` fails with `TS6053: File '...' not found`: +Initialize them before building. ```bash # Initialize git submodules (required for the build) git submodule update --init --recursive -``` -```bash # Install dependencies pnpm install @@ -19,7 +19,11 @@ pnpm build # Watch mode for development pnpm build:watch +``` + +## Package Testing +```bash # Run tests in all packages pnpm test diff --git a/examples/cog-basic/README.md b/examples/cog-basic/README.md index b761e357..8d3b8534 100644 --- a/examples/cog-basic/README.md +++ b/examples/cog-basic/README.md @@ -19,20 +19,13 @@ The example displays 10m resolution RGB imagery of New Zealand from LINZ (Land I ## Setup -1. Install dependencies from the repository root: - ```bash - pnpm install - ``` +1. Follow instructions for package setup in [DEVELOP.md](../../DEVELOP.md#package-setup). -2. Build the packages: - ```bash - pnpm build - ``` +2. Run the development server: -3. Run the development server: ```bash cd examples/cog-basic pnpm dev ``` -4. Open your browser to http://localhost:3000 +3. Open your browser to http://localhost:3000