纳西索斯
前端编码规范工程化
完善的规范生态
支持对全部前端配置实现一键接入、一键扫描、一键修复、一键升级
支持 Typescript
提供完整的类型注释，帮助您从 0~1 掌握完整的前端规范化
完整的测试用例
配套完整的测试用例，帮助您提升项目健壮性
# ⭐️ 设计目的
随着前端技术的发展，前端项目正在变得越来越复杂。JavaScript 作为一门弱类型解释性编程语言，其灵活多变的语法极大的提高了前端开发效率，但同时也存在一系列问题。在大型项目开发过程中，代码维护所占的时间比重往往大于新功能的开发。因此编写符合团队编码规范的代码是至关重要的。 一致性的代码规范可以增强团队开发协作效率、提高代码质量、减少遗留系统维护的负担。但是每个人的代码编写喜好不同，代码风格也会迥然不同，若要一个团队内所有的成员都能发挥最大程度的价值，一个具有普适性的标准是必不可少的。
那么，如何制定前端团队的代码规范，如何在团队内进行最小成本的推广，就是一个合格的前端架构师面临的一大难题。很多团队的基础建设都只是简单地知晓其中一部分规范工具的使用，但却没有一套完整的工程化产出来助力研发同学实现规范落地。因此，如果我们能够产出一套完整化的前端编码规范工具，都会对不仅能够解决存量项目的编码异味，还能够保证后续所有项目的编码质量。
# 💡 相关枝术说明
- 通过
monorepo和pnpm的多包管理方式开发一套多npm包的管理方式，以及如何将发包流程植入CI实现自动化发布，以及CHANGLOG的自动化更新部署； - 在现有前端前沿的研发流程下，我们可以通过哪些工具提升项目的编码规范，并提供配套工具的最佳实践，包括但不限于
eslint、stylelint、commitlint、markdownlint、husky等，以及如何将单元测试植入配套工具的具体实现； - 通过脚手架的方式，以交互式形式一键接入，实现对
JavaScript、Typescript、React、Vue等不同类型的前端项目下的标准的语法限制； - 对存量项目进行优化：对于存量代码不符合规范的问题，支持一键扫描和一键修复，一键式的修复存量问题，最小化存量代码的更新成本；
- 对新项目添加规范：支持一键接入新增项目，通过结合
gitpre-commit钩子，对提交文件进行编码规范的扫描；同时通过husky的commit-msg钩子，对本次代码提交message的格式进行扫描。
# 🛋 配套工具
我们引入了多个业界流行的 Linter 作为规范文档的配套工具，并根据规范内容定制了对应的规则包，它们包括：
| 规范 | Lint 工具 | NPM包 |
|---|---|---|
| JavaScript 编码规范 TypeScript 编码规范 Node 编码规范 | ESLint (opens new window) | narcissus-fe-eslint-config (opens new window) |
| CSS 编码规范 | stylelint (opens new window) | narcissus-fe-stylelint-config (opens new window) |
| Git 规范 | commitlint (opens new window) | narcissus-fe-commitlint-config (opens new window) |
| 文档规范 | markdownlint (opens new window) | narcissus-fe-markdownlint-config (opens new window) |
narcissus-nm-spec-cli (opens new window) 收敛屏蔽了上述依赖和配置细节，提供简单的 CLI 和 Node.js API，让项目能够一键接入、一键扫描、一键修复、一键升级，并为项目配置 git commit 卡口，降低项目接入规范的成本。
您可以使用narcissus-nm-spec-cli (opens new window) 方便地为项目接入全部规范。