Merge pull request #36 from creyD/dev

New prettier-plugin feature

Dockerfile

@@ -1,3 +1,4 @@
-FROM node:latest
+FROM node:lts-alpine3.9
+RUN apk update && apk add --no-cache bash git openssh
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Conrad
+Copyright (c) 2020 Conrad Großer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -14,7 +14,7 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

README.md

@@ -1,5 +1,13 @@
 # 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
@@ -8,41 +16,84 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 
 | Parameter | Required | Default | Description |
 | - | :-: | :-: | - |
-| prettier_options | :x: | --write **/*.js | Prettier options (by default it applies to the whole repository) |
+| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
-| commit_options | :x: | No options. | Custom git commit options |
+| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
-| commit_message | :x: | Prettified Code! | Custom git commit message |
+| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
-| file_pattern | :x: | * | Custom git add file pattern |
+| commit_options | :x: | - | Custom git commit options |
-| branch | :white_check_mark: | - | Custom git publish branch, use ${{ github.head_ref }} if used in pull requests |
+| 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` |
+| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
+| prettier_plugins | :x: | ` ` | Install Prettier plugins, i.e. `@prettier/prettier-php @prettier/some-other-plugin` |
+| 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)|
+
+> 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
 
-This is a small example of what your `action.yml` could look like:
+#### Example 1 (run on push in master)
-
 ```yaml
-name: Prettier for JS Code
+name: Continuous Integration
 
-on: [pull_request]
+# This action works with pull requests and pushes
+on:
+  pull_request:
+  push:
+    branches:
+    - master
 
 jobs:
-  cleanup_tasks:
+  prettier:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Cloning the repository
+    - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
       with:
-        fetch-depth: 1
+        # Make sure the actual branch is checked out when running on pull requests
-    - name: Prettify the JS Code
+        ref: ${{ github.head_ref }}
-      uses: creyD/prettier_action@v1.0
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v3.1
       with:
-        prettier_options: '--no-semi --write src/**/*.js'
+        # This part is also where you can pass other options, for example:
-        branch: ${{ github.head_ref }}
+        prettier_options: --write **/*.{js,md}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-This simple example executes `prettier --no-semi --write src/**/*.js` after someone created a Pull Request on your repository. More documentation can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
+#### Example 2 (using the only_changed or same_commit option on PR)
+```yaml
+name: Continuous Integration
+
+on:
+  pull_request:
+    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 }}
+        # This is important to fetch the changes to the previous commit
+        fetch-depth: 0
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v3.1
+      with:
+        # This part is also where you can pass other options, for example:
+        prettier_options: --write **/*.{js,md}
+        only_changed: True
+      env:
+        GITHUB_TOKEN: ${{ secrets.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).
+Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/prettier_action/issues/new). Thanks!

action.yml

@@ -1,38 +1,49 @@
-name: "Prettier Action"
+name: Prettier Action
-description: "Automatically runs prettier on all your pull requests."
+description: Automatically runs prettier on all your changes.
 
 author: Conrad Großer <grosserconrad@gmail.com>
 
 inputs:
   commit_message:
-    description: Commit message
+    description: Commit message, will be ignored if used with same_commit
     required: false
-    default: "Prettified Code!"
+    default: 'Prettified Code!'
+  same_commit:
+    description: Update the current commit instead of creating a new one
+    required: false
+    default: false
   commit_options:
     description: Commit options
     required: false
   file_pattern:
-    description: File pattern used for "git add"
+    description: File pattern used for `git add`, can't be used with only_changed!
     required: false
-    default: "*"
+    default: '*'
   prettier_options:
-    description: Options for the 'prettier' command
+    description: Options for the `prettier` command
     required: false
-    default: "--write **/*.js"
+    default: '--write **/*.js'
-  branch:
+  dry:
-    description: Branch which the changes are merged to
+    description: Running the script in dry mode just shows whether there are files that should be prettified or not
-    required: true
+    required: false
+    default: false
+  prettier_version:
+    description: Specific version of prettier (by default just use the latest version)
+    required: false
+    default: false
+  only_changed:
+    description: Only prettify files changed in the last commit, can't be used with file_pattern!
+    required: false
+    default: false
+  prettier_plugins:
+    description: Install Prettier plugins, i.e. `@prettier/prettier-php @prettier/some-other-plugin`
+    required: false
+    default: ''
 
 runs:
-  using: "docker"
+  using: 'docker'
-  image: "Dockerfile"
+  image: 'Dockerfile'
-  args:
-    - ${{ inputs.commit_message }}
-    - ${{ inputs.commit_options }}
-    - ${{ inputs.file_pattern }}
-    - ${{ inputs.prettier_options }}
-    - ${{ inputs.branch }}
 
 branding:
-  icon: "award"
+  icon: 'award'
-  color: "green"
+  color: 'green'

entrypoint.sh

@@ -1,41 +1,90 @@
 #!/bin/sh
-# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set, x is for showing the commands before they are executed
+# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
-set -eux
+# x would be for showing the commands before they are executed
+set -eu
 
+# FUNCTIONS
 # Function for setting up git env in the docker container (copied from https://github.com/stefanzweifel/git-auto-commit-action/blob/master/entrypoint.sh)
-git_setup ( ) {
+_git_setup ( ) {
-  cat <<- EOF > $HOME/.netrc
+    cat <<- EOF > $HOME/.netrc
-        machine github.com
+      machine github.com
-        login $GITHUB_ACTOR
+      login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
+      password $GITHUB_TOKEN
-        machine api.github.com
+      machine api.github.com
-        login $GITHUB_ACTOR
+      login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
+      password $GITHUB_TOKEN
 EOF
     chmod 600 $HOME/.netrc
 
     git config --global user.email "actions@github.com"
-    git config --global user.name "GitHub Actions"
+    git config --global user.name "GitHub Action"
 }
 
-echo "Installing prettier..."
+# Checks if any files are changed
-npm install --silent --global prettier
+_git_changed() {
-echo "Prettifing files..."
+    [[ -n "$(git status -s)" ]]
-prettier $INPUT_PRETTIER_OPTIONS || echo "Problem while prettifying your files!"
+}
 
-if ! git diff --quiet
+# PROGRAM
-then
+echo "Installing prettier..."
-  echo "Commiting and pushing changes..."
+case $INPUT_PRETTIER_VERSION in
-  # Calling method to configure the git environemnt
+    false)
-  git_setup
+        npm install --silent --global prettier
-  # Switch to the actual branch
+        ;;
-  git checkout $INPUT_BRANCH
+    *)
-  # Add changes to git
+        npm install --silent --global prettier@$INPUT_PRETTIER_VERSION
-  git add "${INPUT_FILE_PATTERN}"
+        ;;
-  # Commit and push changes back
+esac
-  git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"}
+
-  git push --set-upstream origin "HEAD:$INPUT_BRANCH"
+# Install plugins
-  echo "Changes pushed successfully."
+if [ -n "$INPUT_PRETTIER_PLUGINS" ]; then
+    for plugin in $INPUT_PRETTIER_PLUGINS; do
+        echo "Checking plugin: $plugin"
+        # check regex against @prettier/xyz
+        if ! echo "$plugin" | grep -Eq '(@prettier\/)+(plugin-[a-z\-]+)'; then
+            echo "$plugin does not seem to be a valid @prettier/plugin-x plugin. Exiting."
+            exit 1
+        fi
+    done
+    npm install --silent --global $INPUT_PRETTIER_PLUGINS
+fi
+
+echo "Prettifing files..."
+echo "Files:"
+prettier $INPUT_PRETTIER_OPTIONS || echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"
+
+# To keep runtime good, just continue if something was changed
+if _git_changed; then
+  if $INPUT_DRY; then
+    echo "Prettier found unpretty files!"
+    exit 1
+  else
+    # Calling method to configure the git environemnt
+    _git_setup
+
+    if $INPUT_ONLY_CHANGED; then
+      # --diff-filter=d excludes deleted files
+      for file in $(git diff --name-only --diff-filter=d HEAD^..HEAD)
+      do
+        git add $file
+      done
+    else
+      # Add changes to git
+      git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}"
+    fi
+
+    # Commit and push changes back
+    if $INPUT_SAME_COMMIT; then
+      echo "Amending the current commit..."
+      git pull
+      git commit --amend --no-edit
+      git push origin -f
+    else
+      git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
+      git push origin
+    fi
+    echo "Changes pushed successfully."
+  fi
 else
   echo "Nothing to commit. Exiting."
 fi