eslint prettier 配置

本文介绍了如何使用pnpm创建Vite项目,配置ESLint进行代码规范检查,安装并定制Prettier确保代码美观,以及设置husky和commitlint进行提交规范。详细讲解了eslint配置、prettier规则和package.json中的脚本设置。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.创建: pnpm create vite

2.自启浏览器;技巧01: package.json -> "dev": "vite" --> "dev": "vite" --> "dev": "vite --open"


一个项目要有统一的规范,需要使用eslint + stylelint + prettier来对我们的代码质量做检测和修复 eslint用于代码语法检测 stylelint用于对css代码进行语法检测 prettier用于代码格式规范 husky用于commit拦截,在代码提交前自动对代码进行格式 commitlint规范代码提交时的信息 preinstall统一包管理器工具

3.eslint 配置; 安装

pnpm i eslint -D 

生成配置文件 .eslint.cjs 指令

npx eslint --init 

安装 vue3 环境代码校验插件

pnpm install -D eslint-plugin-import eslint-plugin-vue eslint-plugin-node eslint-plugin-prettier eslint-config-prettier eslint-plugin-node @babel/eslint-parser

接着修改.eslintrc.cjs文件如下:

module.exports = {
    env: {
        browser: true,
        es2021: true,
        node: true,
        jest: true,
    },
    /* 指定如何解析语法 */
    parser: 'vue-eslint-parser',
    /* 优先级低于 parse 的语法解析配置 */
    parserOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
        parser: '@typescript-eslint/parser',
        jsxPragma: 'React',
        ecmaFeatures: {
            jsx: true,
        },
    },
    /* 继承已有的规则 */
    extends: [
        'eslint:recommended',
        'plugin:vue/vue3-essential',
        'plugin:@typescript-eslint/recommended',
        'plugin:prettier/recommended',
    ],
    plugins: ['vue', '@typescript-eslint'],
    // "off" 或 0    ===>    关闭规则
    // "warn" 或 1   ===>    打开的规则作为警告(不影响代码执行)
    // "error" 或 2  ===>    规则作为一个错误(代码不能执行,界面报错)
    rules: {
        'no-var': 'error',  //要求使用 let 或 const 而不是 var
        'no-multiple-empty-lines': ['warn', { max: 1 }], //不允许多个空行
        'no-console': precess.env.NODE_ENV === 'production' ? 'error' : 'off',
        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
        'no-unexpected-multiline': 'error', //禁止空余的多行
        'no-useless-escape': 'off', //禁止不必要的转义字符
​
        '@typescript-eslint/no-unused-vars': 'error',   //禁止定义未使用的变量
        '@typescript-eslint/prefer-ts-expect-error': 'error', // 禁止使用 @ts-ignore
        '@typescript-eslint/no-explicit-any': 'off',    //禁止使用 any 类型
        '@typescript-eslint/no-non-null-assertion': 'off',
        '@typescript-eslint/no-namespace': 'off',   // 禁止使用自定义 TypeScript 模块和命名空间
        '@typescript-eslint/semi': 'off',
​
        'vue/multi-word-component-names': 'off', //要求组件名称始终为'-'链接的单词
        'vue/script-setup-uses-vars': 'error', // 防止<script setup>使用的变量<template>被标记为未使用
        'vue/no-mutating-props': 'off', // 不允许组件 prop 的改变
        'vue/attribute-hyphenation': 'off', // 对模板中的自定义组件强制执行属性命名样式
    }
}

创建.eslintingore配置文件:

dist
node_modules

package.json文件中新增两个运行脚本:

"scripts": {
    "lint": "eslint src", //校验src文件夹下的文件
    "fix": "eslint src --fix", //自动修补的意思
}

eslint和prettier一个保证js代码质量,一个保证代码美观

4.配置prettier:

安装:

pnpm install -D eslint-plugin-prettier prettier eslint-config-prettier

添加.prettierrc.json文件,写入规则:

{
    "singleQuote": true,                
    "semi": false,
    "bracketSpacing": true,
    "htmlWhitespaceSensitivity": "ignore",
    "endOfLine": "auto",
    "trailingComma": "all",
    "tabWidth": 2
}

添加.prettierignore忽略文件:

/dist/*
/html/*
.local
/node_modules/**
**/*.svg
**/*.sh
/public/*

通过pnpm run lint指令检测语法,如果出现不规范格式,就通过pnpm run fix修改

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值