Skip to content

Commit c949908

Browse files
authored
Merge pull request #39 from amoskyalo/issue_#37_components_scaffold
Fix:Minor fixes
2 parents 7aea546 + 70bf630 commit c949908

File tree

4 files changed

+12
-15
lines changed

4 files changed

+12
-15
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Material-UI CLI is a powerful command-line interface tool designed to signif
3434
## 📦 Installation
3535

3636
```sh
37-
npm install -g mui-cli
37+
npm i -g material-cli
3838
```
3939

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

4646
```sh
47-
mui-cli project-init [options]
47+
material-cli project-init [options]
4848
```
4949

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

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

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

7877
The MUI CLI team is actively exploring the best ways to address these issues promptly to facilitate smoother development.
@@ -82,7 +81,7 @@ The MUI CLI team is actively exploring the best ways to address these issues pro
8281
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:
8382

8483
```sh
85-
mui-cli theme-init [options]
84+
material-cli theme-init [options]
8685
```
8786

8887
The following **options** can be passed to the command:
@@ -104,7 +103,7 @@ The `theme.js` file will be generated under `src > Theme` folder in your project
104103
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:
105104

106105
```sh
107-
mui-cli theme-validate [options]
106+
material-cli theme-validate [options]
108107
```
109108

110109
The following **options** can be passes to the command:

commands/projectInit.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ async function projectInit(projectName, components, architecture, tool, monorepo
3838
// required: true,
3939
// pageSize: 10
4040
// });
41-
42-
41+
// new ComponentGenerator(components, projectName, architecture, tool, monorepoName).generateComponent();
4342
// })()
4443

4544
} catch (error) {

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"name": "material-ui-cli",
2+
"name": "material-cli",
33
"version": "0.0.2",
44
"description": "Build Material UI apps 10x faster with material-ui-cli ⚡",
55
"main": "index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
99
"bin": {
10-
"material-ui": "index.js"
10+
"material-cli": "index.js"
1111
},
1212
"keywords": [
1313
"materialUI",
@@ -27,7 +27,6 @@
2727
"fs-extra": "^11.2.0",
2828
"joi": "^17.12.1"
2929
},
30-
"devDependencies": {},
3130
"repository": {
3231
"type": "git",
3332
"url": "git+https://github.com/amoskyalo/material-UI-CLI.git"

0 commit comments

Comments
 (0)