说明文档

csute: 一个帮助你快速搭建和开发前端项目的 CLI

环境要求

• Node.js 版本Node.js 14+

安装:

npm install csute --save-dev
# or
yarn add csute --dev
# or 
pnpm add csute --save-dev

创建项目

目前仅支持 React, vue 正在开发中~ 创建项目

csute create your_project_name

• 选择所需依赖

• 自动拉取项目模板

• 安装项目依赖

• 自动启动项目

• 打开浏览器 http://localhost:8080/

选择框架

• 你可以选择安装项目模版: ? 请选择框架名称

  • React

  • Vue(暂不支持)

选择依赖

你可以选择支持的依赖:

• 是否支持 TS?

• 是否安装 ESLint?(默认安装: eslint、eslint-plugin-react)

  • 注: 安装 ts 默认无 ESlint 选择

• 是否支持 scss?

• 是否支持 less?

React

react 有两个模版, 一为 react js 模板 ,二为 react + ts 模版.

• react + js 版本:

  • 默认配置

  • 常用的目录结构（你可以在此基础上修改）

  • axios（网络请求 axios 的安装以及二次封装）

• react + ts 版本:

  • 常用的目录结构（你可以在此基础上修改）

  • axios（网络请求 axios 的安装以及二次封装）

  • sute库 启动dev build Git

  • 代码规范

  注: ts模板 请务必安装pnpm

模板链接:

js : https://jihulab.com/style1/react_template]

ts: https://jihulab.com/style1/react-template-ts

项目开发

项目开发目前提供三个功能：

• 创建组件

• 创建页面

• 创建 store

创建组件

默认会根据样式 loader 添加的样式文件 index.css(默认) ,index.scss, index.less

csute addcpn YourComponentName
# 例如csute addcpn NavBar，默认会存放到src/components文件夹中
csute addcpn YourComponentName -d src/components/home
# 也可以指定存放的具体文件夹

创建页面

默认会根据样式 loader 添加的样式文件 index.css(默认) ,index.scss, index.less

csute addcpn YourComponentName
# 例如csute addcpn NavBar，默认会存放到src/components文件夹中
csute addcpn YourComponentName -d src/pages/home
# 也可以指定存放的具体文件夹

创建 store

csute addstore YourModuleName
# 例如csute addstore home，默认会放到src/store/modules下
csute addstore YourModuleName -d src/store/modules
# 也可以指定文件夹