Merge pull request #210 from akd-io/feature/202-add-support-for-mantine

akd-io · web-flow · commit d8c310fb654e · 2023-05-27T01:23:43.000+02:00
Add support for Mantine
diff --git a/packages/create-next-stack/README.md b/packages/create-next-stack/README.md
@@ -44,6 +44,7 @@ The table below provides an overview of the technologies currently supported by
 | Sass              | [Website](https://sass-lang.com/) - [Docs](https://sass-lang.com/documentation) - [Next.js-specific docs](https://nextjs.org/docs/basic-features/built-in-css-support#sass-support)                                          |
 | CSS Modules       | [Website](https://github.com/css-modules/css-modules) - [Docs](https://github.com/css-modules/css-modules) - [Next.js-specific docs](https://nextjs.org/docs/basic-features/built-in-css-support#adding-component-level-css) |
 | CSS Modules       | [Website](https://github.com/css-modules/css-modules) - [Docs](https://github.com/css-modules/css-modules) - [Next.js-specific docs](https://nextjs.org/docs/basic-features/built-in-css-support#adding-component-level-css) |
+| Mantine           | [Website](https://mantine.dev/) - [Docs](https://mantine.dev/pages/getting-started/) - [GitHub](https://github.com/mantinedev/mantine)                                                                                       |
 | Chakra UI         | [Website](https://chakra-ui.com/) - [Docs](https://chakra-ui.com/docs/getting-started) - [GitHub](https://github.com/chakra-ui/chakra-ui)                                                                                    |
 | Material UI       | [Website](https://material-ui.com/) - [Docs](https://material-ui.com/getting-started/installation/) - [GitHub](https://github.com/mui-org/material-ui)                                                                       |
 | Framer Motion     | [Website](https://www.framer.com/motion/) - [Docs](https://www.framer.com/docs/) - [GitHub](https://github.com/framer/motion)                                                                                                |
@@ -89,7 +90,10 @@ FLAGS
   --framer-motion               Adds Framer Motion. (Animation library)
   --github-actions              Adds a GitHub Actions continuous integration
                                 workflow.
-  --material-ui                 Adds Material UI. (Component library)
+  --mantine                     Adds Mantine. (Component library) (Requires
+                                Emotion)
+  --material-ui                 Adds Material UI. (Component library) (Requires
+                                Emotion)
   --package-manager=<option>    (required) Sets the preferred package manager.
                                 (Required)
                                 <options: pnpm|yarn|npm>
diff --git a/packages/create-next-stack/src/main/commands/create-next-stack.ts b/packages/create-next-stack/src/main/commands/create-next-stack.ts
@@ -60,9 +60,11 @@ export default class CreateNextStack extends Command {
       description:
         "Adds Chakra UI. (Component library) (Requires Emotion and Framer Motion)",
     }),
-
     "material-ui": Flags.boolean({
-      description: "Adds Material UI. (Component library)",
+      description: "Adds Material UI. (Component library) (Requires Emotion)",
+    }),
+    mantine: Flags.boolean({
+      description: "Adds Mantine. (Component library) (Requires Emotion)",
     }),
 
     // Form libraries:
diff --git a/packages/create-next-stack/src/main/create-next-stack-types.ts b/packages/create-next-stack/src/main/create-next-stack-types.ts
@@ -68,6 +68,11 @@ export const validateFlags = (
       "Chakra UI (category: Component library, flag: --chakra) requires Emotion (category: Styling, flag: --styling=emotion)."
     )
   }
+  if (flags.mantine && flags.styling !== "emotion") {
+    throw new Error(
+      "Mantine (category: Component library, flag: --mantine) requires Emotion (category: Styling, flag: --styling=emotion)."
+    )
+  }
   if (flags["material-ui"] && flags.styling !== "emotion") {
     throw new Error(
       "Material UI (category: Component library, flag: --material-ui) requires Emotion (category: Styling, flag: --styling=emotion)."
diff --git a/packages/create-next-stack/src/main/plugin.ts b/packages/create-next-stack/src/main/plugin.ts
@@ -87,6 +87,12 @@ type PluginConfig = DeeplyReadonly<{
     document?: {
       /** Code to add to the imports section of the _document.tsx file. */
       imports?: string
+      /** Code to add after the imports section of the _document.tsx file. */
+      afterImports?: string
+      /** Code to add to the class members of the Document class in _document.tsx file. */
+      classMembers?: string
+      /** Code to add before the return statement of the Document render function in _document.tsx file. */
+      renderLogic?: string
       /** Code to add to the attributes of the <Html> tag of the _document.tsx file. */
       htmlAttributes?: string
       /** Code to add to the <Head> tag of the _document.tsx file. */
diff --git a/packages/create-next-stack/src/main/plugins/create-next-stack/add-content/pages/generate-document.ts b/packages/create-next-stack/src/main/plugins/create-next-stack/add-content/pages/generate-document.ts
@@ -8,6 +8,18 @@ export const generateDocument = (inputs: ValidCNSInputs): string => {
     .map((plugin) => plugin.slots?.document?.imports)
     .filter(nonNull)
     .join("\n")
+  const afterImports = filterPlugins(inputs)
+    .map((plugin) => plugin.slots?.document?.afterImports)
+    .filter(nonNull)
+    .join("\n")
+  const classMembers = filterPlugins(inputs)
+    .map((plugin) => plugin.slots?.document?.classMembers)
+    .filter(nonNull)
+    .join("\n")
+  const renderLogic = filterPlugins(inputs)
+    .map((plugin) => plugin.slots?.document?.renderLogic)
+    .filter(nonNull)
+    .join("\n")
   const htmlAttributes = filterPlugins(inputs)
     .map((plugin) => plugin.slots?.document?.htmlAttributes)
     .filter(nonNull)
@@ -25,8 +37,13 @@ export const generateDocument = (inputs: ValidCNSInputs): string => {
     import NextDocument, { Html, Head, Main, NextScript } from "next/document";
     ${imports}
 
+    ${afterImports}
+
     export default class Document extends NextDocument {
+      ${classMembers}
+
       render() {
+        ${renderLogic}
         return (
           <Html lang="en" ${htmlAttributes}>
             <Head>
diff --git a/packages/create-next-stack/src/main/plugins/create-next-stack/sort-orders/technologies.ts b/packages/create-next-stack/src/main/plugins/create-next-stack/sort-orders/technologies.ts
@@ -13,6 +13,7 @@ export const technologiesSortOrder: string[] = [
   "tailwindCSS",
   "sass",
   "cssModules",
+  "mantine",
   "chakraUI",
   "materialUI",
   "framerMotion",
diff --git a/packages/create-next-stack/src/main/plugins/mantine/mantine.ts b/packages/create-next-stack/src/main/plugins/mantine/mantine.ts
@@ -0,0 +1,80 @@
+import endent from "endent"
+import { writeFile } from "../../helpers/io"
+import { createPlugin } from "../../plugin"
+import { mantineTheme } from "./setup/mantine-theme"
+
+export const mantinePlugin = createPlugin({
+  id: "mantine",
+  name: "Mantine",
+  description: "Adds support for Mantine",
+  active: ({ flags }) => Boolean(flags.mantine),
+  dependencies: {
+    "@mantine/core": {
+      name: "@mantine/core",
+      version: "^6.0.0",
+    },
+    "@mantine/hooks": {
+      name: "@mantine/hooks",
+      version: "^6.0.0",
+    },
+    "@mantine/next": {
+      name: "@mantine/next",
+      version: "^6.0.0",
+    },
+    "@emotion/server": {
+      name: "@emotion/server",
+      version: "^11.0.0",
+    },
+  },
+  technologies: [
+    {
+      id: "mantine",
+      name: "Mantine",
+      description:
+        "Mantine is a fully featured React component library. Aside from the core package, Mantine also provides additional packages for utility hooks, form state management, date inputs and calendars, notifications, code highlighting, right text editor, and the list goes on.",
+      links: [
+        { title: "Website", url: "https://mantine.dev/" },
+        { title: "Docs", url: "https://mantine.dev/pages/getting-started/" },
+        { title: "GitHub", url: "https://github.com/mantinedev/mantine" },
+      ],
+    },
+  ],
+  steps: {
+    setUpMantine: {
+      id: "setUpMantine",
+      description: "setting up Mantine",
+      run: async () => {
+        await writeFile("mantine-theme.ts", mantineTheme)
+      },
+    },
+  },
+  slots: {
+    app: {
+      imports: endent`
+        import { MantineProvider } from '@mantine/core';
+        import { mantineTheme } from "../mantine-theme";
+      `,
+      componentsStart: endent`
+        <MantineProvider
+          withGlobalStyles
+          withNormalizeCSS
+          theme={mantineTheme}
+        >
+      `,
+      componentsEnd: endent`
+        </MantineProvider>
+      `,
+    },
+    document: {
+      imports: endent`
+        import { createGetInitialProps } from '@mantine/next';
+      `,
+      afterImports: endent`
+        const getInitialProps = createGetInitialProps();
+      `,
+      classMembers: endent`
+        static getInitialProps = getInitialProps;
+      `,
+    },
+  },
+} as const)
diff --git a/packages/create-next-stack/src/main/plugins/mantine/setup/mantine-theme.ts b/packages/create-next-stack/src/main/plugins/mantine/setup/mantine-theme.ts
@@ -0,0 +1,9 @@
+import endent from "endent"
+
+export const mantineTheme = endent`
+  import { MantineThemeOverride } from "@mantine/core";
+
+  export const mantineTheme: MantineThemeOverride = {
+    colorScheme: "light",
+  };
+`
diff --git a/packages/create-next-stack/src/main/plugins/react-query.ts b/packages/create-next-stack/src/main/plugins/react-query.ts
@@ -21,7 +21,7 @@ export const reactQueryPlugin = createPlugin({
       id: "reactQuery",
       name: "React Query",
       description:
-        "React Query is a data fetching library for React. It provides hooks for fetching, caching, and updating asynchronous data in React. It is designed to be flexible and composable, and can be used with any data source.",
+        "React Query, aka. TanStack Query, is a data fetching library that provides hooks for fetching, caching, and updating, remote data. It has a declarative API that makes working with asynchronous data much easier than with previous solutions.",
       links: [
         { title: "Website", url: "https://tanstack.com/query/latest" },
         {
diff --git a/packages/create-next-stack/src/main/setup/plugins.test.ts b/packages/create-next-stack/src/main/setup/plugins.test.ts
@@ -4,11 +4,10 @@ import { plugins } from "./setup"
 test("`plugins` contains no duplicates", () => {
   const seenPluginIDs = new Set<string>()
   for (const plugin of plugins) {
-    if (seenPluginIDs.has(plugin.id)) {
-      throw new Error(
-        `Duplicate plugin with ID "${plugin.id}" found in setup.ts`
-      )
+    const { id } = plugin
+    if (seenPluginIDs.has(id)) {
+      throw new Error(`Duplicate plugin with ID "${id}" found in setup.ts`)
     }
-    seenPluginIDs.add(plugin.id)
+    seenPluginIDs.add(id)
   }
 })
diff --git a/packages/create-next-stack/src/main/setup/setup.ts b/packages/create-next-stack/src/main/setup/setup.ts
@@ -15,6 +15,7 @@ import { formattingPreCommitHookPlugin } from "../plugins/formatting-pre-commit-
 import { formikPlugin } from "../plugins/formik"
 import { framerMotionPlugin } from "../plugins/framer-motion"
 import { githubActionsPlugin } from "../plugins/github-actions"
+import { mantinePlugin } from "../plugins/mantine/mantine"
 import { materialUIPlugin } from "../plugins/material-ui/material-ui"
 import { nextPlugin } from "../plugins/next"
 import { npmPlugin } from "../plugins/npm"
@@ -42,6 +43,7 @@ export const plugins: Plugin[] = [
   tailwindCSSPlugin,
   cssModulesPlugin,
   sassPlugin,
+  mantinePlugin,
   chakraUIPlugin,
   materialUIPlugin,
   reactHookFormPlugin,
diff --git a/packages/create-next-stack/src/main/steps.test.ts b/packages/create-next-stack/src/main/steps.test.ts
@@ -0,0 +1,28 @@
+import { test } from "@jest/globals"
+import { plugins } from "./setup/setup"
+import { steps } from "./steps"
+
+test("`steps` contains no duplicates", () => {
+  const seenSteps = new Set<string>()
+  for (const step of steps) {
+    const { id } = step
+    if (seenSteps.has(id)) {
+      throw new Error(`Duplicate step with ID "${id}" found in steps.ts`)
+    }
+    seenSteps.add(id)
+  }
+})
+
+test("`steps` includes all plugins' steps", () => {
+  const requiredStepIDs = plugins.flatMap((plugin) =>
+    plugin.steps //
+      ? Object.values(plugin.steps).map((step) => step.id)
+      : []
+  )
+  const actualStepIDs = new Set(steps.map((step) => step.id))
+  for (const requiredStepID of requiredStepIDs) {
+    if (!actualStepIDs.has(requiredStepID)) {
+      throw new Error(`Missing step with ID "${requiredStepID}" in steps.ts`)
+    }
+  }
+})
diff --git a/packages/create-next-stack/src/main/steps.ts b/packages/create-next-stack/src/main/steps.ts
@@ -5,6 +5,7 @@ import { cssModulesPlugin } from "./plugins/css-modules/css-modules"
 import { emotionPlugin } from "./plugins/emotion"
 import { formattingPreCommitHookPlugin } from "./plugins/formatting-pre-commit-hook"
 import { githubActionsPlugin } from "./plugins/github-actions"
+import { mantinePlugin } from "./plugins/mantine/mantine"
 import { materialUIPlugin } from "./plugins/material-ui/material-ui"
 import { nextPlugin } from "./plugins/next"
 import { pnpmPlugin } from "./plugins/pnpm"
@@ -49,6 +50,7 @@ export const steps: Step[] = [
   createNextStackPlugin.steps.addReadme,
 
   // Component libraries
+  mantinePlugin.steps.setUpMantine,
   chakraUIPlugin.steps.setUpChakraUI,
   materialUIPlugin.steps.setUpMaterialUI,
 
diff --git a/packages/create-next-stack/src/tests/e2e/test.ts b/packages/create-next-stack/src/tests/e2e/test.ts
@@ -17,6 +17,7 @@ import { testInvalidInputs } from "./tests/test-invalid-inputs"
 import { testNoAppName } from "./tests/test-no-app-name"
 import { testNoFlags } from "./tests/test-no-flags"
 import { testNpm } from "./tests/test-npm"
+import { testPnpm } from "./tests/test-pnpm"
 import { testVersionFlag } from "./tests/test-version-flag"
 import { testYarn } from "./tests/test-yarn"
 ;(async () => {
@@ -42,7 +43,7 @@ import { testYarn } from "./tests/test-yarn"
     await testNoAppName(createNextStackDir)
 
     // Package manager tests
-    // pnpm is used in all other tests, so not tested here.
+    await testPnpm(createNextStackDir)
     await testNpm(createNextStackDir)
     await testYarn(createNextStackDir)
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-all-flags.ts
@@ -21,6 +21,7 @@ export const testCssModulesWithSassAllFlags = async (
     "--framer-motion",
     "--formatting-pre-commit-hook",
     "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-all-flags.ts
@@ -21,6 +21,7 @@ export const testCssModulesAllFlags = async (
     "--framer-motion",
     "--formatting-pre-commit-hook",
     "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-all-flags.ts
@@ -14,15 +14,17 @@ export const testEmotionAllFlags = async (
   const args = [
     "--debug",
     "--package-manager=pnpm",
-    "--prettier",
     "--styling=emotion",
+    "--mantine",
+    "--chakra",
     "--material-ui",
     "--react-hook-form",
     "--formik",
     "--framer-motion",
+    "--prettier",
     "--formatting-pre-commit-hook",
-    "--chakra",
     "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-all-flags.ts
@@ -21,6 +21,7 @@ export const testStyledComponentsAllFlags = async (
     "--framer-motion",
     "--formatting-pre-commit-hook",
     "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-all-flags.ts
@@ -21,6 +21,7 @@ export const testTailwindCssAllFlags = async (
     "--framer-motion",
     "--formatting-pre-commit-hook",
     "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-invalid-inputs.ts b/packages/create-next-stack/src/tests/e2e/tests/test-invalid-inputs.ts
@@ -18,11 +18,16 @@ export const testInvalidInputs = async (
     ],
     noStyling: ["--package-manager=npm"],
     noPackageManager: ["--styling=css-modules"],
-    preCommitHookRequiresPrettier: [
+    preCommitHookWithoutPrettier: [
       "--package-manager=pnpm",
       "--styling=css-modules",
       "--formatting-pre-commit-hook",
     ],
+    mantineWithoutEmotion: [
+      "--package-manager=pnpm",
+      "--styling=css-modules",
+      "--mantine",
+    ],
     chakraWithoutEmotion: [
       "--package-manager=pnpm",
       "--styling=css-modules",
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-npm.ts b/packages/create-next-stack/src/tests/e2e/tests/test-npm.ts
@@ -13,14 +13,17 @@ export const testNpm = async (createNextStackDir: string): Promise<void> => {
   const args = [
     "--debug",
     "--package-manager=npm",
-    "--prettier",
     "--styling=emotion",
+    "--mantine",
+    "--chakra",
     "--material-ui",
     "--react-hook-form",
     "--formik",
     "--framer-motion",
+    "--prettier",
     "--formatting-pre-commit-hook",
-    "--chakra",
+    "--react-icons",
+    "--react-query",
     ".",
   ]
 
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-pnpm.ts b/packages/create-next-stack/src/tests/e2e/tests/test-pnpm.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-yarn.ts b/packages/create-next-stack/src/tests/e2e/tests/test-yarn.ts
diff --git a/website/templates/LandingPage/components/TechnologiesForm.tsx b/website/templates/LandingPage/components/TechnologiesForm.tsx

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,11 @@ export const validateFlags = (`
`68`	`68`	`"Chakra UI (category: Component library, flag: --chakra) requires Emotion (category: Styling, flag: --styling=emotion)."`
`69`	`69`	`)`
`70`	`70`	`}`
	`71`	`+ if (flags.mantine && flags.styling !== "emotion") {`
	`72`	`+ throw new Error(`
	`73`	`+ "Mantine (category: Component library, flag: --mantine) requires Emotion (category: Styling, flag: --styling=emotion)."`
	`74`	`+ )`
	`75`	`+ }`
`71`	`76`	`if (flags["material-ui"] && flags.styling !== "emotion") {`
`72`	`77`	`throw new Error(`
`73`	`78`	`"Material UI (category: Component library, flag: --material-ui) requires Emotion (category: Styling, flag: --styling=emotion)."`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ export const reactQueryPlugin = createPlugin({`
`21`	`21`	`id: "reactQuery",`
`22`	`22`	`name: "React Query",`
`23`	`23`	`description:`
`24`		`- "React Query is a data fetching library for React. It provides hooks for fetching, caching, and updating asynchronous data in React. It is designed to be flexible and composable, and can be used with any data source.",`
	`24`	`+ "React Query, aka. TanStack Query, is a data fetching library that provides hooks for fetching, caching, and updating, remote data. It has a declarative API that makes working with asynchronous data much easier than with previous solutions.",`
`25`	`25`	`links: [`
`26`	`26`	`{ title: "Website", url: "https://tanstack.com/query/latest" },`
`27`	`27`	`{`