Merge pull request #76 from creyD/dev

Bugfix for #74

Dockerfile

@@ -1,3 +0,0 @@
-FROM node:latest
-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,143 @@ 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) |
-| commit_options | :x: | No options. | 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: | - | Custom git publish branch, use ${{ github.head_ref }} if used in pull requests |
+| 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 |
+| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
+| working_directory | :x: | `false` | 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 |
+| 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` |
+| 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)
+
+> 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:
-
+> 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: Prettier for JS Code
+name: Continuous Integration
 
-on: [pull_request]
+# This action works with pull requests and pushes
+on:
+  pull_request:
+  push:
+    branches:
+    - main
 
 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@v1.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@v4.1
       with:
-        prettier_options: '--no-semi --write src/**/*.js'
-        branch: ${{ github.head_ref }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # This part is also where you can pass other options, for example:
+        prettier_options: --write **/*.{js,md}
 ```
 
-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: [main]
+
+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@v4.1
+      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@v2
+      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.1
+      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@v2
+      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.1
+      with:
+        dry: True
+        github_token: ${{ secrets.PERSONAL_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,37 +1,81 @@
-name: "Prettier Action"
-description: "Automatically runs prettier on all your pull requests."
+name: Prettier Action
+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!"
+  commit_description:
+    description: Extended commit message, will be ignored if used with same_commit
+    required: false
+    default: ""
+  same_commit:
+    description: Update the current commit instead of creating a new one
+    required: false
+    default: false
   commit_options:
     description: Commit options
     required: false
+  push_options:
+    description: Git push 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
+    description: Options for the `prettier` command
     required: false
     default: "--write **/*.js"
-  branch:
-    description: Branch which the changes are merged to
-    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
+  prettier_version:
+    description: Specific version of prettier (by default just use the latest version)
+    required: false
+    default: false
+  working_directory:
+    description: Specify a directory to cd into before installing prettier and running it
+    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/plugin-php @prettier/plugin-other`
+    required: false
+    default: ""
+  github_token:
+    description: GitHub Token or PAT token used to authenticate against a repository
+    required: false
+    default: ${{ github.token }}
 
 runs:
-  using: "docker"
-  image: "Dockerfile"
-  args:
-    - ${{ inputs.commit_message }}
-    - ${{ inputs.commit_options }}
-    - ${{ inputs.file_pattern }}
-    - ${{ inputs.prettier_options }}
-    - ${{ inputs.branch }}
+  using: "composite"
+  steps:
+    - name: Prettify code!
+      shell: bash
+      run: >-
+        PATH=$(cd $GITHUB_ACTION_PATH; npm bin):$PATH
+        ${{ github.action_path }}/entrypoint.sh
+      env:
+        INPUT_COMMIT_MESSAGE: ${{ inputs.commit_message }}
+        INPUT_COMMIT_DESCRIPTION: ${{ inputs.commit_description }}
+        INPUT_SAME_COMMIT: ${{ inputs.same_commit }}
+        INPUT_COMMIT_OPTIONS: ${{ inputs.commit_options }}
+        INPUT_FILE_PATTERN: ${{ inputs.file_pattern }}
+        INPUT_PRETTIER_OPTIONS: ${{ inputs.prettier_options }}
+        INPUT_DRY: ${{ inputs.dry }}
+        INPUT_PRETTIER_VERSION: ${{ inputs.prettier_version }}
+        INPUT_ONLY_CHANGED: ${{ inputs.only_changed }}
+        INPUT_PRETTIER_PLUGINS: ${{ inputs.prettier_plugins }}
+        INPUT_WORKING_DIRECTORY: ${{ inputs.working_directory }}
+        INPUT_GITHUB_TOKEN: ${{ inputs.github_token }}
 
 branding:
   icon: "award"

entrypoint.sh

@@ -1,41 +1,143 @@
-#!/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
-set -eux
+#!/bin/bash
+# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
+# x would be for showing the commands before they are executed
+set -eu
+shopt -s globstar
 
+# 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 ( ) {
-  cat <<- EOF > $HOME/.netrc
-        machine github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
-        machine api.github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
+_git_setup ( ) {
+    cat <<- EOF > $HOME/.netrc
+      machine github.com
+      login $GITHUB_ACTOR
+      password $INPUT_GITHUB_TOKEN
+      machine api.github.com
+      login $GITHUB_ACTOR
+      password $INPUT_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..."
-npm install --silent --global prettier
-echo "Prettifing files..."
-prettier $INPUT_PRETTIER_OPTIONS || echo "Problem while prettifying your files!"
+# Checks if any files are changed
+_git_changed() {
+    [[ -n "$(git status -s)" ]]
+}
 
-if ! git diff --quiet
-then
-  echo "Commiting and pushing changes..."
-  # Calling method to configure the git environemnt
-  git_setup
-  # Switch to the actual branch
-  git checkout $INPUT_BRANCH
-  # Add changes to git
-  git add "${INPUT_FILE_PATTERN}"
-  # 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 --set-upstream origin "HEAD:$INPUT_BRANCH"
-  echo "Changes pushed successfully."
+_git_changes() {
+    git diff
+}
+
+(
+# PROGRAM
+# Changing to the directory
+cd "$GITHUB_ACTION_PATH"
+
+echo "Installing prettier..."
+
+case $INPUT_WORKING_DIRECTORY in
+    false)
+        ;;
+    *)
+        cd $INPUT_WORKING_DIRECTORY
+        ;;
+esac
+
+case $INPUT_PRETTIER_VERSION in
+    false)
+        npm install --silent prettier
+        ;;
+    *)
+        npm install --silent 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
+)
+
+PRETTIER_RESULT=0
+echo "Prettifying files..."
+echo "Files:"
+prettier $INPUT_PRETTIER_OPTIONS \
+  || { PRETTIER_RESULT=$?; echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"; exit 1; }
+
+# Ignore node modules and other action created files
+if [ -d 'node_modules' ]; then
+  rm -r node_modules/
 else
+  echo "No node_modules/ folder."
+fi
+
+if [ -f 'package-lock.json' ]; then
+  git checkout -- package-lock.json
+else
+  echo "No package-lock.json file."
+fi
+
+# To keep runtime good, just continue if something was changed
+if _git_changed; then
+  # case when --write is used with dry-run so if something is unpretty there will always have _git_changed
+  if $INPUT_DRY; then
+    echo "Unpretty Files Changes:"
+    _git_changes
+    echo "Finishing dry-run. Exiting before committing."
+    exit 1
+  else
+    # Calling method to configure the git environemnt
+    _git_setup
+
+    if $INPUT_ONLY_CHANGED; then
+      # --diff-filter=d excludes deleted files
+      OLDIFS="$IFS"
+      IFS=$'\n'
+      for file in $(git diff --name-only --diff-filter=d HEAD^..HEAD)
+      do
+        git add "$file"
+      done
+      IFS="$OLDIFS"
+    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
+      if [ "$INPUT_COMMIT_DESCRIPTION" != "" ]
+      then
+          git commit -m "$INPUT_COMMIT_MESSAGE" -m "$INPUT_COMMIT_DESCRIPTION" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
+      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"
+      fi
+      git push origin ${INPUT_PUSH_OPTIONS:-}
+    fi
+    echo "Changes pushed successfully."
+  fi
+else
+  # case when --check is used so there will never have something to commit but there are unpretty files
+  if [ "$PRETTIER_RESULT" -eq 1 ]; then
+    echo "Prettier found unpretty files!"
+    exit 1
+  else
+    echo "Finishing dry-run."
+  fi
+  echo "No unpretty files!"
   echo "Nothing to commit. Exiting."
 fi