Merge pull request #109 from creyD/dev

Minor Readme Updates

.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.

Dockerfile

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

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
@@ -16,21 +15,29 @@ 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. |
+| 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! |
-| branch (deprecated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events |
+| prettier_plugins | :x: | - | Install Prettier plugins, i.e. `"@prettier/plugin-php" "@prettier/plugin-other"`. Must be wrapped in quotes since @ is a reserved character in YAML. |
+| clean_node_folder | :x: | `true` | Delete the node_modules folder before committing |
 | 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
 
-#### 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
 
@@ -39,57 +46,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@v3
+        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@v3.1
-      with:
-        # This part is also where you can pass other options, for example:
-        prettier_options: --write **/*.{js,md}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - 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@v3
+        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 }}
+      - 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: [main]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        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.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: [main]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        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.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).
@@ -97,3 +161,12 @@ More documentation for writing a workflow can be found [here](https://help.githu
 ## Issues
 
 Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/prettier_action/issues/new). Thanks!
+
+### Problem with NPM v9 (19.02.2023)
+
+This issue was discussed in https://github.com/creyD/prettier_action/issues/113. The action until release 4.2 uses the npm bin command, which apparently doesn't work on npm v9. A fix is introduced with v4.3 of this action. If you need an older version of the action working it works until v3.3 and between v3.3 and v4.2 you could use the workaround described in https://github.com/creyD/prettier_action/issues/113 by adding the below to your workflow file:
+
+```
+- name: Install npm v8
+  run: npm i -g npm@8
+```

action.yml

@@ -7,7 +7,11 @@ inputs:
   commit_message:
     description: Commit message, will be ignored if used with same_commit
     required: false
-    default: 'Prettified Code!'
+    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
@@ -15,14 +19,17 @@ inputs:
   commit_options:
     description: Commit options
     required: false
+  push_options:
+    description: Git push options
+    required: false
   file_pattern:
     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
     required: false
-    default: '--write **/*.js'
+    default: "--write **/*.js"
   dry:
     description: Running the script in dry mode just shows whether there are files that should be prettified or not
     required: false
@@ -31,15 +38,50 @@ 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
     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 }}
+  clean_node_folder:
+    description: Remove the node_modules folder before committing changes
+    required: false
+    default: true
 
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: "composite"
+  steps:
+    - name: Prettify code!
+      shell: bash
+      run: >-
+        PATH=$GITHUB_ACTION_PATH/node_modules/.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 }}
+        INPUT_CLEAN_NODE_FOLDER: ${{ inputs.clean_node_folder }}
 
 branding:
-  icon: 'award'
-  color: 'green'
+  icon: "award"
+  color: "green"

entrypoint.sh

@@ -1,7 +1,8 @@
-#!/bin/sh
+#!/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)
@@ -9,10 +10,10 @@ _git_setup ( ) {
     cat <<- EOF > $HOME/.netrc
       machine github.com
       login $GITHUB_ACTOR
-      password $GITHUB_TOKEN
+      password $INPUT_GITHUB_TOKEN
       machine api.github.com
       login $GITHUB_ACTOR
-      password $GITHUB_TOKEN
+      password $INPUT_GITHUB_TOKEN
 EOF
     chmod 600 $HOME/.netrc
 
@@ -25,25 +26,79 @@ _git_changed() {
     [[ -n "$(git status -s)" ]]
 }
 
+_git_changes() {
+    git diff
+}
+
+(
 # PROGRAM
+# Changing to the directory
+cd "$GITHUB_ACTION_PATH"
+
 echo "Installing prettier..."
-case $INPUT_PRETTIER_VERSION in
+
+case $INPUT_WORKING_DIRECTORY in
     false)
-        npm install --silent --global prettier
         ;;
     *)
-        npm install --silent --global prettier@$INPUT_PRETTIER_VERSION
+        cd $INPUT_WORKING_DIRECTORY
         ;;
 esac
 
-echo "Prettifing files..."
+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\-]+\/)?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 $INPUT_PRETTIER_PLUGINS
+fi
+)
+
+PRETTIER_RESULT=0
+echo "Prettifying files..."
 echo "Files:"
-prettier $INPUT_PRETTIER_OPTIONS || echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"
+prettier $INPUT_PRETTIER_OPTIONS \
+  || { PRETTIER_RESULT=$?; echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"; exit 1; }
+
+echo "Prettier result: $PRETTIER_RESULT"
+
+# Removing the node_modules folder, so it doesn't get committed if it is not added in gitignore
+if $INPUT_CLEAN_NODE_FOLDER; then
+  echo "Deleting node_modules/ folder..."
+  if [ -d 'node_modules' ]; then
+    rm -r node_modules/
+  else
+    echo "No node_modules/ folder."
+  fi
+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 "Prettier found unpretty files!"
+    echo "Unpretty Files Changes:"
+    _git_changes
+    echo "Finishing dry-run. Exiting before committing."
     exit 1
   else
     # Calling method to configure the git environemnt
@@ -51,10 +106,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}"
@@ -67,11 +125,23 @@ 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"
-      git push origin
+      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