https://github.com/gulpjs/prettier_action

GitHub action for running prettier on your projects pull requests
https://github.com/gulpjs/prettier_action

Last synced: 9 months ago
JSON representation

GitHub action for running prettier on your projects pull requests

• Host: GitHub
• URL: https://github.com/gulpjs/prettier_action
• Owner: gulpjs
• License: mit
• Fork: true (creyD/prettier_action)
• Created: 2020-01-20T21:09:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-09T01:56:28.000Z (about 6 years ago)
• Last Synced: 2024-10-30T00:55:59.400Z (over 1 year ago)
• Language: Shell
• Size: 39.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# GitHub Prettier Action

[![CodeFactor](https://www.codefactor.io/repository/github/creyd/prettier_action/badge/master)](https://www.codefactor.io/repository/github/creyd/prettier_action/overview/master)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![License MIT](https://img.shields.io/github/license/creyD/prettier_action)](https://github.com/creyD/prettier_action/blob/master/LICENSE)

[![Latest Release](https://img.shields.io/github/v/release/creyD/prettier_action)](https://github.com/creyD/prettier_action/releases)

[![Contributors](https://img.shields.io/github/contributors-anon/creyD/prettier_action)](https://github.com/creyD/prettier_action/graphs/contributors)

[![Issues](https://img.shields.io/github/issues/creyD/prettier_action)](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. |

| prettier_version | :x: | False | Specific prettier version (by default use latest) |

| prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) |

| commit_options | :x: | - | Custom git commit options |

| commit_message | :x: | Prettified Code! | Custom git commit message |

| file_pattern | :x: | * | Custom git add file pattern |

| branch (depreciated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events |

### Example Config

```yaml

name: Continuous Integration

# This action works with pull requests and pushes

on:

  pull_request:

  push:

    branches:

    - master

jobs:

  prettier:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout

      uses: actions/checkout@v2

      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@v2.2

      with:

        # This part is also where you can pass other options, for example:

        prettier_options: --write **/*.{js,md}

```

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!