diff --git a/.claude/commands/review-commit.md b/.claude/commands/review-commit.md index d16bb0d..ea00c68 100644 --- a/.claude/commands/review-commit.md +++ b/.claude/commands/review-commit.md @@ -8,7 +8,7 @@ Please review the **staged changes** (git diff --cached) in this repository agai ## Context -This is the **Databricks Apps Kit** (@databricks/app-kit) - a modular TypeScript SDK for building Databricks apps with workflows and plugins. +This is the **Databricks Apps Kit** (@databricks/appkit) - a modular TypeScript SDK for building Databricks apps with workflows and plugins. ## SDK Core Principles diff --git a/.claude/commands/review-pr.md b/.claude/commands/review-pr.md index 5efe0bf..c39fb2e 100644 --- a/.claude/commands/review-pr.md +++ b/.claude/commands/review-pr.md @@ -9,7 +9,7 @@ Please review **all changes in the current branch** (compared to $ARGUMENTS or m ## Context -This is the **Databricks AppKit** (@databricks/app-kit) - a modular TypeScript SDK for building Databricks apps with workflows and plugins. +This is the **Databricks AppKit** (@databricks/appkit) - a modular TypeScript SDK for building Databricks apps with workflows and plugins. ## SDK Core Principles diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6fd15e6..4bb789d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: name: Detect Changes outputs: docs: ${{ steps.filter.outputs.docs }} - app-kit: ${{ steps.filter.outputs.app-kit }} + appkit: ${{ steps.filter.outputs.appkit }} steps: - uses: actions/checkout@v4 - uses: dorny/paths-filter@v3 @@ -31,7 +31,7 @@ jobs: filters: | docs: - 'docs/**' - app-kit: + appkit: - '!docs/**' lint_and_typecheck: @@ -61,7 +61,7 @@ jobs: test: name: Unit Tests needs: detect-changes - if: needs.detect-changes.outputs.app-kit == 'true' + if: needs.detect-changes.outputs.appkit == 'true' runs-on: group: databricks-protected-runner-group labels: linux-ubuntu-latest diff --git a/CLAUDE.md b/CLAUDE.md index 68271dc..2f8868c 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -14,8 +14,8 @@ Databricks AppKit is a modular TypeScript SDK for building Databricks applicatio ``` /packages/ - /app-kit/ - Core SDK with plugin architecture - /app-kit-ui/ - React components and JS utilities + /appkit/ - Core SDK with plugin architecture + /appkit-ui/ - React components and JS utilities /shared/ - Shared TypeScript types across packages /apps/ @@ -70,8 +70,8 @@ pnpm test:watch # Run tests in watch mode ``` **Test Projects:** -- `app-kit-ui`: Uses jsdom environment (for React components) -- `app-kit`: Uses node environment (for Node.js SDK) +- `appkit-ui`: Uses jsdom environment (for React components) +- `appkit`: Uses node environment (for Node.js SDK) ### Code Quality ```bash @@ -113,7 +113,7 @@ AppKit uses a **phase-based plugin architecture** with three initialization phas **Creating a Plugin:** ```typescript -import { Plugin, toPlugin } from '@databricks/app-kit'; +import { Plugin, toPlugin } from '@databricks/appkit'; class MyPlugin extends Plugin { name: string = "my-plugin"; @@ -257,7 +257,7 @@ Biome is used instead of ESLint/Prettier for faster performance: pnpm add -Dw # Package-specific dependencies -pnpm --filter=@databricks/app-kit add +pnpm --filter=@databricks/appkit add # App dependencies pnpm --filter=sdk-playground add @@ -273,7 +273,7 @@ Packages should: ### Type Generation -`packages/app-kit/src/utils/type-generator.ts` creates plugin registry types at build time. This enables: +`packages/appkit/src/utils/type-generator.ts` creates plugin registry types at build time. This enables: ```typescript const AppKit = await createApp({ plugins: [...] }); AppKit.myPlugin.method(); // Typed based on registered plugins @@ -291,7 +291,7 @@ The reference app demonstrates AppKit usage: **Frontend (`apps/dev-playground/client/`):** - Vite + React 19 + TypeScript - TanStack Router for file-based routing (routes in `src/routes/`) -- Components from `@databricks/app-kit-ui` +- Components from `@databricks/appkit-ui` - Route files: `src/routes/.route.tsx` - Root layout: `src/routes/__root.tsx` diff --git a/README.md b/README.md index 18e38b7..aed3028 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# App Kit +# AppKit > [!WARNING] > ## ⚠️ PREVIEW - NOT FOR PRODUCTION USE @@ -17,7 +17,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution gu ## Documentation -The `docs/` directory contains the App Kit documentation site, built with Docusaurus. +The `docs/` directory contains the AppKit documentation site, built with Docusaurus. **Working with docs:** diff --git a/apps/clean-app/package.json b/apps/clean-app/package.json index e31fb90..bd1a3d7 100644 --- a/apps/clean-app/package.json +++ b/apps/clean-app/package.json @@ -10,7 +10,7 @@ "preview": "vite preview" }, "dependencies": { - "@databricks/app-kit": "workspace:*", + "@databricks/appkit": "workspace:*", "react": "^19.2.0", "react-dom": "^19.2.0" }, diff --git a/apps/clean-app/server.ts b/apps/clean-app/server.ts index cc279cb..a5e7809 100644 --- a/apps/clean-app/server.ts +++ b/apps/clean-app/server.ts @@ -1,4 +1,4 @@ -import { createApp, server } from "@databricks/app-kit"; +import { createApp, server } from "@databricks/appkit"; createApp({ plugins: [server()], diff --git a/apps/dev-playground/client/index.html b/apps/dev-playground/client/index.html index 149833a..bbf3c75 100644 --- a/apps/dev-playground/client/index.html +++ b/apps/dev-playground/client/index.html @@ -9,7 +9,7 @@