https://github.com/qzruncode/sww-template
Template Project for cacheweb-webpack-plugin
https://github.com/qzruncode/sww-template
Last synced: over 1 year ago
JSON representation
Template Project for cacheweb-webpack-plugin
- Host: GitHub
- URL: https://github.com/qzruncode/sww-template
- Owner: qzruncode
- Created: 2022-02-09T08:07:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T13:51:37.000Z (over 4 years ago)
- Last Synced: 2025-02-13T23:47:31.801Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 450 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## sww-template
1. 本模板是本人在开发[cacheweb-webpack-plugin](https://www.npmjs.com/package/cacheweb-webpack-plugin)时定义的，开箱即用集成了开发前端项目所需要个各种配置。
2. 使用本模板需要借助[sww-cli](https://www.npmjs.com/package/sww-cli)安装，安装步骤如下
```
git init
npm install sww-cli
npx sww-cli init sww-template
npm install
npm start 开发
npm build 生产
```
## 模板命令
+ npm start 运行
+ npm run build 编译
+ npm run preview 预览
+ npm run reinstall 重新安装依赖
+ npm run tsc 验证ts
+ npm run fix eslint格式化配合husky使用
+ npm run prepare husky预install
+ 环境变量在根目录.env中声明，代码中通过process.env获取
## 内置开箱即用的husky钩子
+ npx husky add .husky/pre-commit "npx lint-staged"
+ npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
+ 利用husky添加pre-commit钩子，在提交到git暂存区之前执行 lint-staged
```
lint-staged 执行如下命令
"prettier --write" prettier格式化文档
"npm run fix" 使用eslint修复代码语法格式
"git add" 提交代码到暂存区
```
+ 利用husky添加commit-msg钩子，在提交到git暂存区之前验证提交信息的格式