create-next-mui 0.0.2 → 0.0.4

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Vikash Kumar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Vikash Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+# create-next-mui 🚀
+
+A blazing-fast, interactive CLI tool to instantly scaffold production-ready **Next.js** applications pre-configured with **Material UI (MUI)**, robust theme providers, and an elite architectural linting layout.
+
+Stop wasting time wiring up Emotion caches, Next.js App Router layout configs, or sorting your imports manually. Launch your next project perfectly in under 10 seconds.
+
+---
+
+## 🚀 Quick Start
+
+You don't need to install anything globally. Just run the following command in your terminal:
+
+```bash
+npx create-next-mui
+```
+
+The interactive prompt engine (powered by `@clack/prompts`) will guide you through naming your project and selecting your preferred flavor.
+
+---
+
+## ✨ Key Features
+
+- **⚡ Modern Architecture:** Built natively on top of the Next.js App Router structure.
+- **🎨 Material UI Ready:** Seamless compilation of MUI components inside Server and Client Components with pre-configured UI themes.
+- **🧩 Dual-Template Architecture:** Full support for both **TypeScript** and **JavaScript** boilerplates.
+- **🧼 Perfectionist Linting Config:** Pre-packaged with **ESLint v9 Flat Config** (`eslint.config.mjs`) utilizing `eslint-plugin-perfectionist` and `eslint-plugin-unused-imports`.
+- **📦 Pure & Lightweight:** Zero bloat. Template files are automatically stripped of development artifacts (`node_modules`, caches) before build deployment.
+
+---
+
+## 📦 Choice of Flavors
+
+During the prompt sequence, you can choose between two completely separate architectures, both fine-tuned for high-performance builds:
+
+1. **TypeScript Template (`next-mui-template-ts`)** – Out-of-the-box strong typing, custom theme module augmentations, and strict `@typescript-eslint` checking.
+2. **JavaScript Template (`next-mui-template-js`)** – Lightweight, clean vanilla ES modern syntax with optimized configuration overhead.
+
+---
+
+## 📐 Generated Project Structure
+
+No matter which path you choose, `create-next-mui` prints out an organized, production-grade layout optimized for scalability:
+
+```text
+my-awesome-app/
+├── src/
+│   ├── app/
+│   │   ├── layout.js/ts      # Handles App Router initialization & MUI Cache Provider
+│   │   └── page.js/ts        # Pre-built home view utilizing responsive MUI layouts
+│   ├── components/           # Reusable global presentation components
+│   └── theme/
+│       ├── index.js/ts       # Deep theme customization (palette, typography, overrides)
+│       └── theme-provider.js # Keeps layout tree hydrations isolated and performant
+├── eslint.config.mjs         # Elite natural line-length linting layout
+├── next.config.js            # Configured optimization vectors
+├── package.json
+└── README.md
+
+```
+
+---
+
+## 🎨 Elite Linting Layout (Perfectionist Grouping)
+
+Both boilerplate environments contain a fine-tuned, strict importing arrangement rule framework using `line-length` natural alpha sorting. Your files are automatically linted and organized cleanly on save down this architectural chain:
+
+1. **React Core APIs** (`react`)
+2. **Next.js Framework Hooks & Context** (`next/*`)
+3. **Material UI Design Tokens & Engine** (`@mui/*`, `@emotion/*`)
+4. **External Third-Party Libraries**
+5. **Internal Layer Architectures** (`@/types`, `@/lib`, `@/components`, `@/theme`)
+
+Say goodbye to disorganized, messy blocks of import statements!
+
+---
+
+## ⚙️ Development Scripts
+
+Once your scaffolding finishes generating, step inside your directory and run the standard lifecycle workflows:
+
+```bash
+# Install dependencies
+npm install
+
+# Boot up local development server
+npm run dev
+
+# Run ESLint validation checks with automated file ordering adjustment
+npm run lint
+
+# Compile production-ready code bundles
+npm run build
+
+```
+
+---
+
+## 🤝 Contributing & Feedback
+
+Issues and pull requests are highly welcome! If you want to expand the templates or suggest additional components, feel free to open an issue or submit a pull request on the official repository.
+
+Maintained with 💻 by [thatonevikash](https://github.com/thatonevikash).
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

package/next-mui-template-js/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.quickSuggestions": {
+    "other": false,
+    "comments": false,
+    "strings": false
+  }
+}

package/next-mui-template-js/.vscode/typescript.code-snippets

@@ -0,0 +1,10 @@
+{
+  "divider": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "---",
+    "body": [
+      "// ---------------------------------------------------------------",
+    ],
+    "description": "insert a divider",
+  },
+}

package/next-mui-template-js/esling.config.mjs

@@ -0,0 +1,90 @@
+import perfectionist from "eslint-plugin-perfectionist";
+import unusedImports from "eslint-plugin-unused-imports";
+import nextTypeScript from "eslint-config-next/typescript";
+import { defineConfig, globalIgnores } from "eslint/config";
+import nextVitals from "eslint-config-next/core-web-vitals";
+
+const eslintConfig = defineConfig([
+  ...nextVitals,
+  ...nextTypeScript,
+  globalIgnores([".next/**", "out/**", "build/**", "next-env.d.ts"]),
+  {
+    plugins: {
+      perfectionist,
+      "unused-imports": unusedImports,
+    },
+    rules: {
+      "unused-imports/no-unused-imports": "error",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "unused-imports/no-unused-vars": [
+        "off",
+        {
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          vars: "all",
+          varsIgnorePattern: "^_",
+        },
+      ],
+      "perfectionist/sort-exports": [1, { order: "asc", type: "line-length" }],
+      "perfectionist/sort-named-imports": [
+        1,
+        { order: "asc", type: "line-length" },
+      ],
+      "perfectionist/sort-named-exports": [
+        1,
+        { order: "asc", type: "line-length" },
+      ],
+      "perfectionist/sort-imports": [
+        "warn",
+        {
+          order: "asc",
+          ignoreCase: true,
+          type: "line-length",
+          specialCharacters: "keep",
+          internalPattern: ["^@/.*"],
+          newlinesBetween: "always",
+          groups: [
+            "style",
+            "react",
+            "next",
+            "mui",
+            "external",
+            "type",
+            "internal-types",
+            "internal-lib",
+            "internal-hooks",
+            "internal-actions",
+            "internal-components",
+            "internal-auth",
+            "internal-routes",
+            "internal-theme",
+            "internal",
+            ["parent", "sibling", "index"],
+            "icons",
+            "object",
+            "unknown",
+          ],
+          customGroups: {
+            value: {
+              react: ["react"],
+              next: ["^next", "^next/.*", "cookies-next"],
+              mui: ["^@mui/.*", "^@emotion/.*"],
+              icons: ["^lucide-react$"],
+              "internal-types": ["^@/types/.*"],
+              "internal-lib": ["^@/lib/.*"],
+              "internal-actions": ["^@/actions/.*"],
+              "internal-hooks": ["^@/hooks/.*"],
+              "internal-components": ["^@/components/.*"],
+              "internal-auth": ["^@/auth/.*"],
+              "internal-routes": ["^@/routes/.*"],
+              "internal-theme": ["^@/theme/.*"],
+            },
+          },
+        },
+      ],
+    },
+  },
+]);
+
+export default eslintConfig;

package/next-mui-template-js/next.config.ts

@@ -0,0 +1,7 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  trailingSlash: true,
+};
+
+export default nextConfig;