Prettier Action 使用教程
1. 项目的目录结构及介绍
prettier_action/
├── action.yml
├── entrypoint.sh
├── node_modules/
├── package.json
├── prettier.config.js
└── README.md
- action.yml: 定义 GitHub Action 的配置文件。
- entrypoint.sh: 脚本文件,用于执行 Prettier 格式化操作。
- node_modules/: 项目依赖的 Node.js 模块。
- package.json: 项目的 npm 配置文件,包含项目依赖和脚本。
- prettier.config.js: Prettier 的配置文件,定义格式化规则。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
entrypoint.sh 是项目的启动文件,负责执行 Prettier 格式化操作。其主要功能如下:
- 安装 Prettier 及相关插件。
- 根据
prettier.config.js
配置文件进行代码格式化。 - 输出格式化结果。
3. 项目的配置文件介绍
action.yml
action.yml
是 GitHub Action 的配置文件,定义了 Action 的输入、输出和运行环境。关键配置如下:
name: 'Prettier Action'
description: 'GitHub action for running prettier on your projects'
inputs:
prettier_options:
description: 'Options to pass to prettier'
required: false
prettier_plugins:
description: 'Plugins to use with prettier'
required: false
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.prettier_options }}
- ${{ inputs.prettier_plugins }}
prettier.config.js
prettier.config.js
是 Prettier 的配置文件,定义了代码格式化的规则。示例如下:
module.exports = {
tabWidth: 2,
useTabs: false,
singleQuote: true,
trailingComma: 'all',
printWidth: 80,
};
这些配置项可以根据项目需求进行调整。
通过以上内容,您可以了解并使用 creyD/prettier_action
项目进行代码格式化。希望本教程对您有所帮助!