学习使用前端代码规范工具——F2Elint过程记录

参考原文:(阿里巴巴前端代码规范集成工具F2ELint使用教程)
https://blog.csdn.net/qq_37263248/article/details/123361050

代码分析

1. 工具 f2elint 安装

简介: f2elint 是《阿里巴巴前端规约》的配套 Lint 工具,提供简单的 CLI 和 Node.js API,让项目能够一键接入、一键扫描、一键修复、 一键升级,并为项目配置 git commit 卡点,降低项目实施规约的成本。

# 全局安装 f2elint
npm i f2elint -g
# 验证 f2elint 是否安装成功
f2elint -h

2. f2elint 的使用

2.1 在项目根目录,初始化 f2elint

f2elint init

2.2 安装步骤,按实际情况选择即可

2.2.1 会提示选择项目的语言和框架类型

2.2.1.png

2.2.2 选择是否需要样式的检查

2.2.2.png

2.2.3 是否检查markdown

2.2.3.png

2.2.4 是否用Prettier插件格式化代码

2.2.4.png

2.2.5 检查冲突,确认是否继续:

2.2.5.png

2.2.6 安装依赖

2.2.6.png

2.2.7 初始化完成

2.2.7.png

2.3 .gitignore文件中加上

.editorconfig
.eslintignore
.eslintrc.js
.prettierrc.js
.stylelintignore
.stylelintrc.js
commitlint.config.js
f2elint.config.js

3. 使用效果

IDE中,代码里面会自动分析,提示不符合规约的错误,并提供修改建议。

3.png

4. 常见问题

4.1 初始化 f2elint 时,提示 “f2elint : 无法加载文件 C:\Program Files\nodejs\f2elint.ps1,因为在此系统上禁止运行脚本。”

解决方法: 改用如下命令:
f2elint.cmd init

4.2 前端代码规约

详见: 阿里巴巴前端规约及配套工具Github仓库

4.3 vscode用户需要安装三个插件

  • ESLint
  • Stylelint
  • Prettier - Code formatter

4.4 关于前后端不分离的老项目,怎么引入 f2elint

解决方案

# 在项目根目录初始化一个基于 node.js 的项目,生成 package.json 文件
npm init
# 然后就可以初始化 f2elint了
f2elint.cmd init

BUT , 据我观察,前后端不分离的老项目,由于前端页面会包含一些后端的模板,例如:thymeleaf、freemarker等,由于语法不同,在页面中会影响 f2elint 对前端代码的分析。如果大家有什么好的解决思路,可以评论给我哦~

提交分析

1. 安装 husky

husky可以让我们向项目中方便添加git hooks。在 git commit 时会运行 f2elint commit-file-scan 和 f2elint commit-msg-scan 分别对提交文件和提交信息进行规约检查。
npm install husky --save-dev
如果不按规则提交代码,会提示错误

提交分析.png

2. 工程规约

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,539评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,594评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,871评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,963评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,984评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,763评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,468评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,850评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,002评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,144评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,823评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,483评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,026评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,150评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,415评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,092评论 2 355

推荐阅读更多精彩内容