halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-22 10:58:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
18bab504987fb5060ebabbcdd1261a94e75e8e60
docs/versioned_docs/version-1.5/developer-guide/core/code-style.md
Ryan Wang 4921736046 refactor: document versioning structure (#99) 
重构文档版本结构。

- 移除 1.5/1.4 相关所有 patch 版本的文档，使用 1.5/1.4 版本号代替。
- 创建 1.6 的文档版本。
- 后续针对 1.5 或者 1.6 的更新，可以直接对具体版本进行更改。

本打算使用 [@docusaurus/plugin-client-redirects](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-client-redirects) 做已删除的 patch 版本的重定向，旦可能不是很好满足匹配重定向的需求。~~所以在此 PR 合并之前我将通过 Nginx 对具体版本进行重定向转发~~。

比如：`/1.4.17/{path}` 重定向到 `/1.4/{path}`，`/1.5.4/{path}` `/1.5.3/{path}` 都从定向到 `/1.5/{path}`

/kind documentation
/cc @halo-dev/sig-docs 

> PS: 此 PR 未对新发布的 [1.6.0](https://github.com/halo-dev/halo/releases/tag/v1.6.0) [1.5.5](https://github.com/halo-dev/halo/releases/tag/v1.5.5) [2.0.0-alpha.2](https://github.com/halo-dev/halo/releases/tag/v2.0.0-alpha.2) 做修改，将在后续 PR 更改。

```release-note
None
```
2022-10-13 03:58:14 +00:00

1.1 KiB
Raw Blame History

title, description
title description
代码风格 代码风格的相关配置说明

Halo 添加了 checkstyle 插件，来保证每位提交者代码的风格保持一致，减少无效代码的修改。本篇文章主要讲解如何在 IDEA 中添加 CheckStyle 插件，并引入项目所提供的 checkstyle.xml 配置。

安装 CheckStyle-IDEA

  • 进入 IDEA 插件市场。
  • 搜索 CheckStyle-IDEA，点击安装即可。

配置 CheckStyle

  • 进入 CheckStyle 配置（File | Settings | Tools | Checkstyle）。
  • 选择 Checkstyle 版本：8.39。
  • 在配置文件中点击添加按钮，配置描述可随便填写（推荐 Halo Checks），选择 ./config/checkstyle/checkstyle.xml，点击下一步和完成；
  • 勾选刚刚创建的配置文件。

配置 Editor

  • 进入编辑器配置（File | Settings | Editor | Code Style）

  • 导入 checkstyle.xm 配置：

image.png

  • 选择 ./config/checkstyle/checkstyle.xml 配置文件，点击确定即可。

至此，有关代码风格检查工具和格式化配置已经完成。