mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-14 12:20:30 +02:00
a5f1df5578
This addresses GitHub issue #41 by adding an optional `use_repo_config` parameter that allows the action to automatically detect and use the repository's prettier configuration files and .prettierignore. Changes: - Added `use_repo_config` input parameter (default: false for backward compatibility) - Implemented config file detection in entrypoint.sh for all prettier config formats - Automatically changes file pattern to current directory when using repo config - Provides helpful messages about found config files and warnings when none exist - Updated README with new parameter documentation and Example 5 Benefits: - Users no longer need to manually specify --config or --ignore-path - Eliminates confusion about whether config files are being used - Maintains backward compatibility (opt-in via parameter) - Supports all prettier configuration file formats Related: #41
228 lines
14 KiB
Markdown
228 lines
14 KiB
Markdown
# GitHub Prettier Action
|
|
|
|
[](https://www.codefactor.io/repository/github/creyd/prettier_action/overview/master)
|
|
[](https://app.codacy.com/gh/creyD/prettier_action/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
|
[](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 |
|
|
| no_commit | :x: | `false` | Can be used to avoid committing the changes (useful when another workflow step commits after this one anyways; can be combined with dry mode) |
|
|
| prettier_version | :x: | `latest` | Specific prettier version (by default use latest) |
|
|
| working_directory | :x: | `${{ github.action_path }}` | 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 |
|
|
| add_options | :x: | - | Custom `git add` options, e.g. `--update` to only add already known files. |
|
|
| 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. |
|
|
| clean_node_folder | :x: | `true` | Delete the node_modules folder before committing |
|
|
| 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) |
|
|
| git_identity | :x: | `actions` | Set to `author` to use author's user as committer. This allows triggering [further workflow runs](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) |
|
|
| allow_other_plugins | :x: | `false` | Allow other plugins to be installed (prevents the @prettier-XYZ regex check) |
|
|
| use_repo_config | :x: | `false` | Automatically use the repository's prettier configuration files (.prettierrc, prettier.config.js, etc.) and .prettierignore. When enabled, prettier will search for and use config files in your repository, eliminating the need to specify `--config` or `--ignore-path` manually. |
|
|
|
|
> 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@v5
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.6
|
|
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@v5
|
|
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.6
|
|
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@v5
|
|
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.6
|
|
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@v5
|
|
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.6
|
|
with:
|
|
dry: True
|
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
|
```
|
|
|
|
#### Example 5 (using repository prettier configuration)
|
|
|
|
This example demonstrates the `use_repo_config` option, which automatically detects and uses your repository's prettier configuration files (`.prettierrc`, `prettier.config.js`, etc.) and `.prettierignore` file.
|
|
|
|
```yaml
|
|
name: Continuous Integration
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
prettier:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.6
|
|
with:
|
|
# Automatically use repository's prettier config and .prettierignore
|
|
use_repo_config: true
|
|
```
|
|
|
|
With `use_repo_config: true`, the action will:
|
|
- Search for prettier configuration files in your repository (.prettierrc, prettier.config.js, package.json, etc.)
|
|
- Automatically use your .prettierignore file if present
|
|
- Apply prettier to all supported files in your repository
|
|
- Warn you if no configuration file is found (prettier will use defaults)
|
|
|
|
You can still customize the file pattern if needed:
|
|
|
|
```yaml
|
|
- name: Prettify code
|
|
uses: creyD/prettier_action@v4.6
|
|
with:
|
|
use_repo_config: true
|
|
prettier_options: --write "src/**/*.{js,ts,jsx,tsx}"
|
|
```
|
|
|
|
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!
|
|
|
|
### Problem with NPM v9 (19.02.2023)
|
|
|
|
This issue was discussed in https://github.com/creyD/prettier_action/issues/113. The action until release 4 uses the npm bin command, which apparently doesn't work on npm v9. A fix is introduced with v4.3 of this action. If you need an older version of the action working it works until v3.3 and between v3.3 and v4.2 you could use the workaround described in https://github.com/creyD/prettier_action/issues/113 by adding the below to your workflow file:
|
|
|
|
```
|
|
- name: Install npm v8
|
|
run: npm i -g npm@8
|
|
```
|
|
|
|
## Star History
|
|
|
|
<a href="https://www.star-history.com/#creyD/prettier_action&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=creyD/prettier_action&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=creyD/prettier_action&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=creyD/prettier_action&type=Date" />
|
|
</picture>
|
|
</a>
|