Next.js配置Eslint+Prettier+husky规范代码开发

Next.js配置代码格式化和校验

本文概括:

  1. ESLint 可以给项目加上代码校验
  2. Prettier可以格式化代码
  3. Git的钩子可以在提交时自动修复格式化

安装和配置Prettier

Next.js项目已经配置好了EsLint,可以自己加上prettier进行格式化:

官网文档链接:nextjs.org/docs/app/ap...

安装Prettier依赖:

arduino 复制代码
npm install --save-dev eslint-config-prettier

在 eslint.config.mjs 中加入prettier

ini 复制代码
const eslintConfig = [
    ...compat.extends("next/core-web-vitals", "next/typescript", "prettier"),
];

prettier已经可以完成代码格式化了,我们项目中一般会用tailwindCSS,所以可以顺便格式化一下tailwind的类名(下面两个按需使用)

css 复制代码
npm i -D prettier-plugin-organize-imports prettier-plugin-tailwindcss

新建一个 .prettierrc.json 来放置格式化的规则,下面会具体介绍

新建一个 .prettierignore 来放置不需要格式化的内容

格式化命令(可以放钩子里提交之前格式化一下):

perl 复制代码
# 下面的命令会直接帮你格式化
npx prettier . --write
# 下面的命令会检测,不格式化
npx prettier . --check

在IDEA编辑器中配置代码格式化,打开下面的选项:

然后可以给prettier绑定一个快捷键(我这里改成了和默认的格式化是同一个,这样就可以使用默认格式化的同时格式化代码了):

安装和配置husky

husky 和 lint-staged 可以在 Git 提交代码时进行 ESLint 的代码校验和 prettier 的格式化

husky官网:typicode.github.io/husky/get-s...

安装依赖(husk+lint-staged):

arduino 复制代码
npm install --save-dev husky lint-staged
# 下面这个可以在package.json里设置  "prepare": "husky install" 当别人安装依赖的时候会自动执行prepare脚本
npm pkg set scripts.prepare="husky install" 

husky配置:

csharp 复制代码
npx husky init

修改 .husky/pre-commit 文件内容,放入我们需要执行的npx lint-staged

新建一个 .lintstagedrc.json文件,用来配置格式化内容,这里我只格式化src目录下的文件

css 复制代码
{
    "src/**/*.{js,jsx,ts,tsx}": ["eslint --fix"],
    "src/**/*.{js,jsx,tsx,ts,less,md,json}": ["prettier --write"]
}

现在提交代码之后就会自动进行格式化了。

相关推荐
壹楽6 小时前
用 React 19.2 的 <Activity> 做多页签保活,我踩了 6 个坑
react.js
spmcor6 小时前
React useEffect 完全指南:从原理到实战的深度解析
react.js
用户298698530142 天前
React 前端实现 Word 与 OpenXML 双向转换的完整实践
javascript·react.js
濮水大叔3 天前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
月夏3 天前
我把全栈项目塞进已有 nginx 的服务器,卡我最久的是三个斜杠
nginx·react.js·docker
清晨Coding6 天前
为什么用 React Developer Tools 查看组件树这么乱?
前端·react.js
生活的囚徒7 天前
从一堆Excel到一套系统:项目管理+研发管理双门户的落地实践
react.js
ZhengEnCi8 天前
React 19 加 Vite 6 企业级前端项目目录结构:无路由 SPA、zustand 与 Tailwind 4 的分层架构指南
react.js
用户298698530148 天前
React 前端实现 Excel 与 CSV 互转:基于 WebAssembly 的浏览器端方案
javascript·react.js·excel
Highcharts.js10 天前
Highcharts Orbit 完全指南:把每一张图表变成交互式分析工具
react.js·前端框架·highcharts·orbit·使用指南·ai 图表·交互式分析工具