Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 3.64 KB

README.md

File metadata and controls

114 lines (76 loc) · 3.64 KB
Raw

项目说明

  • 该项目主要为樛木 PC管理端 PC web端 移动端 三端项目，各项目详细说明请看相关的 README.md

  • 使用 pnpm 管理，未安装 pnpm 需要全局安装 npm i pnpm -g

初始化

  • 安装依赖 pnpm i

  • 初始化提交规则（仅第一次需要） pnpm dlx husky install

运行

  • web 项目运行（待开发）

    • 开发环境 pnpm run web:dev
    • 测试环境 pnpm run web:test
    • 生产环境 pnpm run web:build
    • 预览打包 pnpm run web:preview

  • pc 项目运行（开发中）

    • 开发环境 pnpm run pc:dev
    • 测试环境 pnpm run pc:test
    • 生产环境 pnpm run pc:build
    • 预览打包 pnpm run pc:preview

  • mobile 项目运行（待开发）

    • 开发环境 pnpm run mobile:dev
    • 测试环境 pnpm run mobile:test
    • 生产环境 pnpm run mobile:build
    • 预览打包 pnpm run mobile:preview

安装包

  • 全局安装 安装到dependencies使用 --save-prod, -P 如 pnpm add vue -w -P 安装到devDependencies使用 --save-dev, -D 如 pnpm add @vitejs/plugin-vue -w -D

  • 指定某个项目安装，如只为pc项目安装依赖 pnpm add lodash --filter @jiumu/pc -D

代码规范格式

  • 本项目只对packages/** 目录下的文件做格式化校验（包括提交）

  • 自动格式化，在git commit 时会自动校验暂存区的代码格式，格式规则参考 .eslintrc.js

  • 手动查看代码格式规范 pnpm run lint

  • 文件命名：组件、公共hooks(package/utils/* 目录下的hooks)文件使用小驼峰命名法，其他文件使用横杆命名法

  • 代码命名：css 使用横杆命名法，常量使用大写字母，其他使用小驼峰命名法

工作区间文件相互依赖

  • packages 项目相互依赖，如 packages/pc 项目需要引入 packages/utils 的方法

    • 把 packages/utils 当做普通插件下载 pnpm add @jiumu/utils -w
    • 直接在 packages/pc 项目引入使用即可 import { xxx } from '@jiumu/utils

pnpm 命令常用说明

  • pnpm 与 npm 用法类似
npm pnpm
npm i pnpm i
npm i pnpm add
npm run pnpm

  • pnpm add <package> 安装某依赖包

    • --save-prod, -P 添加到 dependencies
    • --save-dev, -D 添加到 devDependencies
    • --save-optional, -O 添加到 optionalDependencies
    • --global, -g 全局安装
    • 如 npm add -P vue

  • pnpm update, up 更新依赖包

    • pnpm up 更新 package.json 指定范围的所有依赖项
    • pnpm up --latest 升级所有依赖项（忽略 package.json 指定范围）
    • pnpm up vue@xx 将 vue 升级到指定版本
    • pnpm up @babel/** 更新 @babel 下的所有依赖项
    • 如 npm up -P [email protected]

  • pnpm remove, rm, uninstall, un 移除依赖

    • --save-prod, -P 仅从 dependencies 删除
    • --save-dev, -D 仅从 devDependencies 删除
    • --save-optional, -O 仅从 optionalDependencies 删除
    • --global, -g 全局删除
    • 如 pnpm remove vue

  • -C <path>, --dir <path> 指定运行目录

    • 如 pnpm run -C packages/pc dev

  • -w, --workspace-root 指定全局安装

    • 如 pnpm add vue -w
    • pnpm remove vue -w

  • --filter <package_name> 指定子包安装

    • 如 pnpm add lodash-es --filter @jiumu/pc
    • pnpm remove lodash-es --filter @jiumu/pc

  • pnpm run 运行 scripts 下配置的命令

    • 如 pnpm run dev 运行 dev 命令

  • pnpm create 通过模板创建一个项目

    • 如 pnpm create vite my-vue 创建一个名叫 my-vue 的项目

问题

  • vue 提示错误，defineProps defineEmits 等提示错误，可以安装 volar 插件