From 6f5a479004013aeb4c89f2d2e8c640b8174214cf Mon Sep 17 00:00:00 2001 From: Charlie Brown Date: Wed, 20 Sep 2023 08:53:01 -0500 Subject: [PATCH] Rename browser package to webui (#58) --- README.md | 12 ++++++------ examples/apollo/package.json | 2 +- packages/{browser => webui}/.eslintrc.cjs | 2 +- packages/{browser => webui}/.parcelrc | 0 packages/{browser => webui}/.postcssrc | 0 packages/{browser => webui}/CHANGELOG.md | 2 +- packages/{browser => webui}/jest.config.ts | 0 packages/{browser => webui}/package.json | 4 ++-- packages/{browser => webui}/src/App.tsx | 0 .../src/components/Authorization.tsx | 0 .../src/components/ConnectionStatus.tsx | 0 .../src/components/DebugToolbar.tsx | 0 .../src/components/FiltersAndActions.tsx | 0 .../{browser => webui}/src/components/Header.tsx | 0 .../src/components/KeyValueList.tsx | 0 .../src/components/MainDisplay.tsx | 0 .../src/components/TraceDetail.tsx | 0 .../{browser => webui}/src/components/TraceList.tsx | 0 .../src/components/TraceListItem.tsx | 0 .../{browser => webui}/src/components/ui/Button.tsx | 0 .../{browser => webui}/src/components/ui/Code.tsx | 0 .../src/components/ui/DateTime.tsx | 0 .../src/components/ui/DropDown.tsx | 0 .../{browser => webui}/src/components/ui/Fields.tsx | 0 .../src/components/ui/IconButton.tsx | 0 .../{browser => webui}/src/components/ui/Input.tsx | 0 .../src/components/ui/JsonDisplay.tsx | 0 .../{browser => webui}/src/components/ui/Label.tsx | 0 .../src/components/ui/Loading.tsx | 0 .../src/components/ui/SearchInput.tsx | 0 .../src/components/ui/Section.tsx | 0 .../src/components/ui/XmlDisplay.tsx | 0 .../{browser => webui}/src/components/ui/index.ts | 0 .../src/context/ApplicationContext.tsx | 0 packages/{browser => webui}/src/favicon.png | Bin .../{browser => webui}/src/hooks/useApplication.ts | 0 .../{browser => webui}/src/hooks/useClickAway.ts | 0 .../src/hooks/useKeyboardShortcut.ts | 0 .../{browser => webui}/src/hooks/usePlatform.ts | 0 packages/{browser => webui}/src/index.html | 0 packages/{browser => webui}/src/index.js | 0 .../{browser => webui}/src/model/CollectorClient.ts | 0 packages/{browser => webui}/src/model/mockData.ts | 0 packages/{browser => webui}/src/scripts/start.cjs | 0 .../src/scripts/startCollector.cjs | 0 .../{browser => webui}/src/scripts/startViewer.cjs | 0 .../src/scripts/startViewerDev.cjs | 0 packages/{browser => webui}/src/styles/base.css | 0 packages/{browser => webui}/src/systems/Default.svg | 0 packages/{browser => webui}/src/systems/Default.tsx | 0 packages/{browser => webui}/src/systems/GraphQL.svg | 0 packages/{browser => webui}/src/systems/GraphQL.tsx | 0 packages/{browser => webui}/src/systems/Sanity.svg | 0 packages/{browser => webui}/src/systems/Sanity.tsx | 0 packages/{browser => webui}/src/systems/index.tsx | 0 .../src/types/graphql-prettier.d.ts | 0 packages/{browser => webui}/src/types/index.ts | 0 packages/{browser => webui}/src/utils/index.ts | 0 packages/{browser => webui}/src/utils/utils.test.ts | 0 packages/{browser => webui}/src/utils/utils.ts | 0 packages/{browser => webui}/tailwind.config.js | 0 packages/{browser => webui}/tsconfig.json | 0 62 files changed, 11 insertions(+), 11 deletions(-) rename packages/{browser => webui}/.eslintrc.cjs (93%) rename packages/{browser => webui}/.parcelrc (100%) rename packages/{browser => webui}/.postcssrc (100%) rename packages/{browser => webui}/CHANGELOG.md (92%) rename packages/{browser => webui}/jest.config.ts (100%) rename packages/{browser => webui}/package.json (97%) rename packages/{browser => webui}/src/App.tsx (100%) rename packages/{browser => webui}/src/components/Authorization.tsx (100%) rename packages/{browser => webui}/src/components/ConnectionStatus.tsx (100%) rename packages/{browser => webui}/src/components/DebugToolbar.tsx (100%) rename packages/{browser => webui}/src/components/FiltersAndActions.tsx (100%) rename packages/{browser => webui}/src/components/Header.tsx (100%) rename packages/{browser => webui}/src/components/KeyValueList.tsx (100%) rename packages/{browser => webui}/src/components/MainDisplay.tsx (100%) rename packages/{browser => webui}/src/components/TraceDetail.tsx (100%) rename packages/{browser => webui}/src/components/TraceList.tsx (100%) rename packages/{browser => webui}/src/components/TraceListItem.tsx (100%) rename packages/{browser => webui}/src/components/ui/Button.tsx (100%) rename packages/{browser => webui}/src/components/ui/Code.tsx (100%) rename packages/{browser => webui}/src/components/ui/DateTime.tsx (100%) rename packages/{browser => webui}/src/components/ui/DropDown.tsx (100%) rename packages/{browser => webui}/src/components/ui/Fields.tsx (100%) rename packages/{browser => webui}/src/components/ui/IconButton.tsx (100%) rename packages/{browser => webui}/src/components/ui/Input.tsx (100%) rename packages/{browser => webui}/src/components/ui/JsonDisplay.tsx (100%) rename packages/{browser => webui}/src/components/ui/Label.tsx (100%) rename packages/{browser => webui}/src/components/ui/Loading.tsx (100%) rename packages/{browser => webui}/src/components/ui/SearchInput.tsx (100%) rename packages/{browser => webui}/src/components/ui/Section.tsx (100%) rename packages/{browser => webui}/src/components/ui/XmlDisplay.tsx (100%) rename packages/{browser => webui}/src/components/ui/index.ts (100%) rename packages/{browser => webui}/src/context/ApplicationContext.tsx (100%) rename packages/{browser => webui}/src/favicon.png (100%) rename packages/{browser => webui}/src/hooks/useApplication.ts (100%) rename packages/{browser => webui}/src/hooks/useClickAway.ts (100%) rename packages/{browser => webui}/src/hooks/useKeyboardShortcut.ts (100%) rename packages/{browser => webui}/src/hooks/usePlatform.ts (100%) rename packages/{browser => webui}/src/index.html (100%) rename packages/{browser => webui}/src/index.js (100%) rename packages/{browser => webui}/src/model/CollectorClient.ts (100%) rename packages/{browser => webui}/src/model/mockData.ts (100%) rename packages/{browser => webui}/src/scripts/start.cjs (100%) rename packages/{browser => webui}/src/scripts/startCollector.cjs (100%) rename packages/{browser => webui}/src/scripts/startViewer.cjs (100%) rename packages/{browser => webui}/src/scripts/startViewerDev.cjs (100%) rename packages/{browser => webui}/src/styles/base.css (100%) rename packages/{browser => webui}/src/systems/Default.svg (100%) rename packages/{browser => webui}/src/systems/Default.tsx (100%) rename packages/{browser => webui}/src/systems/GraphQL.svg (100%) rename packages/{browser => webui}/src/systems/GraphQL.tsx (100%) rename packages/{browser => webui}/src/systems/Sanity.svg (100%) rename packages/{browser => webui}/src/systems/Sanity.tsx (100%) rename packages/{browser => webui}/src/systems/index.tsx (100%) rename packages/{browser => webui}/src/types/graphql-prettier.d.ts (100%) rename packages/{browser => webui}/src/types/index.ts (100%) rename packages/{browser => webui}/src/utils/index.ts (100%) rename packages/{browser => webui}/src/utils/utils.test.ts (100%) rename packages/{browser => webui}/src/utils/utils.ts (100%) rename packages/{browser => webui}/tailwind.config.js (100%) rename packages/{browser => webui}/tsconfig.json (100%) diff --git a/README.md b/README.md index 712d3b8..07b5222 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,13 @@ ## Getting Started -### 1. Install the Envy Browser to view application telemetry in your browser +### 1. Install the Envy Web UI to view application telemetry in your browser ```sh # npm -$ npm i --save-dev @envy/browser +$ npm i --save-dev @envy/webui # or yarn -$ yarn add --dev @envy/browser +$ yarn add --dev @envy/webui ``` ### 2. Install a telemetry package for your application @@ -34,12 +34,12 @@ $ yarn add --dev @envy/browser - [Node.js Application](#nodejs-application) - [Web Client Application](#web-client-application) -### 3. Run the browser and start collecting telemetry +### 3. Run the Web UI and start collecting telemetry Run the browser in a seperate terminal session ``` -npx @envy/browser +npx @envy/webui ``` or optionally, add it to your NPM scripts using a tool like [concurrently](https://www.npmjs.com/package/concurrently) @@ -47,7 +47,7 @@ or optionally, add it to your NPM scripts using a tool like [concurrently](https ```json "scripts": { "start": "", - "start:withenvy": "concurrently \"npx @envy/browser\" \"npm start\"" + "start:withenvy": "concurrently \"npx @envy/webui\" \"npm start\"" }, ``` diff --git a/examples/apollo/package.json b/examples/apollo/package.json index 15147d9..fbb5024 100644 --- a/examples/apollo/package.json +++ b/examples/apollo/package.json @@ -9,7 +9,7 @@ }, "dependencies": { "@apollo/server": "^4.9.3", - "@envy/browser": "*", + "@envy/webui": "*", "@envy/node": "*", "@sanity/client": "^4.0.1", "apollo-utilities": "^1.3.4", diff --git a/packages/browser/.eslintrc.cjs b/packages/webui/.eslintrc.cjs similarity index 93% rename from packages/browser/.eslintrc.cjs rename to packages/webui/.eslintrc.cjs index a7ced15..257837e 100644 --- a/packages/browser/.eslintrc.cjs +++ b/packages/webui/.eslintrc.cjs @@ -12,7 +12,7 @@ module.exports = { }, 'import/resolver': { typescript: { - project: 'packages/browser/tsconfig.json', + project: 'packages/webui/tsconfig.json', }, alias: [['@', path.resolve(__dirname, './src')]], }, diff --git a/packages/browser/.parcelrc b/packages/webui/.parcelrc similarity index 100% rename from packages/browser/.parcelrc rename to packages/webui/.parcelrc diff --git a/packages/browser/.postcssrc b/packages/webui/.postcssrc similarity index 100% rename from packages/browser/.postcssrc rename to packages/webui/.postcssrc diff --git a/packages/browser/CHANGELOG.md b/packages/webui/CHANGELOG.md similarity index 92% rename from packages/browser/CHANGELOG.md rename to packages/webui/CHANGELOG.md index 2b7948c..61d43d1 100644 --- a/packages/browser/CHANGELOG.md +++ b/packages/webui/CHANGELOG.md @@ -1,4 +1,4 @@ -# @envy/browser +# @envy/webui ## 0.1.1 diff --git a/packages/browser/jest.config.ts b/packages/webui/jest.config.ts similarity index 100% rename from packages/browser/jest.config.ts rename to packages/webui/jest.config.ts diff --git a/packages/browser/package.json b/packages/webui/package.json similarity index 97% rename from packages/browser/package.json rename to packages/webui/package.json index 9932991..ce60ba4 100644 --- a/packages/browser/package.json +++ b/packages/webui/package.json @@ -1,5 +1,5 @@ { - "name": "@envy/browser", + "name": "@envy/webui", "version": "0.1.1", "description": "Envy Web UI", "source": [ @@ -66,7 +66,7 @@ ], "staticFiles": { "staticPath": [ - "packages/browser/static" + "packages/webui/static" ] } } diff --git a/packages/browser/src/App.tsx b/packages/webui/src/App.tsx similarity index 100% rename from packages/browser/src/App.tsx rename to packages/webui/src/App.tsx diff --git a/packages/browser/src/components/Authorization.tsx b/packages/webui/src/components/Authorization.tsx similarity index 100% rename from packages/browser/src/components/Authorization.tsx rename to packages/webui/src/components/Authorization.tsx diff --git a/packages/browser/src/components/ConnectionStatus.tsx b/packages/webui/src/components/ConnectionStatus.tsx similarity index 100% rename from packages/browser/src/components/ConnectionStatus.tsx rename to packages/webui/src/components/ConnectionStatus.tsx diff --git a/packages/browser/src/components/DebugToolbar.tsx b/packages/webui/src/components/DebugToolbar.tsx similarity index 100% rename from packages/browser/src/components/DebugToolbar.tsx rename to packages/webui/src/components/DebugToolbar.tsx diff --git a/packages/browser/src/components/FiltersAndActions.tsx b/packages/webui/src/components/FiltersAndActions.tsx similarity index 100% rename from packages/browser/src/components/FiltersAndActions.tsx rename to packages/webui/src/components/FiltersAndActions.tsx diff --git a/packages/browser/src/components/Header.tsx b/packages/webui/src/components/Header.tsx similarity index 100% rename from packages/browser/src/components/Header.tsx rename to packages/webui/src/components/Header.tsx diff --git a/packages/browser/src/components/KeyValueList.tsx b/packages/webui/src/components/KeyValueList.tsx similarity index 100% rename from packages/browser/src/components/KeyValueList.tsx rename to packages/webui/src/components/KeyValueList.tsx diff --git a/packages/browser/src/components/MainDisplay.tsx b/packages/webui/src/components/MainDisplay.tsx similarity index 100% rename from packages/browser/src/components/MainDisplay.tsx rename to packages/webui/src/components/MainDisplay.tsx diff --git a/packages/browser/src/components/TraceDetail.tsx b/packages/webui/src/components/TraceDetail.tsx similarity index 100% rename from packages/browser/src/components/TraceDetail.tsx rename to packages/webui/src/components/TraceDetail.tsx diff --git a/packages/browser/src/components/TraceList.tsx b/packages/webui/src/components/TraceList.tsx similarity index 100% rename from packages/browser/src/components/TraceList.tsx rename to packages/webui/src/components/TraceList.tsx diff --git a/packages/browser/src/components/TraceListItem.tsx b/packages/webui/src/components/TraceListItem.tsx similarity index 100% rename from packages/browser/src/components/TraceListItem.tsx rename to packages/webui/src/components/TraceListItem.tsx diff --git a/packages/browser/src/components/ui/Button.tsx b/packages/webui/src/components/ui/Button.tsx similarity index 100% rename from packages/browser/src/components/ui/Button.tsx rename to packages/webui/src/components/ui/Button.tsx diff --git a/packages/browser/src/components/ui/Code.tsx b/packages/webui/src/components/ui/Code.tsx similarity index 100% rename from packages/browser/src/components/ui/Code.tsx rename to packages/webui/src/components/ui/Code.tsx diff --git a/packages/browser/src/components/ui/DateTime.tsx b/packages/webui/src/components/ui/DateTime.tsx similarity index 100% rename from packages/browser/src/components/ui/DateTime.tsx rename to packages/webui/src/components/ui/DateTime.tsx diff --git a/packages/browser/src/components/ui/DropDown.tsx b/packages/webui/src/components/ui/DropDown.tsx similarity index 100% rename from packages/browser/src/components/ui/DropDown.tsx rename to packages/webui/src/components/ui/DropDown.tsx diff --git a/packages/browser/src/components/ui/Fields.tsx b/packages/webui/src/components/ui/Fields.tsx similarity index 100% rename from packages/browser/src/components/ui/Fields.tsx rename to packages/webui/src/components/ui/Fields.tsx diff --git a/packages/browser/src/components/ui/IconButton.tsx b/packages/webui/src/components/ui/IconButton.tsx similarity index 100% rename from packages/browser/src/components/ui/IconButton.tsx rename to packages/webui/src/components/ui/IconButton.tsx diff --git a/packages/browser/src/components/ui/Input.tsx b/packages/webui/src/components/ui/Input.tsx similarity index 100% rename from packages/browser/src/components/ui/Input.tsx rename to packages/webui/src/components/ui/Input.tsx diff --git a/packages/browser/src/components/ui/JsonDisplay.tsx b/packages/webui/src/components/ui/JsonDisplay.tsx similarity index 100% rename from packages/browser/src/components/ui/JsonDisplay.tsx rename to packages/webui/src/components/ui/JsonDisplay.tsx diff --git a/packages/browser/src/components/ui/Label.tsx b/packages/webui/src/components/ui/Label.tsx similarity index 100% rename from packages/browser/src/components/ui/Label.tsx rename to packages/webui/src/components/ui/Label.tsx diff --git a/packages/browser/src/components/ui/Loading.tsx b/packages/webui/src/components/ui/Loading.tsx similarity index 100% rename from packages/browser/src/components/ui/Loading.tsx rename to packages/webui/src/components/ui/Loading.tsx diff --git a/packages/browser/src/components/ui/SearchInput.tsx b/packages/webui/src/components/ui/SearchInput.tsx similarity index 100% rename from packages/browser/src/components/ui/SearchInput.tsx rename to packages/webui/src/components/ui/SearchInput.tsx diff --git a/packages/browser/src/components/ui/Section.tsx b/packages/webui/src/components/ui/Section.tsx similarity index 100% rename from packages/browser/src/components/ui/Section.tsx rename to packages/webui/src/components/ui/Section.tsx diff --git a/packages/browser/src/components/ui/XmlDisplay.tsx b/packages/webui/src/components/ui/XmlDisplay.tsx similarity index 100% rename from packages/browser/src/components/ui/XmlDisplay.tsx rename to packages/webui/src/components/ui/XmlDisplay.tsx diff --git a/packages/browser/src/components/ui/index.ts b/packages/webui/src/components/ui/index.ts similarity index 100% rename from packages/browser/src/components/ui/index.ts rename to packages/webui/src/components/ui/index.ts diff --git a/packages/browser/src/context/ApplicationContext.tsx b/packages/webui/src/context/ApplicationContext.tsx similarity index 100% rename from packages/browser/src/context/ApplicationContext.tsx rename to packages/webui/src/context/ApplicationContext.tsx diff --git a/packages/browser/src/favicon.png b/packages/webui/src/favicon.png similarity index 100% rename from packages/browser/src/favicon.png rename to packages/webui/src/favicon.png diff --git a/packages/browser/src/hooks/useApplication.ts b/packages/webui/src/hooks/useApplication.ts similarity index 100% rename from packages/browser/src/hooks/useApplication.ts rename to packages/webui/src/hooks/useApplication.ts diff --git a/packages/browser/src/hooks/useClickAway.ts b/packages/webui/src/hooks/useClickAway.ts similarity index 100% rename from packages/browser/src/hooks/useClickAway.ts rename to packages/webui/src/hooks/useClickAway.ts diff --git a/packages/browser/src/hooks/useKeyboardShortcut.ts b/packages/webui/src/hooks/useKeyboardShortcut.ts similarity index 100% rename from packages/browser/src/hooks/useKeyboardShortcut.ts rename to packages/webui/src/hooks/useKeyboardShortcut.ts diff --git a/packages/browser/src/hooks/usePlatform.ts b/packages/webui/src/hooks/usePlatform.ts similarity index 100% rename from packages/browser/src/hooks/usePlatform.ts rename to packages/webui/src/hooks/usePlatform.ts diff --git a/packages/browser/src/index.html b/packages/webui/src/index.html similarity index 100% rename from packages/browser/src/index.html rename to packages/webui/src/index.html diff --git a/packages/browser/src/index.js b/packages/webui/src/index.js similarity index 100% rename from packages/browser/src/index.js rename to packages/webui/src/index.js diff --git a/packages/browser/src/model/CollectorClient.ts b/packages/webui/src/model/CollectorClient.ts similarity index 100% rename from packages/browser/src/model/CollectorClient.ts rename to packages/webui/src/model/CollectorClient.ts diff --git a/packages/browser/src/model/mockData.ts b/packages/webui/src/model/mockData.ts similarity index 100% rename from packages/browser/src/model/mockData.ts rename to packages/webui/src/model/mockData.ts diff --git a/packages/browser/src/scripts/start.cjs b/packages/webui/src/scripts/start.cjs similarity index 100% rename from packages/browser/src/scripts/start.cjs rename to packages/webui/src/scripts/start.cjs diff --git a/packages/browser/src/scripts/startCollector.cjs b/packages/webui/src/scripts/startCollector.cjs similarity index 100% rename from packages/browser/src/scripts/startCollector.cjs rename to packages/webui/src/scripts/startCollector.cjs diff --git a/packages/browser/src/scripts/startViewer.cjs b/packages/webui/src/scripts/startViewer.cjs similarity index 100% rename from packages/browser/src/scripts/startViewer.cjs rename to packages/webui/src/scripts/startViewer.cjs diff --git a/packages/browser/src/scripts/startViewerDev.cjs b/packages/webui/src/scripts/startViewerDev.cjs similarity index 100% rename from packages/browser/src/scripts/startViewerDev.cjs rename to packages/webui/src/scripts/startViewerDev.cjs diff --git a/packages/browser/src/styles/base.css b/packages/webui/src/styles/base.css similarity index 100% rename from packages/browser/src/styles/base.css rename to packages/webui/src/styles/base.css diff --git a/packages/browser/src/systems/Default.svg b/packages/webui/src/systems/Default.svg similarity index 100% rename from packages/browser/src/systems/Default.svg rename to packages/webui/src/systems/Default.svg diff --git a/packages/browser/src/systems/Default.tsx b/packages/webui/src/systems/Default.tsx similarity index 100% rename from packages/browser/src/systems/Default.tsx rename to packages/webui/src/systems/Default.tsx diff --git a/packages/browser/src/systems/GraphQL.svg b/packages/webui/src/systems/GraphQL.svg similarity index 100% rename from packages/browser/src/systems/GraphQL.svg rename to packages/webui/src/systems/GraphQL.svg diff --git a/packages/browser/src/systems/GraphQL.tsx b/packages/webui/src/systems/GraphQL.tsx similarity index 100% rename from packages/browser/src/systems/GraphQL.tsx rename to packages/webui/src/systems/GraphQL.tsx diff --git a/packages/browser/src/systems/Sanity.svg b/packages/webui/src/systems/Sanity.svg similarity index 100% rename from packages/browser/src/systems/Sanity.svg rename to packages/webui/src/systems/Sanity.svg diff --git a/packages/browser/src/systems/Sanity.tsx b/packages/webui/src/systems/Sanity.tsx similarity index 100% rename from packages/browser/src/systems/Sanity.tsx rename to packages/webui/src/systems/Sanity.tsx diff --git a/packages/browser/src/systems/index.tsx b/packages/webui/src/systems/index.tsx similarity index 100% rename from packages/browser/src/systems/index.tsx rename to packages/webui/src/systems/index.tsx diff --git a/packages/browser/src/types/graphql-prettier.d.ts b/packages/webui/src/types/graphql-prettier.d.ts similarity index 100% rename from packages/browser/src/types/graphql-prettier.d.ts rename to packages/webui/src/types/graphql-prettier.d.ts diff --git a/packages/browser/src/types/index.ts b/packages/webui/src/types/index.ts similarity index 100% rename from packages/browser/src/types/index.ts rename to packages/webui/src/types/index.ts diff --git a/packages/browser/src/utils/index.ts b/packages/webui/src/utils/index.ts similarity index 100% rename from packages/browser/src/utils/index.ts rename to packages/webui/src/utils/index.ts diff --git a/packages/browser/src/utils/utils.test.ts b/packages/webui/src/utils/utils.test.ts similarity index 100% rename from packages/browser/src/utils/utils.test.ts rename to packages/webui/src/utils/utils.test.ts diff --git a/packages/browser/src/utils/utils.ts b/packages/webui/src/utils/utils.ts similarity index 100% rename from packages/browser/src/utils/utils.ts rename to packages/webui/src/utils/utils.ts diff --git a/packages/browser/tailwind.config.js b/packages/webui/tailwind.config.js similarity index 100% rename from packages/browser/tailwind.config.js rename to packages/webui/tailwind.config.js diff --git a/packages/browser/tsconfig.json b/packages/webui/tsconfig.json similarity index 100% rename from packages/browser/tsconfig.json rename to packages/webui/tsconfig.json