From 28653e4936c7aeb22fe8588edfd76252b1911cb2 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Wed, 10 Apr 2024 21:40:27 +0800 Subject: [PATCH 1/7] fix: improve output --- packages/f2elint/src/f2elint.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/f2elint/src/f2elint.ts b/packages/f2elint/src/f2elint.ts index 14f6f1f..682b620 100755 --- a/packages/f2elint/src/f2elint.ts +++ b/packages/f2elint/src/f2elint.ts @@ -171,6 +171,6 @@ if (process.argv.length > 2 && !process.argv.includes('init')) { } } - outro('🎉 规约初始化完成，建议安装推荐插件并重启 VS Code'); + outro('🎉 规约初始化完成，建议安装推荐的 VS Code 插件并重启 VS Code'); })(); } From 8d0a3fac8f26ca3617ec5b5308e3feeac092f970 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Wed, 10 Apr 2024 21:41:56 +0800 Subject: [PATCH 2/7] chore(f2elint): version --- packages/f2elint/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/f2elint/package.json b/packages/f2elint/package.json index 76a27ba..7f97ad5 100644 --- a/packages/f2elint/package.json +++ b/packages/f2elint/package.json @@ -1,6 +1,6 @@ { "name": "f2elint", - "version": "4.6.0", + "version": "4.6.1", "description": "Linter for Alibaba F2E Guidelines", "keywords": [ "f2elint", From 0cd5ee31e826030cd628ff5f09f3f19b9478a661 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Wed, 10 Apr 2024 21:46:16 +0800 Subject: [PATCH 3/7] chore(f2elint): version --- packages/f2elint/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/f2elint/package.json b/packages/f2elint/package.json index 7f97ad5..f868ec8 100644 --- a/packages/f2elint/package.json +++ b/packages/f2elint/package.json @@ -1,6 +1,6 @@ { "name": "f2elint", - "version": "4.6.1", + "version": "4.6.2", "description": "Linter for Alibaba F2E Guidelines", "keywords": [ "f2elint", From b4eda5b57b0072477abe938d3a983808a324a33b Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Thu, 18 Apr 2024 21:54:35 +0800 Subject: [PATCH 4/7] docs(readme): update links --- README.md | 59 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index c8d5c58..60577e7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# 阿里巴巴前端规约及配套工具 - -[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) +# 阿里巴巴前端规约 ## 简介 @@ -8,33 +6,35 @@ 本项目主要包括「规约文档」和「配套工具」两部分。你可以通过阅读规约文档了解各前端语言、框架及工程规范，并使用 [F2ELint](https://www.npmjs.com/package/f2elint) 等配套工具来为项目接入规约检查。 -### 规约文档 +## 规约文档 规约文档分为编码规约和工程规约两大类，包括： - 编码规约 - - [HTML 编码规约](docs/coding/1.html-style-guide.md) - - [CSS 编码规约](docs/coding/2.css-style-guide.md) - - [JavaScript 编码规约](docs/coding/3.javascript-style-guide.md) - - [React 编码规约](docs/coding/4.react-style-guide.md) - - [Node.js 开发规约](docs/coding/5.node-style-guide.md) - - [TypeScript 编码规约](docs/coding/6.typescript-style-guide.md) - - [Rax 编码规约](docs/coding/7.rax-style-guide.md) + - [JavaScript 编码规约](docs/coding/javascript.md) + - [TypeScript 编码规约](docs/coding/typescript.md) + - [React 编码规约](docs/coding/react.md) + - [Node.js 开发规约](docs/coding/node.md) + - [CSS 编码规约](docs/coding/css.md) + - [HTML 编码规约](docs/coding/html.md) - 工程规约 - - [Git 规约](docs/engineering/1.git.md) - - [文档通用规约](docs/engineering/2.doc-writing-practice.md) - - [更新日志规约](docs/engineering/3.doc-changelog.md) + - [Git 规约](docs/engineering/git.md) + - [文档通用规约](docs/engineering/writing.md) + - [更新日志规约](docs/engineering/changelog.md) -### 配套工具 +## 规约工具 我们引入了多个业界流行的 Linter 作为规约文档的配套工具，并根据规约内容定制了对应的规则包，它们包括： -| 规约 | Lint 工具 | 规则包 | -| -------- | -------- | -------- | -| 《JavaScript 编码规约》
《TypeScript 编码规约》
《React 编码规约》
《Rax 编码规约》
《Node.js 开发规约》 | [ESLint](https://eslint.org/) | [eslint-config-ali](https://www.npmjs.com/package/eslint-config-ali) | -| 《CSS 编码规约》 | [stylelint](https://stylelint.io/) | [stylelint-config-ali](https://www.npmjs.com/package/stylelint-config-ali) | -| 《Git 规约》 | [commitlint](https://commitlint.js.org/#/) | [commitlint-config-ali](https://www.npmjs.com/package/commitlint-config-ali) | -| 《文档通用规约》 | [markdownlint](https://github.com/DavidAnson/markdownlint) | [markdownlint-config-ali](https://www.npmjs.com/package/markdownlint-config-ali) | +| 规约 | 工具 | 规则 | +| ------------------- | -------------- | ------------------------- | +| JavaScript 编码规约 | [ESLint] | [eslint-config-ali] | +| TypeScript 编码规约 | [ESLint] | [eslint-config-ali] | +| React 编码规约 | [ESLint] | [eslint-config-ali] | +| Node.js 开发规约 | [ESLint] | [eslint-config-ali] | +| CSS 编码规约 | [stylelint] | [stylelint-config-ali] | +| Git 规约 | [commitlint] | [commitlint-config-ali] | +| 文档通用规约 | [markdownlint] | [markdownlint-config-ali] | 可以看到这些 Linter 和规则包众多且零散，全部安装它们会给项目增加十几个依赖，接入及后续升级成本都比较高。 @@ -46,7 +46,7 @@ 非常欢迎大家通过 [Issues](https://github.com/alibaba/f2e-spec/issues) 反馈问题和需求，或者通过 [PRs](https://github.com/alibaba/f2e-spec/pulls) 参与贡献，请参考 [CONTRIBUTING.md](/CONTRIBUTING.md)。 -## 贡献者信息 +## 贡献署名 文档撰写人员（排名不分先后）：邦彦、尘弦、迟帆、大果、氐宿、法海、姬无、倞羽、连木、林熠、零弌、墨止、牧曈、霂之、年翼、清锐、萨波、释然、双龙、苏青、阎罗、扬炀、洋风、云谦、载天、梓骞 @@ -54,6 +54,8 @@ 工具编写人员（排名不分先后）：尘弦、鹤仙、连木、牧曈、年翼、秦粤、萨波、双龙、扬炀、洋风 +[其他贡献者参见此处](https://github.com/alibaba/f2e-spec/graphs/contributors) + ## 引用信息及鸣谢 本项目的文档部分参考或引用了许多优秀的业界开源规范、标准化文档和技术官网，它们主要包括： @@ -73,8 +75,17 @@ 本项目的配套工具使用了多个优秀的 Linter、Formatter 及社区生态，主要包括： - [ESLint](https://eslint.org) 及[多个 plugin 和 parser](https://github.com/alibaba/f2e-spec/tree/main/packages/eslint-config-ali#eslint-config-ali) -- [stylelint](https://stylelint.io/) 及 [stylelint-scss](https://github.com/kristerkari/stylelint-scss) -- [commitlint](https://commitlint.js.org/#/) 及 [conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits) +- [stylelint] 及 [stylelint-scss](https://github.com/kristerkari/stylelint-scss) +- [commitlint] 及 [conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits) - [markdownlint](https://github.com/DavidAnson/markdownlint) 在此表示感谢，如有侵权行为，敬请联系我们 :-) + +[ESLint]: https://eslint.org/ +[eslint-config-ali]: https://www.npmjs.com/package/eslint-config-ali +[stylelint]: https://stylelint.io/ +[stylelint-config-ali]: https://www.npmjs.com/package/stylelint-config-ali +[commitlint]: https://commitlint.js.org/ +[commitlint-config-ali]: https://www.npmjs.com/package/commitlint-config-ali +[markdownlint]: https://github.com/DavidAnson/markdownlint +[markdownlint-config-ali]: https://www.npmjs.com/package/markdownlint-config-ali From 4dabe0a1e36c4e775b2b210d0336feaf3f446ee8 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Thu, 18 Apr 2024 22:14:59 +0800 Subject: [PATCH 5/7] feat(f2elint): bump dependencies --- packages/f2elint/package.json | 4 ++-- packages/f2elint/src/index.ts | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/f2elint/package.json b/packages/f2elint/package.json index f868ec8..e2470ca 100644 --- a/packages/f2elint/package.json +++ b/packages/f2elint/package.json @@ -71,12 +71,12 @@ "chalk": "^5.3.0", "command-exists": "^1.2.9", "commander": "^12.0.0", - "init-roll": "^1.2.0", + "init-roll": "^1.3.0", "prettier-config-ali": "workspace:^" }, "devDependencies": { "@types/command-exists": "^1.2.3", - "@types/node": "^20.12.5", + "@types/node": "^20.12.7", "eslint": "^8.57.0", "eslint-config-ali": "workspace:^", "eslint-config-prettier": "^9.1.0", diff --git a/packages/f2elint/src/index.ts b/packages/f2elint/src/index.ts index 2124a17..aeb56cb 100644 --- a/packages/f2elint/src/index.ts +++ b/packages/f2elint/src/index.ts @@ -24,6 +24,7 @@ export async function f2elint(project: string | null = '.', options: F2elintOpti init(join(__dirname, '..', 'templates', t), projectFullPath, options, { disableLog: options.disableLog, prettier, + bumpDependencies: true, }); await initTemplate('base'); From 10180c0ae78ce2bb94f55125f474adc41f219ca3 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Thu, 18 Apr 2024 22:15:58 +0800 Subject: [PATCH 6/7] docs(f2elint): changelog --- packages/f2elint/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/f2elint/CHANGELOG.md b/packages/f2elint/CHANGELOG.md index 9713967..c6a1003 100644 --- a/packages/f2elint/CHANGELOG.md +++ b/packages/f2elint/CHANGELOG.md @@ -1,5 +1,9 @@ # 更新日志 +## 4.7.0 - 2024-04-18 + +- 自动更新依赖版本 + ## 4.6.0 - 2024-04-07 - Prettier 格式化创建/更新的文件 From c259009ad27dcf8f1e49a0f19544d12378ccfc87 Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Thu, 18 Apr 2024 22:16:36 +0800 Subject: [PATCH 7/7] chore(f2elint): version --- packages/f2elint/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/f2elint/package.json b/packages/f2elint/package.json index e2470ca..0dbd955 100644 --- a/packages/f2elint/package.json +++ b/packages/f2elint/package.json @@ -1,6 +1,6 @@ { "name": "f2elint", - "version": "4.6.2", + "version": "4.7.0", "description": "Linter for Alibaba F2E Guidelines", "keywords": [ "f2elint",