From 56a019c78ba9b2ef2d6f59283b312821441a897a Mon Sep 17 00:00:00 2001 From: Johannes Ptaszyk Date: Sun, 21 Jan 2024 19:34:45 +0100 Subject: [PATCH 1/2] Update README.md Enhance prettier plugin configuration docs to better differentiate v2 and v3. --- plugin-gradle/README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md index 730a947d49..bfa8733504 100644 --- a/plugin-gradle/README.md +++ b/plugin-gradle/README.md @@ -1086,16 +1086,32 @@ To apply prettier to more kinds of files, just add more formats Since spotless uses the actual npm prettier package behind the scenes, it is possible to use prettier with [plugins](https://prettier.io/docs/en/plugins.html#official-plugins) or [community-plugins](https://www.npmjs.com/search?q=prettier-plugin) in order to support even more file types. +#### prettier version below 3 + ```gradle spotless { java { prettier(['prettier': '2.8.8', 'prettier-plugin-java': '2.2.0']).config(['parser': 'java', 'tabWidth': 4]) - // prettier(['prettier': '3.0.3', 'prettier-plugin-java': '2.3.0']).config(['parser': 'java', 'tabWidth': 4, 'plugins': ['prettier-plugin-java']]) // Prettier v3 requires additional 'plugins' config } format 'php', { target 'src/**/*.php' prettier(['prettier': '2.8.8', '@prettier/plugin-php': '0.19.6']).config(['parser': 'php', 'tabWidth': 3]) - // prettier(['prettier': '3.0.3', '@prettier/plugin-php': '0.20.1']).config(['parser': 'php', 'tabWidth': 3, 'plugins': ['@prettier/plugin-php']]) // Prettier v3 requires additional 'plugins' config + } +} +``` + +#### prettier version 3+ + +With version 3 prettier it is required to pass in an additional 'plugins' parameter to the config block with a list of plugins you want to use. + +```gradle +spotless { + java { + prettier(['prettier': '3.0.3', 'prettier-plugin-java': '2.3.0']).config(['parser': 'java', 'tabWidth': 4, 'plugins': ['prettier-plugin-java']]) + } + format 'php', { + target 'src/**/*.php' + prettier(['prettier': '3.0.3', '@prettier/plugin-php': '0.20.1']).config(['parser': 'php', 'tabWidth': 3, 'plugins': ['@prettier/plugin-php']]) } } ``` From d4b102ce1d06ce98886bbd4737cc9b3ca4dddafb Mon Sep 17 00:00:00 2001 From: Ned Twigg Date: Sun, 21 Jan 2024 22:16:52 -0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Zongle Wang --- plugin-gradle/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md index bfa8733504..4b57a07f02 100644 --- a/plugin-gradle/README.md +++ b/plugin-gradle/README.md @@ -1107,11 +1107,13 @@ With version 3 prettier it is required to pass in an additional 'plugins' parame ```gradle spotless { java { - prettier(['prettier': '3.0.3', 'prettier-plugin-java': '2.3.0']).config(['parser': 'java', 'tabWidth': 4, 'plugins': ['prettier-plugin-java']]) + prettier(['prettier': '3.0.3', 'prettier-plugin-java': '2.3.0']) + .config(['parser': 'java', 'tabWidth': 4, 'plugins': ['prettier-plugin-java']]) } format 'php', { target 'src/**/*.php' - prettier(['prettier': '3.0.3', '@prettier/plugin-php': '0.20.1']).config(['parser': 'php', 'tabWidth': 3, 'plugins': ['@prettier/plugin-php']]) + prettier(['prettier': '3.0.3', '@prettier/plugin-php': '0.20.1']) + .config(['parser': 'php', 'tabWidth': 3, 'plugins': ['@prettier/plugin-php']]) } } ```