项目简介
本项目是基于Node.js的自动化代码规范管理工具,目标是助力开发团队统一代码风格、提升代码质量,确保提交信息符合规范。它支持命令行操作,可自动格式化代码、校验代码规范,在提交代码时强制检查,还具备图片压缩功能以优化项目体积,并且深度集成VSCode,带来便捷的代码校验和格式化体验。
项目的主要特性和功能
主要特性
- 代码格式统一:自动格式化代码,保证风格一致。
- 规范校验:提交代码前校验,确保符合既定规范。
- 图片压缩:自动压缩提交的图片,优化项目体积。
- VSCode深度集成:配合VSCode使用,提供便捷校验和格式化体验。
功能介绍
- 安装与配置:提供简单安装步骤和配置说明,方便上手。
- 代码校验:对JS、TS、CSS等代码进行规范校验,提示并修复潜在问题。
- 自动格式化:保存文件时自动格式化代码,保持风格一致。
- 提交信息规范:对git commit信息进行规范校验,遵循Conventional Commits规范。
- 插件管理:推荐并管理VSCode插件,确保开发环境一致。
安装使用步骤
安装步骤
- 全局安装:使用npm或yarn全局安装该工具。
bash npm i -g @game/specification # 正式版本 npm i -g @game/specification@beta
- 项目配置:进入项目目录,执行
spec
命令进行项目特性的设置,如代码语言、样式语言等。bash cd my-project # 进入项目目录 spec # 设置项目特性
根据提示选择合适选项进行配置,配置完成后,工具会根据设定特性安装相应依赖包和生成配置。
使用方法
- 在VSCode中打开项目,工具会自动进行代码的校验和格式化。
- 命令行操作:若需在命令行执行操作,使用
spec
命令,可配合-p
参数指定项目路径。bash spec -p xx/xx/my-project # 在指定路径下执行规范校验和格式化操作
也可查看当前版本信息:spec -v
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】