Merge pull request #36 from creyD/dev

New prettier-plugin feature

Dockerfile

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

README.md

@@ -1,6 +1,12 @@
 # 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).
 
@@ -10,65 +16,78 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 
 | 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_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. |
+| 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 | :white_check_mark: | - | There are two types of action triggers in GitHub: on pull request and on push. The branch needs to be defined for both, but in case of the pull request trigger it should have `${{ github.head_ref }}` and on push it should have the branch the trigger is designed for. |
+| 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
 
-#### Example - On Pull Request
-
-This is a small example of what your `action.yml` could look like (on pull request mode):
-
+#### 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
-      uses: actions/checkout@v1
+    - name: Checkout
+      uses: actions/checkout@v2
       with:
-        fetch-depth: 1
-    - name: Prettify the JS Code
-      uses: creyD/prettier_action@v2.0
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v3.1
       with:
-        prettier_options: '--no-semi --write *.js'
-        branch: ${{ github.head_ref }}
+        # This part is also where you can pass other options, for example:
+        prettier_options: --write **/*.{js,md}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-#### Example - On Push
-
+#### Example 2 (using the only_changed or same_commit option on PR)
 ```yaml
-name: Prettier for JS Code
+name: Continuous Integration
 
 on:
-  push:
+  pull_request:
     branches: [master]
 
 jobs:
-  cleanup_tasks:
+  prettier:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Cloning the repository
-      uses: actions/checkout@v1
+    - name: Checkout
+      uses: actions/checkout@v2
       with:
-        fetch-depth: 1
-    - name: Prettify the JS Code
-      uses: creyD/prettier_action@v2.0
+        # 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:
-        prettier_options: '--no-semi --write *.js'
-        branch: master
+        # 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 }}
 ```

action.yml

@@ -5,27 +5,40 @@ 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!'
+  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: '*'
   prettier_options:
     description: Options for the `prettier` command
     required: false
     default: '--write **/*.js'
-  branch:
-    description: Target branch for the changes
-    required: true
   dry:
     description: Running the script in dry mode just shows whether there are files that should be prettified or not
     required: false
-    default: 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'

entrypoint.sh

@@ -25,41 +25,64 @@ _git_changed() {
     [[ -n "$(git status -s)" ]]
 }
 
-# Pushes to the according upstream (origin or input branch)
-_git_push() {
-    if [ -z "$INPUT_BRANCH" ]
-    then
-        git push origin
-    else
-        git push --set-upstream origin "HEAD:$INPUT_BRANCH"
-    fi
-}
-
 # PROGRAM
 echo "Installing prettier..."
-npm install --silent --global prettier
+case $INPUT_PRETTIER_VERSION in
+    false)
+        npm install --silent --global prettier
+        ;;
+    *)
+        npm install --silent --global prettier@$INPUT_PRETTIER_VERSION
+        ;;
+esac
+
+# Install plugins
+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 _git_changed; then
   if $INPUT_DRY; then
-    echo "Prettier found unpretty files."
+    echo "Prettier found unpretty files!"
     exit 1
   else
     # Calling method to configure the git environemnt
     _git_setup
-    echo "Commiting and pushing changes..."
-    # Switch to the actual branch
-    git checkout $INPUT_BRANCH || echo "Problem checking out the specified branch: $INPUT_BRANCH"
-    # Add changes to git
-    git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}"
+
+    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
-    git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"}
-    _git_push
+    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