# pl-preset

**Repository Path**: chad-ding/pl-preset

## Basic Information

- **Project Name**: pl-preset
- **Description**: 一键设置npm项目格式化、校验配置
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-04
- **Last Updated**: 2026-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pl-preset

一键生成web项目常用设置简化配置过程

## 使用方式

```javascript
// 全局安装
npm install -g pl-preset

// 在项目根路径下执行
plp
```

## 主要功能

### prettier

默认以prettier作为代码格式化工具，自动生成配置信息

### Git设置

如果项目仓库是git那么会为项目配置husky进行提交前校验同时使用cz-conventional-changelog规范commit信息，通过`npm run c`进行代码提交

### 生成changelog

对于使用cz-conventional-changelog进行git提交的项目，可以选择性接入conventional-changelog-cli工具生成changelog文件，通过执行`npm run clog`生成changelog文件

### vscode设置

当前仅支持vscode编辑器相关设置，选择vscode后自动生成插件以及代码格式化相关配置信息

### 开发语言

支持选择javascript、typescript，自动生成eslint相关配置进行校验

### 样式语音

支持选择css、less、scss，自动生成stylelint配置对代码进行校验

### 框架

支持选择vue2、vue3、react，自动在eslint和stylelint中插入框架相关设置进行校验

### html文件校验

选择项目中是否包含html文件，在eslint和prettier配置中增加html相关内容