Skip to content

Fix:Minor fixes #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The Material-UI CLI is a powerful command-line interface tool designed to signif
## 📦 Installation

```sh
npm install -g mui-cli
npm i -g material-cli
```

## 🚀 Usage
Expand All @@ -44,7 +44,7 @@ npm install -g mui-cli
To initialize a new project, first, navigate to the desired folder, then:

```sh
mui-cli project-init [options]
material-cli project-init [options]
```

The available options for the initialization command are:
Expand Down Expand Up @@ -72,7 +72,6 @@ If everything proceeded smoothly, you'll receive a confirmation message indicati

#### The downside of using MUI CLI to initialize your project includes:

- ⚠️ It relies on **CRA (Create React App)**, which might be a drawback for those intending to use other tools like **Vite**.
- ⚠️ The scaffolded MUI components are written in **JavaScript**, which could be a downside for those using **TypeScript**.

The MUI CLI team is actively exploring the best ways to address these issues promptly to facilitate smoother development.
Expand All @@ -82,7 +81,7 @@ The MUI CLI team is actively exploring the best ways to address these issues pro
Ensuring adherence to the correct MUI theming guidelines can sometimes be challenging. With MUI CLI, you can effortlessly generate a theme file that you can then customize to your preferences. To generate a `theme` file for your existing project, simply execute the following command:

```sh
mui-cli theme-init [options]
material-cli theme-init [options]
```

The following **options** can be passed to the command:
Expand All @@ -104,7 +103,7 @@ The `theme.js` file will be generated under `src > Theme` folder in your project
You can easily inspect your theme file to identify any potential errors or warnings that might have been overlooked. To inspect your theme file, simply execute the following command:

```sh
mui-cli theme-validate [options]
material-cli theme-validate [options]
```

The following **options** can be passes to the command:
Expand Down
3 changes: 1 addition & 2 deletions commands/projectInit.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ async function projectInit(projectName, components, architecture, tool, monorepo
// required: true,
// pageSize: 10
// });


// new ComponentGenerator(components, projectName, architecture, tool, monorepoName).generateComponent();
// })()

} catch (error) {
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "material-ui-cli",
"name": "material-cli",
"version": "0.0.2",
"description": "Build Material UI apps 10x faster with material-ui-cli ⚡",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"bin": {
"material-ui": "index.js"
"material-cli": "index.js"
},
"keywords": [
"materialUI",
Expand All @@ -27,7 +27,6 @@
"fs-extra": "^11.2.0",
"joi": "^17.12.1"
},
"devDependencies": {},
"repository": {
"type": "git",
"url": "git+https://github.com/amoskyalo/material-UI-CLI.git"
Expand Down