如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践

这篇具有很好参考价值的文章主要介绍了如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

},

globals: {

// 小程序的全局变量

DEV: true,

WECHAT: true,

ALIPAY: true,

__wxConfig: true,

App: true,

Page: true,

Component: true,

Behavior: true,

wx: true,

getApp: true,

getCurrentPages: true,

},

rules: {

// 这是我的配置,大家可以参考官方团队的配置

‘linebreak-style’: [‘error’, ‘unix’], //换行样式

quotes: [‘error’, ‘single’, { avoidEscape: true }], //单引号

semi: [‘error’, ‘always’], //分号

‘no-mixed-spaces-and-tabs’: [2, false], //禁止混用tab和空格

‘object-curly-spacing’: [0, ‘never’], //大括号内是否允许不必要的空格

‘no-multiple-empty-lines’: [2, { max: 2, },], // 不允许多个空行

‘brace-style’: [2, ‘1tbs’, { allowSingleLine: true, },], // if while function 后面的{必须与if在同一行,java风格。

‘no-redeclare’: 2, //禁止重复声明变量

‘no-trailing-spaces’: 1, //一行结束后面不要有空格

‘no-unused-vars’: [2, { vars: ‘all’, args: ‘none’ }], //不能有声明后未被使用的变量或参数

‘default-case’: 2, //switch语句最后必须有default

‘prefer-const’: 2, //未被赋值的常量 使用const

‘template-curly-spacing’: 1, //强制使用大括号内的间距 Bad: {people.name} 正确{ people.name }

‘array-bracket-spacing’: [2, ‘never’], //是否允许非空数组里面有多余的空格 Bad:[ ‘foo’, ‘bar’ ] Good:[‘foo’, ‘bar’];

‘brace-style’: [2, ‘1tbs’, { allowSingleLine: true, },], //大括号风格

‘key-spacing’: [2, { beforeColon: false, afterColon: true, },], //冒号前后的空格

},

};

.editorconfig

root = true

[*]

charset = utf-8

indent_style = space

indent_size = 2

end_of_line = lf

insert_final_newline = true

trim_trailing_whitespace = true

使用方法

终端中输入以下代码即可修复代码文件

// 全局安装eslint

eslint --fix index.js // fix后接文件名

// 没有全局安装eslint

npx eslint --fix index.js // fix后接文件名

在package.json中配置以下代码

“scripts”: {

“lint”: “npx eslint --fix **/*.js”,

},

这样就可以在终端中输入以下代码就可以实现整个项目的eslint格式化

npm run lint

Prettier引入


安装

NPM

npm install prettier --save-dev

配置使用规则

在root文件夹下创建文件 .prettierrc.js, 由于prettier是Opinionated code formatter,所以配置项相对较少。

module.exports = {

// 使用 4 个空格缩进

tabWidth: 2,

// 不使用缩进符,而使用空格

useTabs: false,

semi: true,

singleQuote: true,

overrides: [

// 使用css/html的规则格式化wxss/wxml

{

files: ‘*.wxss’,

options: {

parser: ‘css’,

},

},

{

files: ‘*.wxml’,

options: {

parser: ‘html’,

},

},

],

};

使用方法

终端中输入以下代码即可修复代码文件

// 全局安装prettier

prettier --fix index.js // fix后接文件名

// 没有全局安装prettier

npx prettier --write index.js // fix后接文件名

在package.json中配置以下代码

“scripts”: {

“prettier”: “npx prettier–write **/*.js”,

},

这样就可以在终端中输入以下代码就可以实现整个项目的eslint格式化

npm run prettier

ESLint 和 Prettier 结合使用


由于两者都会进行代码的格式化,我们并不希望代码的重复格式化以及发生不必要的冲突,所以我们要安装中间件来保证两者和谐运行

安装

npm install --save-dev eslint-config-prettier

npm install --save-dev eslint-plugin-prettier

配置使用方法

修改 .eslintrc.js 中的部分配置项

module.exports = {

extends: [‘eslint:recommended’, ‘plugin:prettier/recommended’],

plugins: [‘prettier’],

}

husky + lint-staged引入


安装

NPM

npm install husky --save-dev

npm install lint-staged --save-dev

配置使用规则

在package.json中配置

{

“husky”: {

“hooks”: {

“pre-commit”: “lint-staged”

}

},

“lint-staged”: {

“miniprogram/**/*.js”: [

“npx eslint --fix”,

“prettier --write”,

“git add”

]

},

}

Commitizen


安装

npm install commitizen --save-dev

// 使用npx初始化常规更新日志适配器

npx commitizen init cz-conventional-changelog --save-dev --save-exact

配置使用规则

在package.json中配置

{

“scripts”: {

“commit”: “cz”

}

}

使用方法

在git add提交代码后,可以使用npm run commit 或者 npx cz 来提示填写commit信息

git add .

npm run commit

// npx cz

踩坑

虽然GitHub仓库中提到commitizen可以结合husky使用,从而达到在git commit的钩子中执行commitizen,但是至少Windows环境下使用这一方法会导致commitizen每次输入都会重复呈现提示信息,给人不友好的交互,因此并不建议在Windows环境下结合husky使用。

这个问题在其GitHub仓库的issue中有提及,不过暂时没有解决办法。issue网址如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

Commitlint


安装

npm install --save-dev @ commitlint / config-conventional @ commitlint / cli

配置使用规则

在package.json中配置

{

“husky”: {

“hooks”: {

“pre-commit”: “lint-staged”, // 这个是之前配置的内容

“commit-msg”: “commitlint -E HUSKY_GIT_PARAMS”

}

},

}

新建 commitlint.config.js

module.exports = {

extends: [‘@commitlint/config-conventional’],

rules: {

‘body-leading-blank’: [1, ‘always’],

‘footer-leading-blank’: [1, ‘always’],

‘header-max-length’: [2, ‘always’, 72],

‘scope-case’: [2, ‘always’, ‘lower-case’],

‘subject-case’: [

2,

‘never’,

[‘sentence-case’, ‘start-case’, ‘pascal-case’, ‘upper-case’],

],

‘subject-empty’: [2, ‘never’],

‘subject-full-stop’: [2, ‘never’, ‘.’],

‘type-case’: [2, ‘always’, ‘lower-case’],

‘type-empty’: [2, ‘never’],

‘type-enum’: [

2,

‘always’,

[

‘build’,

‘chore’,

‘ci’,

‘docs’,

‘feat’,

‘fix’,

‘improvement’,

‘perf’,

‘refactor’,

‘revert’,

‘style’,

‘test’,

],

],

},

};

使用方法

在你git commit 提交代码的时候会自动检查你的commit信息是否符合规范

踩坑

虽然GitHub仓库中的初始步骤中使用的方法是借助以下代码生成commitlint.config.js文件,但是在Windows环境下生成的文件解码方式是UTF-16,所以在自动运行时会报错。因此建议自己手动创建一个commitlint.config.js,输入以上代码进行配置。

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

conventional-changelog


安装

npm install --save-dev conventional-changelog-cli

配置使用规则

在package.json中配置

{

“scripts”: {

“version”: “npx conventional-changelog -p angular -i CHANGELOG.md -s”

}

}

使用方法

npm run version

// 或者不进行配置,直接使用以下代码

npx conventional-changelog -p angular -i CHANGELOG.md -s

// 假如希望生成至今所有的改动

npx conventional-changelog -p angular -i CHANGELOG.md -s -r 0

standard-version


安装

npm install --save-dev standard-version

配置使用规则


在package.json中配置

{

“scripts”: {

“release”: “npx standard-version”

}

}

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(资料价值较高,非无偿)

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

最后

本人分享一下这次字节跳动、美团、头条等大厂的面试真题涉及到的知识点,以及我个人的学习方法、学习路线等,当然也整理了一些学习文档资料出来是附赠给大家的。知识点涉及比较全面,包括但不限于前端基础,HTML,CSS,JavaScript,Vue,ES6,HTTP,浏览器,算法等等

详细大厂面试题答案、学习笔记、学习视频等资料领取,点击资料领取直通车!!

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

前端视频资料:
的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!**

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

[外链图片转存中…(img-vyTitegK-1711766482567)]

[外链图片转存中…(img-kt9tU6BI-1711766482568)]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

[外链图片转存中…(img-ltS4fd8G-1711766482568)]

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(资料价值较高,非无偿)

如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序

最后

本人分享一下这次字节跳动、美团、头条等大厂的面试真题涉及到的知识点,以及我个人的学习方法、学习路线等,当然也整理了一些学习文档资料出来是附赠给大家的。知识点涉及比较全面,包括但不限于前端基础,HTML,CSS,JavaScript,Vue,ES6,HTTP,浏览器,算法等等

详细大厂面试题答案、学习笔记、学习视频等资料领取,点击资料领取直通车!!

[外链图片转存中…(img-LVbu4ia8-1711766482568)]

前端视频资料:
如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践,程序员,小程序文章来源地址https://www.toymoban.com/news/detail-847870.html

到了这里,关于如何规范团队代码,小程序ESLint+Prettier+lint-staged+commit+changelog+standard-version自动规范实践的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Vue3+Vite+TS项目集成ESlint +Prettier实现代码规范检查和代码格式化

    我在这里直接是通过vite提供的默认模板来创建一个vue3 + ts的项目。这里可以cmd,然后npm -v来查看版本。 这样一个vue3 + ts的项目就创建好了,使用vscode打开该项目,然后执行 yarn 安装依赖 依赖安装完成后,执行   yarn dev  启动项目就可以在浏览器中正常访问了。   初始化

    2024年01月24日
    浏览(87)
  • vite 创建vue3项目,使用 Prettier 统一格式化代码,集成 ESLint、Stylelint 代码校验规范

    在团队开发中,保持代码风格的一致性和代码质量的高度,对于项目的可维护性和可读性非常重要。为了实现这一目标,我们可以使用工具来自动格式化代码并进行代码校验,在开发过程中捕获潜在的问题,并提供修复建议。 本示例中,我们将使用 Vite 来创建一个新的 Vue

    2024年04月28日
    浏览(60)
  • 【vue3-element-admin】ESLint+Prettier+Stylelint+EditorConfig 约束和统一前端代码规范

    本文介绍 vue3-element-admin 如何通过ESLint 检测 JS/TS 代码、Prettier 格式化代码、Stylelint 检测 CSS/SCSS 代码和配置 EditorConfig 来全方位约束和统一前端代码规范。 ESLint 可组装的JavaScript和JSX检查工具,目标是保证代码的一致性和避免错误。 安装 ESLint 插件 VSCode 插件市场搜索 ESLint 插

    2023年04月17日
    浏览(84)
  • 基于Vue3+Vite+TS+ESLint+Prettier+Husky+lint-staged+commitlint+stylelint的项目构建

    博客后台管理系统使用后的是基于Vue3+Vite+TS+ESLint+Prettier的开发,具体项目构建如下 ESLint: 控制代码质量 Prettier: 控制代码风格 2.1、安装ESLint、Prettier相关相关包 eslint: ESLint的核心代码库 prettier: Prettier的格式化代码的核心代码库 eslint-config-airbnb-base: airbnb的代码规范(依赖pl

    2024年02月07日
    浏览(57)
  • Vue项目中代码规范(Prettier + ESLint)

    P r e t t i e r 用于统一代码格式,它主要关注代码外观,例如缩进、换行、引号等 Prettier用于统一代码格式,它主要关注代码外观,例如缩进、换行、引号等 P re tt i er 用于统一代码格式,它主要关注代码外观,例如缩进、换行、引号等 E S L i n t 用于代码质量和规范,它主要可

    2024年02月04日
    浏览(40)
  • vsCode配置Eslint+Prettier结合使用详细配置步骤,规范化开发

            eslint它规范的是代码偏向语法层面上的风格 。本篇文章以一个基本的vue项目,来说明eslint+prettier+husky配置项目代码规范,为了更好的描述本文,我恢复了vscode的默认设置(即未安装eslint,prettier等插件,setting中也没有相关配置) 1、新建vue3.0脚手架项目 2、项目安装

    2023年04月17日
    浏览(43)
  • 为react项目添加开发/提交规范(前端工程化、eslint、prettier、husky、commitlint、stylelint)

    因历史遗留原因,接手的项目没有代码提醒/格式化,包括 eslint、pretttier,也没有 commit 提交校验,如 husky、commitlint、stylelint,与其期待自己或者同事的代码写得完美无缺,不如通过一些工具来进行规范和约束。 eslint 是一个代码校验工具,用来规范项目代码风格。 初始化 通

    2024年02月14日
    浏览(98)
  • 从0搭建Vue3组件库(十一): 集成项目的编程规范工具链(ESlint+Prettier+Stylelint)

    欲先善其事,必先利其器。一个好的项目是必须要有一个统一的规范,比如代码规范,样式规范以及代码提交规范等。统一的代码规范旨在增强团队开发协作、提高代码质量和打造开发基石,所以每个人必须严格遵守。 本篇文章将引入 ESLint+Prettier+Stylelint 来对代码规范化。 ESLint

    2024年02月02日
    浏览(43)
  • 【vue3+ts项目】配置eslint校验代码工具,eslint+prettier+stylelint

    package.json中 vite后面加上 --open 回答问题如下: 使用eslint仅检查语法,还是检查语法及错误,选第二个 使用的是什么模块,选第一个 项目使用的是什么框架,选vue 项目中使用TyoeScript ,选yes 项目运行在哪,选浏览器 创建的配置类型需要什么类型的,选Javascript 需要安装这些

    2024年02月09日
    浏览(83)
  • 如何解决ESLint和prettier冲突问题

    注意:这个冲突问题一般是指在代码编辑器中出现的问题,这里使用的是vscode。 在前端开发中,很多人使用 prettier 作为代码格式化工具,用 ESLint 控制代码风格,以及检查错误。 但是在同时使用 ESLint 和 prettier 的时候,由于代码规则不一样就会发生冲突,发生冲突的原因是

    2024年02月07日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包