Merge pull request #88 from creyD/dev

Minor Feature & Bugfix Update

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,12 +3,12 @@ name: Bug report
 about: Report a problem!
 title: "[BUG]"
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **What exactly happened?**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -21,8 +21,8 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Where did you encounter the problem?**
- - OS: [e.g. iOS]
+
 - Repo: [e.g. URL to your repository]
- - Version [e.g. 22]
+- Version [e.g. 22]
 
 <!-- If you think you can help us with that, please note it here! -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,12 +3,11 @@ name: Feature request
 about: Request a feature!
 title: "[FEATURE]"
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
 
 **What would you like to change about the program?**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is.
 
 **Why do you think this is a cool idea?**
 A clear and concise description of why your feature would improve the program.

README.md

@@ -7,7 +7,6 @@
 [![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
@@ -18,11 +17,13 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 | - | :-: | :-: | - |
 | 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)|
@@ -32,7 +33,10 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 
 ### Example Config
 
-#### Example 1 (run on push in master)
+> 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: Continuous Integration
 
@@ -41,111 +45,114 @@ on:
   pull_request:
   push:
     branches:
-    - master
+      - 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 }}
+      - 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@v4.0
-      with:
-        # This part is also where you can pass other options, for example:
-        prettier_options: --write **/*.{js,md}
+      - name: Prettify code
+        uses: creyD/prettier_action@v4.2
+        with:
+          # This part is also where you can pass other options, for example:
+          prettier_options: --write **/*.{js,md}
 ```
 
 #### Example 2 (using the only_changed or same_commit option on PR)
+
 ```yaml
 name: Continuous Integration
 
 on:
   pull_request:
-    branches: [master]
+    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: 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.0
-      with:
-        # This part is also where you can pass other options, for example:
-        prettier_options: --write **/*.{js,md}
-        only_changed: True
+      - name: Prettify code
+        uses: creyD/prettier_action@v4.2
+        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: [master]
+    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: 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.0
-      with:
-        prettier_options: --write **/*.{js,md}
-        only_changed: True
-        # Set your custom token
-        github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
+      - name: Prettify code
+        uses: creyD/prettier_action@v4.2
+        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: [master]
+    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: 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.0
-      with:
-        dry: True
-        github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
+      - name: Prettify code
+        uses: creyD/prettier_action@v4.2
+        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).

action.yml

@@ -8,6 +8,10 @@ inputs:
     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
@@ -34,6 +38,10 @@ inputs:
     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
@@ -41,13 +49,12 @@ inputs:
   prettier_plugins:
     description: Install Prettier plugins, i.e. `@prettier/plugin-php @prettier/plugin-other`
     required: false
-    default: ''
+    default: ""
   github_token:
     description: GitHub Token or PAT token used to authenticate against a repository
     required: false
     default: ${{ github.token }}
 
-
 runs:
   using: "composite"
   steps:
@@ -58,6 +65,7 @@ runs:
         ${{ 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 }}
@@ -66,6 +74,7 @@ runs:
         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:

entrypoint.sh

@@ -37,6 +37,14 @@ 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
@@ -51,12 +59,12 @@ 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
+        if ! echo "$plugin" | grep -Eq '(@prettier\/plugin-|(@[a-z\-]+\/)?prettier-plugin-){1}([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
+    npm install --silent $INPUT_PRETTIER_PLUGINS
 fi
 )
 
@@ -74,7 +82,7 @@ else
 fi
 
 if [ -f 'package-lock.json' ]; then
-  git reset --hard package-lock.json || rm package-lock.json
+  git checkout -- package-lock.json
 else
   echo "No package-lock.json file."
 fi
@@ -93,10 +101,13 @@ if _git_changed; then
 
     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
+        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}"
@@ -109,7 +120,11 @@ if _git_changed; then
       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"
+      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."