ykfe-spec

移卡前端规范及配套工具

简介

「移卡前端规范」是一套前端编码和工程规范，致力于通过统一编码风格、普及最佳实践和代码缺陷检查帮助团队降低协作成本、提升前端项目的可维护性和稳定性。

本项目主要包括「规范文档」和「配套工具」两部分。你可以通过阅读规范文档了解各前端语言、框架及工程规范，并使用 YkLint 等配套工具来为项目接入规范检查。

规范文档

前端规范文档

配套工具

我们引入了多个业界流行的 Linter 作为规范文档的配套工具，并根据规范内容定制了对应的规则包，它们包括：

规范	Lint 工具	规则包
《JavaScript 编码规范》 《TypeScript 编码规范》 《Node.js 开发规范》	ESLint	eslint-config-ykplus
《CSS 编码规范》	stylelint	stylelint-config-ykplus
《Git 规范》	commitlint	commitlint-config-ykplus

可以看到这些 Linter 和规则包众多且零散，全部安装它们会给项目增加十几个依赖，接入及后续升级成本都比较高。

因此我们封装了 YkLint 这个 npm 包，它收敛屏蔽了这些依赖和配置细节，提供简单的 CLI 和 Node.js API，让项目能够一键接入、一键扫描、一键修复、一键升级，并为项目配置 git commit 卡口，降低项目接入规范的成本。

你可以使用 YkLint 方便地为项目接入全套规范 Lint (推荐)，也可以根据需求单独安装 xx-config-ykplus 和相关 Linter。

相关文档及信息

本项目的配套工具使用了多个优秀的 Linter、Formatter 及社区生态，主要包括：

• ESLint
• Prettier
• Stylelint
• commitlint 及 conventional-changelog-conventionalcommits
• husky