Renamed core package to overlay

getsentry · Nov 24, 2023 · eacbe71 · eacbe71
1 parent d8e2cc9
commit eacbe71
Show file tree

Hide file tree

Showing 79 changed files with 175 additions and 450 deletions.
diff --git a/.changeset/sweet-days-reflect.md b/.changeset/sweet-days-reflect.md
@@ -0,0 +1,8 @@
+---
+'@spotlightjs/astro': patch
+'@spotlightjs/overlay': patch
+'@spotlightjs/sidecar': patch
+'@spotlightjs/tsconfig': patch
+---
+
+Renamed core to overlay package
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
  "private": true,
  "type": "module",
  "scripts": {
- "dev:core": "pnpm --filter core dev",
+ "dev:overlay": "pnpm --filter overlay dev",
  "dev:website": "pnpm --filter website dev",
  "dev:playground": "pnpm --filter astro-playground dev",
  "build": "pnpm --filter=!astro-playground -r run build",

diff --git a/packages/astro/package.json b/packages/astro/package.json
@@ -26,7 +26,7 @@
  ".": "./src/index.ts"
  },
  "dependencies": {
- "@spotlightjs/core": "workspace:*",
+ "@spotlightjs/overlay": "workspace:*",
  "@spotlightjs/sidecar": "workspace:*",
  "astro": "^3.4.0",
  "source-map": "^0.7.4"

diff --git a/packages/astro/src/index.ts b/packages/astro/src/index.ts
@@ -61,4 +61,4 @@ const createPlugin = (options?: SpotlightOptions): AstroIntegration => {
 
 export default createPlugin;
 
-export * from '@spotlightjs/core';
+export * from '@spotlightjs/overlay';
diff --git a/packages/astro/src/overlay/index.ts b/packages/astro/src/overlay/index.ts
@@ -1,6 +1,6 @@
 import type { DevOverlayPlugin } from 'astro';
 
-import * as Spotlight from '@spotlightjs/core';
+import * as Spotlight from '@spotlightjs/overlay';
 
 const sentryLogo = `<svg width="256" height="256" viewBox="0 0 256 256" fill="none" xmlns="http://www.w3.org/2000/svg">
 <rect width="256" height="256" fill="none"/>

diff --git a/packages/core/CHANGELOG.md → packages/overlay/CHANGELOG.md b/packages/core/CHANGELOG.md → packages/overlay/CHANGELOG.md
diff --git a/packages/core/LICENSE → packages/overlay/LICENSE b/packages/core/LICENSE → packages/overlay/LICENSE
diff --git a/packages/core/_fixtures/envelope1.txt → packages/overlay/_fixtures/envelope1.txt b/packages/core/_fixtures/envelope1.txt → packages/overlay/_fixtures/envelope1.txt
diff --git a/packages/core/_fixtures/envelope_php.txt → packages/overlay/_fixtures/envelope_php.txt b/packages/core/_fixtures/envelope_php.txt → packages/overlay/_fixtures/envelope_php.txt
diff --git a/packages/core/_fixtures/envelope_python.txt → ...ges/overlay/_fixtures/envelope_python.txt b/packages/core/_fixtures/envelope_python.txt → ...ges/overlay/_fixtures/envelope_python.txt
diff --git a/packages/core/package.json → packages/overlay/package.json b/packages/core/package.json → packages/overlay/package.json
@@ -1,6 +1,6 @@
 {
- "name": "@spotlightjs/core",
- "description": "The core Spotlight package to add debug functionality to your web app.",
+ "name": "@spotlightjs/overlay",
+ "description": "The overlay of Spotlight to add debug interface to your web app.",
  "version": "0.0.15",
  "license": "Apache-2.0",
  "type": "module",

diff --git a/packages/core/postcss.config.js → packages/overlay/postcss.config.js b/packages/core/postcss.config.js → packages/overlay/postcss.config.js
diff --git a/packages/core/src/App.tsx → packages/overlay/src/App.tsx b/packages/core/src/App.tsx → packages/overlay/src/App.tsx
diff --git a/packages/core/src/assets/glyph.svg → packages/overlay/src/assets/glyph.svg b/packages/core/src/assets/glyph.svg → packages/overlay/src/assets/glyph.svg
diff --git a/packages/core/src/components/Debugger.tsx → packages/overlay/src/components/Debugger.tsx b/packages/core/src/components/Debugger.tsx → packages/overlay/src/components/Debugger.tsx
diff --git a/packages/core/src/components/Overview.tsx → packages/overlay/src/components/Overview.tsx b/packages/core/src/components/Overview.tsx → packages/overlay/src/components/Overview.tsx
diff --git a/packages/core/src/components/Tabs.tsx → packages/overlay/src/components/Tabs.tsx b/packages/core/src/components/Tabs.tsx → packages/overlay/src/components/Tabs.tsx
diff --git a/packages/core/src/components/Trigger.tsx → packages/overlay/src/components/Trigger.tsx b/packages/core/src/components/Trigger.tsx → packages/overlay/src/components/Trigger.tsx
diff --git a/packages/core/src/index.css → packages/overlay/src/index.css b/packages/core/src/index.css → packages/overlay/src/index.css
diff --git a/packages/core/src/index.tsx → packages/overlay/src/index.tsx b/packages/core/src/index.tsx → packages/overlay/src/index.tsx
diff --git a/.../src/integrations/console/console-tab.tsx → .../src/integrations/console/console-tab.tsx b/.../src/integrations/console/console-tab.tsx → .../src/integrations/console/console-tab.tsx
diff --git a/...es/core/src/integrations/console/index.ts → ...overlay/src/integrations/console/index.ts b/...es/core/src/integrations/console/index.ts → ...overlay/src/integrations/console/index.ts
diff --git a/...es/core/src/integrations/console/types.ts → ...overlay/src/integrations/console/types.ts b/...es/core/src/integrations/console/types.ts → ...overlay/src/integrations/console/types.ts
diff --git a/...ages/core/src/integrations/integration.ts → ...s/overlay/src/integrations/integration.ts b/...ages/core/src/integrations/integration.ts → ...s/overlay/src/integrations/integration.ts
diff --git a/...tegrations/sentry/components/DateTime.tsx → ...tegrations/sentry/components/DateTime.tsx b/...tegrations/sentry/components/DateTime.tsx → ...tegrations/sentry/components/DateTime.tsx
diff --git a/...ns/sentry/components/EventBreadcrumbs.tsx → ...ns/sentry/components/EventBreadcrumbs.tsx b/...ns/sentry/components/EventBreadcrumbs.tsx → ...ns/sentry/components/EventBreadcrumbs.tsx
diff --git a/...tions/sentry/components/EventContexts.tsx → ...tions/sentry/components/EventContexts.tsx b/...tions/sentry/components/EventContexts.tsx → ...tions/sentry/components/EventContexts.tsx
diff --git a/...ations/sentry/components/EventDetails.tsx → ...ations/sentry/components/EventDetails.tsx b/...ations/sentry/components/EventDetails.tsx → ...ations/sentry/components/EventDetails.tsx
diff --git a/...egrations/sentry/components/EventList.tsx → ...egrations/sentry/components/EventList.tsx b/...egrations/sentry/components/EventList.tsx → ...egrations/sentry/components/EventList.tsx
diff --git a/...ations/sentry/components/Events/Error.tsx → ...ations/sentry/components/Events/Error.tsx b/...ations/sentry/components/Events/Error.tsx → ...ations/sentry/components/Events/Error.tsx
diff --git a/.../sentry/components/Events/Error/Frame.tsx → .../sentry/components/Events/Error/Frame.tsx b/.../sentry/components/Events/Error/Frame.tsx → .../sentry/components/Events/Error/Frame.tsx
diff --git a/...ations/sentry/components/PlatformIcon.tsx → ...ations/sentry/components/PlatformIcon.tsx b/...ations/sentry/components/PlatformIcon.tsx → ...ations/sentry/components/PlatformIcon.tsx
diff --git a/...ntegrations/sentry/components/SdkList.tsx → ...ntegrations/sentry/components/SdkList.tsx b/...ntegrations/sentry/components/SdkList.tsx → ...ntegrations/sentry/components/SdkList.tsx
diff --git a/...rations/sentry/components/SpanDetails.tsx → ...rations/sentry/components/SpanDetails.tsx b/...rations/sentry/components/SpanDetails.tsx → ...rations/sentry/components/SpanDetails.tsx
diff --git a/...tegrations/sentry/components/SpanTree.tsx → ...tegrations/sentry/components/SpanTree.tsx b/...tegrations/sentry/components/SpanTree.tsx → ...tegrations/sentry/components/SpanTree.tsx
diff --git a/...c/integrations/sentry/components/Time.tsx → ...c/integrations/sentry/components/Time.tsx b/...c/integrations/sentry/components/Time.tsx → ...c/integrations/sentry/components/Time.tsx
diff --git a/...egrations/sentry/components/TimeSince.tsx → ...egrations/sentry/components/TimeSince.tsx b/...egrations/sentry/components/TimeSince.tsx → ...egrations/sentry/components/TimeSince.tsx
diff --git a/...ations/sentry/components/TraceDetails.tsx → ...ations/sentry/components/TraceDetails.tsx b/...ations/sentry/components/TraceDetails.tsx → ...ations/sentry/components/TraceDetails.tsx
diff --git a/...egrations/sentry/components/TraceList.tsx → ...egrations/sentry/components/TraceList.tsx b/...egrations/sentry/components/TraceList.tsx → ...egrations/sentry/components/TraceList.tsx
diff --git a/...tions/sentry/data/sentryDataCache.test.ts → ...tions/sentry/data/sentryDataCache.test.ts b/...tions/sentry/data/sentryDataCache.test.ts → ...tions/sentry/data/sentryDataCache.test.ts
diff --git a/...tegrations/sentry/data/sentryDataCache.ts → ...tegrations/sentry/data/sentryDataCache.ts b/...tegrations/sentry/data/sentryDataCache.ts → ...tegrations/sentry/data/sentryDataCache.ts
diff --git a/...tions/sentry/data/sentryEventsContext.tsx → ...tions/sentry/data/sentryEventsContext.tsx b/...tions/sentry/data/sentryEventsContext.tsx → ...tions/sentry/data/sentryEventsContext.tsx
diff --git a/...egrations/sentry/data/useSentryEvents.tsx → ...egrations/sentry/data/useSentryEvents.tsx b/...egrations/sentry/data/useSentryEvents.tsx → ...egrations/sentry/data/useSentryEvents.tsx
diff --git a/...integrations/sentry/data/useSentrySdks.ts → ...integrations/sentry/data/useSentrySdks.ts b/...integrations/sentry/data/useSentrySdks.ts → ...integrations/sentry/data/useSentrySdks.ts
diff --git a/...tegrations/sentry/data/useSentryTraces.ts → ...tegrations/sentry/data/useSentryTraces.ts b/...tegrations/sentry/data/useSentryTraces.ts → ...tegrations/sentry/data/useSentryTraces.ts
diff --git a/...ore/src/integrations/sentry/index.test.ts → ...lay/src/integrations/sentry/index.test.ts b/...ore/src/integrations/sentry/index.test.ts → ...lay/src/integrations/sentry/index.test.ts
diff --git a/...ges/core/src/integrations/sentry/index.ts → .../overlay/src/integrations/sentry/index.ts b/...ges/core/src/integrations/sentry/index.ts → .../overlay/src/integrations/sentry/index.ts
diff --git a/...integrations/sentry/sentry-integration.ts → ...integrations/sentry/sentry-integration.ts b/...integrations/sentry/sentry-integration.ts → ...integrations/sentry/sentry-integration.ts
diff --git a/...rc/integrations/sentry/tabs/ErrorsTab.tsx → ...rc/integrations/sentry/tabs/ErrorsTab.tsx b/...rc/integrations/sentry/tabs/ErrorsTab.tsx → ...rc/integrations/sentry/tabs/ErrorsTab.tsx
diff --git a/.../src/integrations/sentry/tabs/SdksTab.tsx → .../src/integrations/sentry/tabs/SdksTab.tsx b/.../src/integrations/sentry/tabs/SdksTab.tsx → .../src/integrations/sentry/tabs/SdksTab.tsx
diff --git a/...rc/integrations/sentry/tabs/TracesTab.tsx → ...rc/integrations/sentry/tabs/TracesTab.tsx b/...rc/integrations/sentry/tabs/TracesTab.tsx → ...rc/integrations/sentry/tabs/TracesTab.tsx
diff --git a/...ges/core/src/integrations/sentry/types.ts → .../overlay/src/integrations/sentry/types.ts b/...ges/core/src/integrations/sentry/types.ts → .../overlay/src/integrations/sentry/types.ts
diff --git a/...src/integrations/sentry/utils/duration.ts → ...src/integrations/sentry/utils/duration.ts b/...src/integrations/sentry/utils/duration.ts → ...src/integrations/sentry/utils/duration.ts
diff --git a/.../integrations/sentry/utils/traces.test.ts → .../integrations/sentry/utils/traces.test.ts b/.../integrations/sentry/utils/traces.test.ts → .../integrations/sentry/utils/traces.test.ts
diff --git a/...e/src/integrations/sentry/utils/traces.ts → ...y/src/integrations/sentry/utils/traces.ts b/...e/src/integrations/sentry/utils/traces.ts → ...y/src/integrations/sentry/utils/traces.ts
diff --git a/...re/src/integrations/vite-inspect/index.ts → ...ay/src/integrations/vite-inspect/index.ts b/...re/src/integrations/vite-inspect/index.ts → ...ay/src/integrations/vite-inspect/index.ts
diff --git a/...ntegrations/vite-inspect/vite-inspect.tsx → ...ntegrations/vite-inspect/vite-inspect.tsx b/...ntegrations/vite-inspect/vite-inspect.tsx → ...ntegrations/vite-inspect/vite-inspect.tsx
diff --git a/packages/core/src/lib/classNames.ts → packages/overlay/src/lib/classNames.ts b/packages/core/src/lib/classNames.ts → packages/overlay/src/lib/classNames.ts
diff --git a/packages/core/src/lib/eventTarget.ts → packages/overlay/src/lib/eventTarget.ts b/packages/core/src/lib/eventTarget.ts → packages/overlay/src/lib/eventTarget.ts
diff --git a/packages/core/src/lib/logger.ts → packages/overlay/src/lib/logger.ts b/packages/core/src/lib/logger.ts → packages/overlay/src/lib/logger.ts
diff --git a/packages/core/src/lib/useKeyPress.ts → packages/overlay/src/lib/useKeyPress.ts b/packages/core/src/lib/useKeyPress.ts → packages/overlay/src/lib/useKeyPress.ts
diff --git a/packages/core/src/lib/uuid.ts → packages/overlay/src/lib/uuid.ts b/packages/core/src/lib/uuid.ts → packages/overlay/src/lib/uuid.ts
diff --git a/packages/core/src/sidecar.ts → packages/overlay/src/sidecar.ts b/packages/core/src/sidecar.ts → packages/overlay/src/sidecar.ts
diff --git a/packages/core/src/types.ts → packages/overlay/src/types.ts b/packages/core/src/types.ts → packages/overlay/src/types.ts
diff --git a/packages/core/src/vite-env.d.ts → packages/overlay/src/vite-env.d.ts b/packages/core/src/vite-env.d.ts → packages/overlay/src/vite-env.d.ts
diff --git a/packages/core/tailwind.config.js → packages/overlay/tailwind.config.js b/packages/core/tailwind.config.js → packages/overlay/tailwind.config.js
diff --git a/packages/core/tsconfig.json → packages/overlay/tsconfig.json b/packages/core/tsconfig.json → packages/overlay/tsconfig.json
diff --git a/packages/core/tsconfig.node.json → packages/overlay/tsconfig.node.json b/packages/core/tsconfig.node.json → packages/overlay/tsconfig.node.json
diff --git a/packages/core/vite.config.ts → packages/overlay/vite.config.ts b/packages/core/vite.config.ts → packages/overlay/vite.config.ts
diff --git a/packages/core/vitest.config.ts → packages/overlay/vitest.config.ts b/packages/core/vitest.config.ts → packages/overlay/vitest.config.ts
diff --git a/packages/website/package.json b/packages/website/package.json
@@ -20,7 +20,7 @@
  "@fontsource/raleway": "^5.0.15",
  "@sentry/astro": "^7.81.1",
  "@spotlightjs/astro": "workspace:*",
- "@spotlightjs/core": "workspace:*",
+ "@spotlightjs/overlay": "workspace:*",
  "@types/react": "^18.2.38",
  "@types/react-dom": "^18.2.17",
  "astro": "^3.6.0",

diff --git a/packages/website/src/components/codeblock.mdx b/packages/website/src/components/codeblock.mdx
@@ -3,7 +3,7 @@ title: Setup Codeblock
 ---
 
 ```ts
-import * as Spotlight from '@spotlightjs/core';
+import * as Spotlight from '@spotlightjs/overlay';
 Spotlight.init();
 ```
 

diff --git a/packages/website/src/content/docs/about.mdx b/packages/website/src/content/docs/about.mdx
@@ -14,7 +14,7 @@ overlay into development environments, and it does it by leveraging the existing
 
 At a high level, Spotlight consists of two components:
 
-1. An overlay (`@spotlightjs/core`) that renders inside of your application. The overlay is a simple React application, and can
+1. An overlay (`@spotlightjs/overlay`) that renders inside of your application. The overlay is a simple React application, and can
  seamlessly run in any web application (or even independently!).
 
 2. A proxy server (`@spotlightjs/sidecar`) which enables push-based communication to the overlay. This is achieved via a simple HTTP relay,
@@ -23,13 +23,13 @@ At a high level, Spotlight consists of two components:
 This means that adoption in most projects is two simple additions:
 
 ```shell
-npm add @spotlightjs/core @spotlightjs/sidecar
+npm add @spotlightjs/overlay @spotlightjs/sidecar
 ```
 
 Registering Spotlight in your frontend application:
 
 ```typescript
-import * as Spotlight from '@spotlightjs/core';
+import * as Spotlight from '@spotlightjs/overlay';
 Spotlight.init();
 ```
 

diff --git a/packages/website/src/content/docs/contribute/index.mdx b/packages/website/src/content/docs/contribute/index.mdx
@@ -28,10 +28,10 @@ pnpm install
 From there you can spin up the Spotlight repo into watch mode:
 
 ```shell
-pnpm dev:core
+pnpm dev:overlay
 ```
 
-Depending on what you're doing there's two paths to develop against the core.
+Depending on what you're doing there's two paths to develop against the overlay.
 
 If you simply want to run Spotlight against the example application, you can spin that up using:
 
@@ -41,17 +41,17 @@ pnpm dev:playground
 
 Additionally you may want to link it into an existing project. This is a little brittle, and we're not experts here, so your mileage may vary.
 
-First, when in the Spotlight root directory, you'll need to link the packages you're referencing (likely `@spotlightjs/core` and `@spotlightjs/sidecar`):
+First, when in the Spotlight root directory, you'll need to link the packages you're referencing (likely `@spotlightjs/overlay` and `@spotlightjs/sidecar`):
 
 ```shell
-pnpm link --global -C packages/core
+pnpm link --global -C packages/overlay
 pnpm link --global -C packages/sidecar
 ```
 
 You can now link these within your project. For example if you're using `pnpm`:
 
 ```shell
-pnpm link --global @spotlightjs/core
+pnpm link --global @spotlightjs/overlay
 pnpm link --global @spotlightjs/sidecar
 ```
 
@@ -62,7 +62,7 @@ The monorepo is mostly straight forward, but here's a quick summary:
 ```
 spotlight
 └── packages 
- ├── core  // @spotlightjs/core  - the main overlay
+ ├── overlay // @spotlightjs/overlay - the main overlay
  ├── sidecar // @spotlightjs/sidecar - the sidecar (proxy) for streaming data
  ├── tsconfig // @spotlightjs/tsconfig - shared tsconfig
  └── website // @spotlightjs/website - the main overlay

diff --git a/packages/website/src/content/docs/reference/configuration.md b/packages/website/src/content/docs/reference/configuration.md
@@ -6,7 +6,7 @@ description: All the configuration options for setting up Spotlight
 ## `init`
 
 ```js
-import {init, sentry} as Spotlight from '@spotlightjs/core';
+import {init, sentry} as Spotlight from '@spotlightjs/overlay';
 
 init({
  integrations: [sentry()],

diff --git a/packages/website/src/content/docs/reference/console.mdx b/packages/website/src/content/docs/reference/console.mdx
@@ -6,7 +6,7 @@ description: Interface of ConsoleIntegration
 The console integration allows you to easily render console logs within Spotlight.
 
 ```ts
-import { init, console } from "@spotlightjs/core";
+import { init, console } from "@spotlightjs/overlay";
 
 init({
  integrations: [console()]

diff --git a/packages/website/src/content/docs/reference/sentry.mdx b/packages/website/src/content/docs/reference/sentry.mdx
@@ -6,7 +6,7 @@ description: Interface of SentryIntegration
 The Sentry integration is the default in Spotlight. It receives events and envelope formats from Sentry SDKs (when configured with `spotlight=true`) and renders those as Errors and Traces in the overlay.
 
 ```ts
-import { init, sentry } from "@spotlightjs/core";
+import { init, sentry } from "@spotlightjs/overlay";
 
 init({
  integrations: [sentry()],

diff --git a/packages/website/src/content/docs/setup/index.mdx b/packages/website/src/content/docs/setup/index.mdx
@@ -15,32 +15,32 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
 
 You'll start by registering the Spotlight package in your existing frontend application.
 
-Install the `@spotlightjs/core` package:
+Install the `@spotlightjs/overlay` package:
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
 
 <Tabs>
  <TabItem label="npm">
  ```sh 
- npm add --save-dev @spotlightjs/core 
+ npm add --save-dev @spotlightjs/overlay 
  ```
  </TabItem>
  <TabItem label="pnpm">
  ```sh 
- pnpm add -D @spotlightjs/core
+ pnpm add -D @spotlightjs/overlay
  ```
  </TabItem>
  <TabItem label="yarn">
  ```sh 
- yarn add @spotlightjs/core -D
+ yarn add @spotlightjs/overlay -D
  ```
  </TabItem>
 </Tabs>
 
 Inject Spotlight into your application:
 
 ```js
-import * as Spotlight from '@spotlightjs/core';
+import * as Spotlight from '@spotlightjs/overlay';
 
 // only load Spotlight in dev
 if (process.env.NODE_ENV !== "production") {