From 6c3c102255fb4b1628be21ff61c609617f888969 Mon Sep 17 00:00:00 2001 From: Roger Sheen Date: Mon, 1 Mar 2021 00:25:35 +0100 Subject: [PATCH] Fix plugin name syntax in README & description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The entrypoint script checks for correctly named Prettier plugins on [lines 44–45](https://github.com/creyD/prettier_action/blob/master/entrypoint.sh#L44-L45), but the description in the config file and README are not consistent. This updates those references to clarify how plugins should be specified. --- README.md | 2 +- action.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e689898..025a7bf 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ A GitHub action for styling files with [prettier](https://prettier.io). | 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` | +| 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)| > 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. diff --git a/action.yml b/action.yml index a0d155c..6aef0b8 100644 --- a/action.yml +++ b/action.yml @@ -36,7 +36,7 @@ inputs: required: false default: false prettier_plugins: - description: Install Prettier plugins, i.e. `@prettier/prettier-php @prettier/some-other-plugin` + description: Install Prettier plugins, i.e. `@prettier/plugin-php @prettier/plugin-other` required: false default: ''