From 7bf3cfaaf4bbf295ef785e951dc6ffefaf83c670 Mon Sep 17 00:00:00 2001 From: Scott McIntyre Date: Wed, 27 Nov 2024 10:11:16 -0500 Subject: [PATCH] docs(readme): add comment on prettier config --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index dfb174b..682f10d 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,16 @@ To use the Prettier compatible config: } ``` +:warning: The `amex` eslint config enforces single quotes, while Prettier uses double quotes by default. +Enabling the Prettier config will change all the quotes in your files. +To avoid this, add a custom Prettier `.prettierrc` config: + +```json +{ + "singleQuote": true +} +``` + ### (Optionally) Create an `.eslintrc` file in your test directory ```json