阿裡巴巴前端規約及配套工具

規約文檔

規約文檔主要分為編碼規約和工程規約兩大類，包括：

• 編碼規約

• • HTML 編碼規約
  • CSS 編碼規約
  • JavaScript 編碼規約
  • TypeScript 編碼規約
  • React 編碼規約
  • Rax 編碼規約
  • Node.js 開發規約

• 工程規約

• • Git 規約
  • 文檔通用規約
  • 更新日志規約
  • 前後端協作規約

規約文檔目前暫未對外開放，敬請期待……

https://github.com/alibaba/f2e-spec#%E9%85%8D%E5%A5%97%E5%B7%A5%E5%85%B7 配套工具

我們引入了多個業界流行的 Linter 作為規約文檔的配套工具，并根據規約内容定制了對應的規則包，它們包括：

規約	Lint 工具	規則包
《JavaScript 編碼規約》 《TypeScript 編碼規約》 《React 編碼規約》 《Rax 編碼規約》 《Vue 編碼規約》 《Node.js 開發規約》	ESLint	eslint-config-ali
《CSS 編碼規約》	stylelint	stylelint-config-ali
《Git 規約》	commitlint	commitlint-config-ali
《文檔通用規約》	markdownlint	markdownlint-config-ali

可以看到這些 Linter 和規則包衆多且零散，全部安裝它們會給項目增加十幾個依賴，接入和更新成本都比較高。

是以我們封裝了

F2ELint

這個 npm 包，它收斂屏蔽了這些依賴和配置細節，提供簡單的 CLI 和 Node.js API，讓項目能夠一鍵接入、一鍵掃描、一鍵修複、一鍵更新，并為項目配置 git commit 卡口，降低項目接入規約的成本。

你可以使用

友善地為項目接入全套規約 Lint，也可以根據需求單獨安裝 xx-config-ali 和相關 Linter。