Skip to content

Commit 7fa39fb

Browse files
Merge branch 'master' into codex/touch-double-tap-zoom
2 parents b1e6a61 + 6795cc9 commit 7fa39fb

90 files changed

Lines changed: 602 additions & 216 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Repository Guidance
2+
3+
This file applies to the entire `deck.gl` repository. More specific `AGENTS.md` files in
4+
subdirectories may add local guidance.
5+
6+
## Setup Commands
7+
8+
- Install dependencies from the repo root: `yarn`
9+
- Build packages: `yarn build`
10+
- Run lint: `yarn lint`
11+
- Run all tests: `yarn test`
12+
- Run headless tests: `yarn test-headless`
13+
- Run render tests: `yarn test-render`
14+
- Run browser tests: `yarn test-browser`
15+
- Run website checks: `yarn test-website`
16+
- Use the exact script names from `package.json`; do not substitute spaced forms such as
17+
`yarn test headless`.
18+
19+
## Before Committing
20+
21+
- Run the most relevant tests for the changed packages, integrations, examples, or docs.
22+
- Run `yarn lint` for JavaScript and TypeScript changes. If lint failures are unrelated existing
23+
issues, call that out explicitly instead of hiding it.
24+
- If dependencies or package metadata changed, run `yarn` in the repo root and include any
25+
`yarn.lock` updates.
26+
- Do not reformat files you are not otherwise changing. Keep formatting-only churn separate from
27+
logic changes when practical.
28+
29+
## Ready For Merge
30+
31+
When asked to "get ready for merge", do a full merge-readiness pass:
32+
33+
- Audit the public API surface touched by the change. Add or update TSDoc for every new or changed
34+
public class, function, method, property, and type.
35+
- Do a documentation pass when behavior, public API, examples, or migration guidance changed.
36+
Include relevant module docs, examples, sidebars, `docs/whats-new.md`, and upgrade or migration
37+
guide content.
38+
- Keep upgrade guides focused on breaking changes, removals, and deprecations. Put new-feature
39+
notes in the appropriate module docs or release notes instead.
40+
- Run `yarn` in the repo root so workspace metadata and `yarn.lock` are up to date, especially
41+
after any `package.json` change.
42+
- Run `yarn build` as the repo-wide type, declaration, and package build gate.
43+
- Run `yarn lint` for the final lint and formatting gate, then review the resulting diff.
44+
- Run the relevant tests for the changed packages, examples, integrations, and docs/website wiring.
45+
Typical commands are `yarn test`, `yarn test-headless`, `yarn test-render`, `yarn test-browser`,
46+
and `yarn test-website`.
47+
- For website or docs changes, run the website check from the repo root with `yarn test-website`.
48+
- Prepare a copyable Markdown PR description based on the branch diff compared to `master`. Start
49+
with the PR goals, then list the actual changes and validation.
50+
- In the final handoff, call out which merge-readiness gates passed, which were not run, and any
51+
remaining risk or unrelated pre-existing failures.
52+
53+
## Code Style
54+
55+
- Prefer TypeScript and ES module syntax.
56+
- Match the surrounding file style. In source files, use single quotes and semicolons.
57+
- Never abbreviate variable names. Use camelCase for variables, functions, and fields; PascalCase
58+
for types and classes; and CAPITAL_CASE for constants.
59+
- Prefer verb-noun names for functions and methods.
60+
- File names should be kebab-case unless an existing local convention differs.
61+
62+
## Dependencies
63+
64+
- Be conservative with new external dependencies. Add one only when it provides meaningful
65+
capability, not just a small utility.
66+
- Prefer vis.gl ecosystem packages when they fit the layering. Lower-level math or utility modules
67+
should not depend on deck.gl.
68+
- Prefer math.gl modules for math helpers.
69+
- Avoid lodash-style dependencies for simple operations.
70+
71+
## Investigation
72+
73+
- Do not fix problems by adding caches. Investigate why the problem occurs and address the root
74+
cause.

docs/api-reference/core/deck.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ The canvas to render into. Can be either a HTMLCanvasElement or the element id.
5252

5353
luma.gl Device used to manage the application's connection with the GPU. Will be auto-created if not supplied.
5454

55+
When a `Device` is supplied, Deck does not destroy it when finalized. While the `Deck` instance is active, Deck owns the `device.props.onResize` callback for the active render canvas context; use `DeckProps.onResize` to observe Deck canvas resizes.
56+
5557
#### `deviceProps` ([DeviceProps](https://luma.gl/docs/api-reference/core/device#deviceprops) | [WebGLDeviceProps](https://luma.gl/docs/api-reference/webgl/#webgldeviceprops)) {#deviceprops}
5658

5759
Options used for creating a new luma.gl GPU [Device](https://luma.gl/docs/api-reference/core/device).
@@ -551,6 +553,7 @@ Receives arguments:
551553
* `size`
552554
- `width` (number) - the new width of the deck canvas, in client pixels
553555
- `height` (number) - the new height of the deck canvas, in client pixels
556+
* `canvasContext` ([CanvasContext](https://luma.gl/docs/api-reference/core/canvas-context), optional) - the luma.gl canvas context that reported the resize
554557
555558
556559
#### `onBeforeRender` (Function) {#onbeforerender}

examples/basemap-browser/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@
2727
"@types/react-dom": "^18.2.0",
2828
"@types/stats.js": "^0.17.4",
2929
"typescript": "^4.6.0",
30-
"vite": "^7.3.1"
30+
"vite": "^7.3.3"
3131
}
3232
}

examples/experimental/bezier/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
},
1616
"devDependencies": {
1717
"typescript": "^4.6.0",
18-
"vite": "^7.3.1"
18+
"vite": "^7.3.3"
1919
}
2020
}

examples/experimental/h3-grid/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
},
1818
"devDependencies": {
1919
"typescript": "^4.6.0",
20-
"vite": "^7.3.1"
20+
"vite": "^7.3.3"
2121
}
2222
}

examples/experimental/interleaved-buffer/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
},
1515
"devDependencies": {
1616
"typescript": "^4.6.0",
17-
"vite": "^7.3.1"
17+
"vite": "^7.3.3"
1818
}
1919
}

examples/experimental/tfjs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
},
1515
"devDependencies": {
1616
"typescript": "^4.6.0",
17-
"vite": "^7.3.1"
17+
"vite": "^7.3.3"
1818
}
1919
}

examples/get-started/pure-js/apple-maps/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
"@deck.gl/layers": "^9.0.0"
1414
},
1515
"devDependencies": {
16-
"vite": "^7.3.1"
16+
"vite": "^7.3.3"
1717
}
1818
}

examples/get-started/pure-js/arcgis/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"@deck.gl/layers": "^9.0.0"
1616
},
1717
"devDependencies": {
18-
"vite": "^7.3.1"
18+
"vite": "^7.3.3"
1919
}
2020
}

examples/get-started/pure-js/basic/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
"@deck.gl/layers": "^9.0.0"
1414
},
1515
"devDependencies": {
16-
"vite": "^7.3.1"
16+
"vite": "^7.3.3"
1717
}
1818
}

0 commit comments

Comments
 (0)