Skip to content

Commit 037121a

Browse files
committed
chore: fixup
1 parent a173b1f commit 037121a

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

acceptance/apps/init-template/app/output.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,15 @@ export const querySchemas = {
9191
};
9292
```
9393

94-
**Step 3: Add visualization to your app**
94+
**Step 3: Run typegen (REQUIRED after any schema change)**
95+
96+
```bash
97+
npm run typegen
98+
```
99+
100+
This regenerates `client/src/appKitTypes.d.ts` with your new query types. **Without this step, TypeScript will not recognize your query keys and builds will fail.**
101+
102+
**Step 4: Add visualization to your app**
95103

96104
```typescript
97105
// client/src/App.tsx
@@ -102,9 +110,9 @@ import { BarChart } from '@databricks/appkit-ui/react';
102110

103111
**That's it!** The component handles data fetching, loading states, and rendering automatically.
104112

105-
**To refresh TypeScript types after adding queries:**
106-
- Run `npm run typegen` OR run `npm run dev` - both auto-generate type definitions in `client/src/appKitTypes.d.ts`
107-
- DO NOT manually edit `appKitTypes.d.ts`
113+
**⚠️ CRITICAL: Always run `npm run typegen` after modifying files in `config/queries/`**
114+
- DO NOT manually edit `client/src/appKitTypes.d.ts` - it is auto-generated
115+
- If you see errors like `'"my_query"' is not assignable to parameter of type`, run `npm run typegen`
108116

109117
## Installation
110118

@@ -136,4 +144,3 @@ See the databricks experimental aitools tools validate instead of running these
136144
- [Testing](docs/testing.md) - vitest unit tests, Playwright smoke/E2E tests
137145

138146
=================
139-

acceptance/cmd/workspace/apps/output.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Global Flags:
7575
-o, --output type output type: text or json (default text)
7676
-p, --profile string ~/.databrickscfg profile
7777
-t, --target string bundle target to use (if applicable)
78+
--var strings set values for variables defined in bundle config. Example: --var="key=value"
7879

7980

8081
Exit code: 1

0 commit comments

Comments
 (0)