cli-for-frameworks
v1.0.4
Published
CLI tool to generate components, pages, services, routes for multiple frameworks
Downloads
18
Maintainers
Readme
Dưới đây là phiên bản cập nhật của README với tên CLI là cli-for-framework.
# CLI for Framework
`cli-for-framework` là một công cụ dòng lệnh mạnh mẽ giúp bạn nhanh chóng tạo các component, controller, service, và các file khác cho nhiều framework khác nhau như React, Next.js, Vue, NestJS, Express, v.v.
## Tính năng
- Tạo nhanh các component cho **React**, **Next.js**, **Vue**, **NestJS**, **Express**, **HTML**, **Dart**, **Flutter**, **React Native**.
- Hỗ trợ tạo các file như **controller**, **service**, **DTO** cho **NestJS**, **Express**, **HTML**, **Dart**, **Flutter**, **React Native**.
- Tạo folder và file mới theo cú pháp định dạng dễ dàng.
- Xóa hoặc thay thế các file hiện tại.
## Cài đặt
Để cài đặt công cụ `cli-for-framework`, hãy sử dụng npm hoặc yarn.
Khi bạn đã đẩy package lên npm và cấu hình file `package.json` như trên, để sử dụng công cụ CLI mà bạn đã tạo ra (`js-code-gen-cli`), bạn cần thực hiện theo các bước sau:
### 1. Cài đặt công cụ CLI
Để cài đặt công cụ CLI của bạn, người dùng có thể sử dụng npm hoặc yarn.
- **Cài đặt thông qua npm:**
```bash
npm i -g cli-for-frameworks- Cài đặt thông qua yarn:
yarn global add cli-for-frameworksCông cụ CLI này sẽ được cài đặt trên toàn bộ hệ thống và có thể sử dụng từ bất kỳ đâu trong terminal.
2. Sử dụng công cụ CLI
Sau khi cài đặt, người dùng có thể sử dụng CLI thông qua lệnh code-g (tên lệnh bạn đã định nghĩa trong bin của package.json).
Cú pháp sử dụng CLI:
code-g <action> <component-name> --framework <framework> --path <optional-path>3. Các Lệnh Chính
Dưới đây là một số ví dụ về các lệnh mà người dùng có thể sử dụng:
Tạo Component
Ví dụ để tạo một React component có tên là Card trong thư mục components:
code-g generate(g) Card --framework React --path componentsKết quả sẽ tạo ra cấu trúc như sau:
components/
Card/
Card.tsxTạo Page cho Next.js
Ví dụ tạo một Next.js page có tên là Home trong thư mục pages:
code-g generate(g) Home --framework Next.js --path pagesKết quả sẽ tạo ra cấu trúc như sau:
pages/
Home/
Home.tsxXóa File
Ví dụ xóa file components/Button/Button.tsx:
code-g delete(d) components/Button/Button.tsxThay thế File
Ví dụ thay thế file components/Card/Card.tsx:
code-g replace(r) components/Card/Card.tsx4. Xem Hướng Dẫn Sử Dụng
Nếu người dùng muốn xem hướng dẫn sử dụng lệnh, họ có thể chạy:
code-g --helpĐiều này sẽ hiển thị tất cả các lệnh có sẵn và cú pháp cho từng lệnh.
Tổng kết
Sau khi người dùng cài đặt công cụ thông qua npm hoặc yarn, họ có thể sử dụng lệnh code-g để tạo các component, page, service, controller, và các file khác cho các framework như React, Next.js, Vue, NestJS,Dark, Flutter, React-Native và Express. Họ cũng có thể xóa hoặc thay thế các file đã có bằng cách sử dụng các lệnh tương ứng.
