项目简介
本项目是一个遵循前端工程化规范的项目模板。引入了ESLint、stylelint、commitlint和markdownlint等业界流行的Lint工具,为前端开发者提供统一编码规范。配套工具sd-fe-lint
屏蔽了依赖和配置细节,提供简单的CLI和Node.js API,可让项目一键接入、扫描、修复和升级规范,提升项目代码质量与工作效率。
项目的主要特性和功能
- 代码规范检查:利用ESLint、stylelint等工具对JavaScript、TypeScript、CSS等代码进行规范检查。
- Git提交规范:通过commitlint规范Git提交信息,保障版本管理质量。
- 文档规范检查:借助markdownlint对项目文档进行规范检查,确保文档质量。
- 便捷工具支持:
sd-fe-lint
工具可实现项目一键接入、扫描、修复和升级规范。
安装使用步骤
- 确保已下载本项目的源码文件。
- 在项目根目录下运行
npm install
或yarn
安装项目依赖。 - 运行
sd-fe-lint
命令进行项目代码的规范扫描。 - 根据扫描结果,使用工具修复问题。
- 遵循规范编写代码,保证代码质量。
- 使用Git提交代码时,遵循Git规范确保提交信息质量。
注意:本项目重点在于规范执行和工具使用,而非具体功能实现。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】