Merge pull request #109 from creyD/dev

Minor Readme Updates

README.md

@@ -25,7 +25,8 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 | 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` |
+| 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)
 
@@ -53,7 +54,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # Make sure the actual branch is checked out when running on pull requests
           ref: ${{ github.head_ref }}
@@ -80,7 +81,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # Make sure the actual branch is checked out when running on pull requests
           ref: ${{ github.head_ref }}
@@ -110,7 +111,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
           ref: ${{ github.head_ref }}
@@ -141,7 +142,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
           ref: ${{ github.head_ref }}
@@ -160,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

@@ -54,6 +54,10 @@ inputs:
     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: "composite"
@@ -61,7 +65,7 @@ runs:
     - name: Prettify code!
       shell: bash
       run: >-
-        PATH=$(cd $GITHUB_ACTION_PATH; npm bin):$PATH
+        PATH=$GITHUB_ACTION_PATH/node_modules/.bin:$PATH
         ${{ github.action_path }}/entrypoint.sh
       env:
         INPUT_COMMIT_MESSAGE: ${{ inputs.commit_message }}
@@ -76,6 +80,7 @@ runs:
         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"

entrypoint.sh

@@ -74,11 +74,16 @@ 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."
+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