mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-12 19:30:30 +02:00
163 lines
6.2 KiB
Markdown
163 lines
6.2 KiB
Markdown
# GitHub Prettier Action
|
|
|
|
[](https://www.codefactor.io/repository/github/creyd/prettier_action/overview/master)
|
|
[](https://github.com/prettier/prettier)
|
|
[](https://github.com/creyD/prettier_action/blob/master/LICENSE)
|
|
[](https://github.com/creyD/prettier_action/releases)
|
|
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
|
[](https://github.com/creyD/prettier_action/issues)
|
|
|
|
A GitHub action for styling files with [prettier](https://prettier.io).
|
|
|
|
## Usage
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Required | Default | Description |
|
|
| - | :-: | :-: | - |
|
|
| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. Recommended to use with prettier_options --check |
|
|
| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
|
|
| working_directory | :x: | `false` | Specify a directory to cd into before installing prettier and running it, use relative file path to the repository root for example `app/` |
|
|
| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
|
|
| commit_options | :x: | - | Custom git commit options |
|
|
| push_options | :x: | - | Custom git push options |
|
|
| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) |
|
|
| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` |
|
|
| commit_description | :x: | - | Custom git extended commit message, will be ignored if used with `same_commit` |
|
|
| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
|
|
| prettier_plugins | :x: | - | Install Prettier plugins, i.e. `"@prettier/plugin-php" "@prettier/plugin-other"`. Must be wrapped in quotes since @ is a reserved character in YAML. |
|
|
| only_changed | :x: | `false` | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)|
|
|
| github_token | :x: | `${{ github.token }}` | The default [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
|
|
|
|
> Note: using the same_commit option may lead to problems if other actions are relying on the commit being the same before and after the prettier action has ran. Keep this in mind.
|
|
|
|
### Example Config
|
|
|
|
> Hint: if you still use the old naming convention or generally a different branch name, please replace the `main` in the following configurations.
|
|
|
|
#### Example 1 (run on push in branch main)
|
|
|
|
```yaml
|
|
name: Continuous Integration
|
|
|
|
# This action works with pull requests and pushes
|
|
on:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
prettier:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
# Make sure the actual branch is checked out when running on pull requests
|
|
ref: ${{ github.head_ref }}
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.2
|
|
with:
|
|
# This part is also where you can pass other options, for example:
|
|
prettier_options: --write **/*.{js,md}
|
|
```
|
|
|
|
#### Example 2 (using the only_changed or same_commit option on PR)
|
|
|
|
```yaml
|
|
name: Continuous Integration
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
prettier:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
# Make sure the actual branch is checked out when running on pull requests
|
|
ref: ${{ github.head_ref }}
|
|
# This is important to fetch the changes to the previous commit
|
|
fetch-depth: 0
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.2
|
|
with:
|
|
# This part is also where you can pass other options, for example:
|
|
prettier_options: --write **/*.{js,md}
|
|
only_changed: True
|
|
```
|
|
|
|
#### Example 3 (using a custom access token on PR)
|
|
|
|
```yaml
|
|
name: Continuous Integration
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
prettier:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
ref: ${{ github.head_ref }}
|
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
|
persist-credentials: false
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.2
|
|
with:
|
|
prettier_options: --write **/*.{js,md}
|
|
only_changed: True
|
|
# Set your custom token
|
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
|
```
|
|
|
|
#### Example 4 (dry run)
|
|
|
|
```yaml
|
|
name: Continuous Integration
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
prettier:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
ref: ${{ github.head_ref }}
|
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
|
persist-credentials: false
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.2
|
|
with:
|
|
dry: True
|
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
|
```
|
|
|
|
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
|
|
|
## Issues
|
|
|
|
Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/prettier_action/issues/new). Thanks!
|