Move admin-theme into admin package

vivid-planet · Feb 25, 2025 · 3defad9 · 3defad9
1 parent 0d53f53
commit 3defad9
Show file tree

Hide file tree

Showing 92 changed files with 55 additions and 1,131 deletions.
diff --git a/.changeset/lazy-pears-shout.md b/.changeset/lazy-pears-shout.md
@@ -0,0 +1,27 @@
+---
+"@comet/admin-theme": major
+"@comet/admin": major
+---
+
+Remove the `@comet/admin-theme` package and move all of its exports into `@comet/admin`
+
+This includes the following values and functions: `breakpointsOptions`, `breakpointValues`, `createCometTheme`, `createTypographyOptions`, `errorPalette`, `greyPalette`, `infoPalette`, `paletteOptions`, `primaryPalette`, `shadows`, `successPalette`, `warningPalette`.
+
+**Migrating your project**
+
+1. Remove the `@comet/admin-theme` dependency from your project
+
+2. Change all imports from `@comet/admin-theme` to `@comet/admin`
+
+```diff
+-import { createCometTheme } from "@comet/admin-theme";
++import { createCometTheme } from "@comet/admin";
+
+ const theme = createCometTheme();
+```
+
+3. Remove the no longer required type overrides that were previously required for the custom `Typography` variants, typically located in `admin/src/vendors.d.ts`
+
+```diff
+-/// <reference types="@comet/admin-theme" />
+```
diff --git a/demo/admin/package.json b/demo/admin/package.json
@@ -27,7 +27,6 @@
         "@comet/admin": "workspace:*",
         "@comet/admin-date-time": "workspace:*",
         "@comet/admin-icons": "workspace:*",
-        "@comet/admin-theme": "workspace:*",
         "@comet/cms-admin": "workspace:*",
         "@emotion/react": "^11.14.0",
         "@emotion/styled": "^11.14.0",

diff --git a/demo/admin/src/theme.ts b/demo/admin/src/theme.ts
@@ -1,3 +1,3 @@
-import { createCometTheme } from "@comet/admin-theme";
+import { createCometTheme } from "@comet/admin";
 
 export const theme = createCometTheme();
diff --git a/demo/admin/src/vendors.d.ts b/demo/admin/src/vendors.d.ts
@@ -1,5 +1,4 @@
 /// <reference types="vite/client" />
-/// <reference types="@comet/admin-theme" />
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 declare module "*.svg" {

diff --git a/demo/admin/vite.config.mts b/demo/admin/vite.config.mts
@@ -20,7 +20,6 @@ const adminPackagesHotReloadPlugin: Plugin = {
         this.addWatchFile("../../packages/admin/admin-icons/src");
         this.addWatchFile("../../packages/admin/admin-react-select/src");
         this.addWatchFile("../../packages/admin/admin-rte/src");
-        this.addWatchFile("../../packages/admin/admin-theme/src");
         this.addWatchFile("../../packages/admin/blocks-admin/src");
         this.addWatchFile("../../packages/admin/cms-admin/src");
     },
@@ -91,14 +90,7 @@ export default defineConfig(({ mode }) => {
                     global: "globalThis",
                 },
             },
-            include: [
-                "@comet/admin",
-                "@comet/admin-rte",
-                "@comet/admin-date-time",
-                "@comet/admin-icons",
-                "@comet/admin-theme",
-                "@comet/cms-admin",
-            ],
+            include: ["@comet/admin", "@comet/admin-rte", "@comet/admin-date-time", "@comet/admin-icons", "@comet/cms-admin"],
         },
         resolve: {
             alias: {
@@ -109,4 +101,4 @@ export default defineConfig(({ mode }) => {
             outDir: "build",
         },
     };
-});
+});
diff --git a/dev-pm.config.js b/dev-pm.config.js
@@ -4,7 +4,6 @@ const packageFolderMapping = {
     "@comet/admin-date-time": "packages/admin/admin-date-time",
     "@comet/admin-icons": "packages/admin/admin-icons",
     "@comet/admin-rte": "packages/admin/admin-rte",
-    "@comet/admin-theme": "packages/admin/admin-theme",
     "@comet/cms-admin": "packages/admin/cms-admin",
     "@comet/cms-api": "packages/api/cms-api",
     "@comet/cms-site": "packages/site/cms-site",
@@ -45,31 +44,25 @@ module.exports = {
             script: "pnpm --filter @comet/admin-rte run start",
             group: ["comet-admin"],
         },
-        {
-            name: "comet-admin-theme",
-            script: "pnpm --filter @comet/admin-theme run start",
-            group: ["comet-admin"],
-            waitOn: waitOnPackages("@comet/admin-icons", "@comet/admin-rte", "@comet/admin", "@comet/admin-color-picker"),
-        },
 
         // group cms-admin
         {
             name: "cms-admin",
             script: "pnpm --filter @comet/cms-admin run start",
             group: ["cms-admin", "cms"],
-            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte", "@comet/admin-theme"),
+            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte"),
         },
         {
             name: "cms-admin-codegen-graphql-types",
             script: "pnpm --filter @comet/cms-admin run generate-graphql-types:watch",
             group: ["cms-admin", "cms"],
-            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte", "@comet/admin-theme"),
+            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte"),
         },
         {
             name: "cms-admin-codegen-block-types",
             script: "pnpm --filter @comet/cms-admin run generate-block-types:watch",
             group: ["cms-admin", "cms"],
-            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte", "@comet/admin-theme"),
+            waitOn: waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte"),
         },
 
         //group cms-api
@@ -107,7 +100,7 @@ module.exports = {
             script: "pnpm --filter comet-demo-admin run start",
             group: ["demo-admin", "demo"],
             waitOn: [
-                ...waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte", "@comet/admin-theme", "@comet/cms-admin"),
+                ...waitOnPackages("@comet/admin", "@comet/admin-icons", "@comet/admin-rte", "@comet/cms-admin"),
                 "tcp:$API_PORT",
             ],
         },

diff --git a/docs/docs/5-admin-components/components/Typography.mdx b/docs/docs/5-admin-components/components/Typography.mdx
@@ -6,21 +6,11 @@ Use the [Typography](https://mui.com/material-ui/react-typography/) component pr
 
 ## Custom variants
 
-`@comet/admin-theme` defines two custom `Typography` variants:
+The theme from `@comet/admin` defines two custom `Typography` variants:
 
 - `list`
 - `listItem`
 
 You can use them to display lists in continuous text:
 
 <Story path="Typography" />
-
-### TypeScript
-
-You must tell TypeScript to include the type overrides defined in `@comet/admin-theme`.
-Otherwise, you will get a type error when trying to use the custom variants.
-You can do that by adding the following snippet to your `src/vendors.d.ts` file:
-
-```ts
-/// <reference types="@comet/admin-theme" />
-```
diff --git a/docs/package.json b/docs/package.json
@@ -37,7 +37,6 @@
         "@comet/admin-date-time": "workspace:*",
         "@comet/admin-icons": "workspace:*",
         "@comet/admin-rte": "workspace:*",
-        "@comet/admin-theme": "workspace:*",
         "@docusaurus/core": "^3.7.0",
         "@docusaurus/preset-classic": "^3.7.0",
         "@docusaurus/theme-common": "^3.7.0",

diff --git a/docs/src/components/Story.tsx b/docs/src/components/Story.tsx
@@ -1,4 +1,3 @@
-import { createCometTheme } from "@comet/admin-theme";
 import BrowserOnly from "@docusaurus/BrowserOnly";
 import CodeBlock from "@theme/CodeBlock";
 import type { Props as PlaygroundProps } from "@theme/Playground";
@@ -16,7 +15,6 @@ const importStory = async (name: string) => {
 };
 
 export const Story = ({ path, ...props }: StoryProps) => {
-    const theme = createCometTheme();
     const [code, setCode] = useState("");
 
     useEffect(() => {
@@ -29,7 +27,9 @@ export const Story = ({ path, ...props }: StoryProps) => {
                 // https://docusaurus.io/docs/docusaurus-core/#browseronly
 
                 // eslint-disable-next-line @typescript-eslint/no-require-imports
-                const { MuiThemeProvider } = require("@comet/admin");
+                const { createCometTheme, MuiThemeProvider } = require("@comet/admin");
+
+                const theme = createCometTheme();
 
                 return (
                     <IntlProvider locale="en">

diff --git a/docs/src/stories/customization-and-styling/OverridingStylesOfAComponentGlobally.tsx b/docs/src/stories/customization-and-styling/OverridingStylesOfAComponentGlobally.tsx
@@ -1,5 +1,4 @@
-import { ContentOverflow, MuiThemeProvider } from "@comet/admin";
-import { createCometTheme } from "@comet/admin-theme";
+import { ContentOverflow, createCometTheme, MuiThemeProvider } from "@comet/admin";
 import { Typography } from "@mui/material";
 
 function Story() {

diff --git a/docs/src/stories/customization-and-styling/SettingDefaultPropsOfAComponent.tsx b/docs/src/stories/customization-and-styling/SettingDefaultPropsOfAComponent.tsx
@@ -1,6 +1,5 @@
-import { ContentOverflow, MuiThemeProvider } from "@comet/admin";
+import { ContentOverflow, createCometTheme, MuiThemeProvider } from "@comet/admin";
 import { Preview } from "@comet/admin-icons";
-import { createCometTheme } from "@comet/admin-theme";
 import { Typography } from "@mui/material";
 
 function Story() {

diff --git a/docs/src/theme/ReactLiveScope/index.js b/docs/src/theme/ReactLiveScope/index.js
@@ -53,8 +53,6 @@ if (ExecutionEnvironment.canUseDOM) {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     const cometAdminColorPickerImports = require("@comet/admin-color-picker");
     // eslint-disable-next-line @typescript-eslint/no-require-imports
-    const cometAdminThemeImports = require("@comet/admin-theme");
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const { Card, CardContent, FormControlLabel, Grid, Chip, IconButton, Typography, Box } = require("@mui/material");
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     const { Form } = require("react-final-form");
@@ -84,10 +82,6 @@ if (ExecutionEnvironment.canUseDOM) {
             name: "@comet/admin-color-picker",
             imports: cometAdminColorPickerImports,
         },
-        {
-            name: "@comet/admin-theme",
-            imports: cometAdminThemeImports,
-        },
         {
             name: "@mui/material",
             imports: { Card, CardContent, FormControlLabel, Grid, Chip, IconButton, Typography, Box },

diff --git a/knip.json b/knip.json
@@ -41,10 +41,6 @@
             "project": ["./src/**/*.{ts,tsx}"],
             "ignoreDependencies": ["jest-junit", "@mui/x-data-grid-pro"]
         },
-        "packages/admin/admin-theme": {
-            "entry": ["./src/index.ts"],
-            "project": ["./src/**/*.{ts,tsx}"]
-        },
         "packages/admin/admin-color-picker": {
             "entry": ["./src/index.ts"],
             "project": ["./src/**/*.{ts,tsx}"]

diff --git a/packages/admin/admin-theme/.babelrc.json b/packages/admin/admin-theme/.babelrc.json
diff --git a/packages/admin/admin-theme/.npmignore b/packages/admin/admin-theme/.npmignore
diff --git a/packages/admin/admin-theme/.prettierignore b/packages/admin/admin-theme/.prettierignore