Prettier Java 插件使用教程

1. 项目目录结构及介绍

Prettier Java 插件的项目目录结构如下：

prettier-java/
├── benchmark/
│   └── java-parser/
├── docs/
├── logo/
├── packages/
│   ├── prettier-plugin-java/
│   └── java-parser/
├── scripts/
├── website/
├── .eslintignore
├── .eslintrc.yml
├── .gitignore
├── .huskyrc.js
├── .prettierignore
├── .prettierrc.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── NOTICE
├── README.md
├── RELEASE.md
├── lerna.json
├── package.json
└── yarn.lock

目录结构介绍

• benchmark/: 包含性能测试相关的文件。
• docs/: 包含项目文档。
• logo/: 包含项目Logo。
• packages/: 包含两个主要包：
  • prettier-plugin-java/: Prettier Java 插件的核心代码。
  • java-parser/: 使用 Chevrotain 实现的 Java 解析器。
• scripts/: 包含项目脚本。
• website/: 包含项目网站相关文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.yml: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .huskyrc.js: Husky 配置文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc.yaml: Prettier 配置文件。
• CHANGELOG.md: 项目变更日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• NOTICE: 项目通知。
• README.md: 项目自述文件。
• RELEASE.md: 发布说明。
• lerna.json: Lerna 配置文件。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Prettier Java 插件没有传统意义上的“启动文件”，因为它是一个代码格式化工具，通常在开发过程中通过命令行或 IDE 插件调用。

主要启动命令

• 本地安装:

  npx prettier --write "**/*.java"
  

• 全局安装:

  prettier --write "**/*.java"
  

3. 项目的配置文件介绍

.prettierrc.yaml

这是 Prettier 的主要配置文件，用于定义代码格式化的规则。以下是一个示例配置：

plugins:
  - prettier-plugin-java
tabWidth: 4

配置项说明

• plugins: 指定使用的 Prettier 插件，这里是 prettier-plugin-java。
• tabWidth: 设置缩进宽度，这里是 4 个空格。

其他配置文件

• .eslintrc.yml: ESLint 配置文件，用于代码质量检查。
• .huskyrc.js: Husky 配置文件，用于 Git 钩子管理。
• lerna.json: Lerna 配置文件，用于多包管理。

通过以上配置文件，可以灵活地调整 Prettier Java 插件的行为，以适应不同的项目需求。