https://github.com/workofstan/prettier-fix
Automatically apply Prettier formatting and create a pull request to fix code style issues, ensuring compatibility with Super-Linter.
https://github.com/workofstan/prettier-fix
code-quality continuous-integration prettier super-linter
Last synced: 3 months ago
JSON representation
Automatically apply Prettier formatting and create a pull request to fix code style issues, ensuring compatibility with Super-Linter.
- Host: GitHub
- URL: https://github.com/workofstan/prettier-fix
- Owner: WorkOfStan
- License: mit
- Created: 2024-08-20T22:01:12.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-01T21:42:20.000Z (4 months ago)
- Last Synced: 2025-04-02T18:07:57.010Z (3 months ago)
- Topics: code-quality, continuous-integration, prettier, super-linter
- Homepage:
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Prettier-Fix
With the release of [Super-Linter](https://github.com/super-linter/super-linter) 7.0.0, [Prettier](https://prettier.io/) has become the standard for many file formats, ensuring consistent code styling across your projects. Embrace this change and keep your codebase looking sharp by integrating Prettier directly into your workflow. While you can still rely on your favorite IDE to apply Prettier's formatting, why not automate the process with this GitHub Action using vanilla Prettier?
## Features
- **Automatic Fixes:** Automatically formats code using Prettier.
- **Flexible Committing:** Creates a new branch (prefixed with `prettier/fix`) if changes are required, making it easy to review and merge. Or you can set the input parameter `commit-changes: true` to commit to the current branch. (Recommendation: start with committing to another branch and review in order to avoid surprises. Then commit to the same branch for incremental changes.)
- **Configurable:** Allows for customizable commit messages via the `commit-message` input.
- Provides the branch name as an output for downstream workflows.
- Issues warnings for manual changes needed in `.github/workflows` files.
## How to Use It
To automate Prettier, simply add [the provided YAML configuration](.github/workflows/prettier-fix.yml) to your repository.
By default, if necessary, a new branch with a name starting with `prettier/fix` will be created, making it easy to review and merge fixes into your main branch.
Note: This action is non-blocking, so the status remains green even when changes are proposed via a new branch.
A notice message is displayed, and it is then up to you to either create a pull request to merge the changes or delete the branch.
### Permissions
This action requires the following permissions:
```yaml
permissions:
contents: write
```
### Inputs (all optional)
| Input | Description | Type | Default |
| -------------------- | ------------------------------------------------------------------------------ | ------- | ---------------------------------------- |
| `commit-changes` | If `true`, commits changes to the current branch instead of creating a new one | Boolean | `false` |
| `commit-message` | Commit message for the changes | String | `"Prettier fixes applied automatically"` |
| `node-version` | Node.js version to use | String | `"20"` |
| `skip-package-setup` | If `true`, skips `npm init` and dependency installation steps | Boolean | `false` |
Note: it would be possible to use `git-user-name` and `git-user-email` as inputs to set-up the info about the author of the commits, but for clarity [actions/checkout](https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-using-the-built-in-token) recommends
```
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
```
Btw: GitHub displays the author's name according to a known email.
### Outputs
| Output | Description |
| ------------- | ----------------------------------- |
| `branch-name` | The name of the branch created/used |
## Important Note for Workflow YAMLs
If the changes involve files within the `.github/workflows/` directory, these cannot be done automatically and need to be updated manually.
So, it also checks for any changes made to the `.github/workflows` directory and issues a warning if changes are detected, advising you to manually review and fix these to avoid conflicts with Super-Linter.
After making the necessary adjustments, simply create a pull request to finalize the changes and keep your repository in top shape.