Appearance
Neos
Neos(奈欧斯)是一个帮助开发者快速地创建 Vue3 应用并自动配置项目编译的脚手架。
配置完整、格式统一, 有点儿意思!
特性
- ⚡️ Vue 3 + Vite 4 (^4.0.4), pnpm(^3.2.45)
- 🗂 Vue Router (^4.1.6) --- 可选配置
- 🍍 使用 Pinia 的状态管理 (^2.0.28) + 数据持久化(^2.1.1) --- 可选配置
- ⛓ 数据请求 (^2.0.6) --- 可选配置
- 📜 支持
H5模版
、PC模版
- 🦾 天然支持 TypeScript (^4.7.4) --- 默认配置
- 🔥 使用 新的
<script setup>
语法 - 🤙🏻 默认开启 响应性语法糖
- ⚓ 自带
useAsync
、useLoading
、useOnline
、useWindowSizeFn
等Hooks - 🔖 自带
SvgIcon
组件 - 🎨 UnoCSS - 高性能且极具灵活性的即时原子化 CSS 引擎 (^0.45.22) --- 可选配置
- 📥 API 自动加载 - 直接使用 Composition API 无需引入 (^0.11.2) --- 可选配置
- 📦 组件自动化加载 (^0.22.5) --- 可选配置
- 📲 PWA (^0.14.1) --- 可选配置
- ✅ 移动端 VConsole 功能 (^1.3.1) --- H5默认添加
- 🔐 https 开发服务提供证书支持vite-plugin-mkcert (^1.11.0) --- 默认配置
- 🏝 SVG Icons支持 (^2.0.1) --- 默认配置
- ⚙️ Vitest 进行单元测试 (^0.26.3) --- 可选配置
- 🖇 代码提交规范 (^17.4.2) --- 默认配置
- 🔬 Commit 校验 (^8.0.3) --- 默认配置
- 🧱 代码检查 (^8.22.0) --- 默认配置
- 💻 统一 VsCode 配置
清单
创建项目成功时,请尝试按照清单正确更新您自己的信息
- 🔘 在
index.html
中改变标题 - 🔘 在
.env.xxxxxx
更改主机名, 更改接口地址, 更改端口号(默认3300)等信息 - 🔘 在
public
目录下改变favicon.ico - 🔘 整理 README
- 🔘 配置路由信息
😃 OK, 完成以上操作, 请愉悦的享受代码吧 👏 🏝
安装
全局安装
Neos
(因为这是脚手架,不是开发依赖项!)
bash
npm install -g @neosjs/cli
npm install -g @neosjs/cli
使用
创建项目
bash
neos create <projectName> [options]
neos create <projectName> [options]
举个例子
bash
neos create demo --git init commit
neos create demo --git init commit
啰嗦一下
上述指令,将创建一个demo项目,并自动初始化git提交信息 'init commit'。(举一反三:--git init commit
不是非必须的,如果输入了,就会自动执行git commit
。)
执行完上述指令后,剩余的工作就可以放心的交给 Neos 了。 喝口茶的功夫,你就可以愉悦的享受代码了 🎲 🍷 👙。
查看当前系统信息
bash
neos info
neos info
打开一个网址
bash
neos open <http-url>
neos open <http-url>
生成一个随机数
bash
neos random <length>
neos random <length>
更多帮助信息,使用 -h
或 --help
参数:
bash
neos -h
neos -h