From 1061c920beb46ea441624a5c9665a866a9a33228 Mon Sep 17 00:00:00 2001
From: Yoni Firroloni <pro@yoni-firroloni.com>
Date: Thu, 23 May 2024 01:32:12 +0000
Subject: [PATCH] docs: add quirk about using nodejs (#298)

* doc: add quircks about nodejs

* doc: make shorter sentences
---
 docs/manual/plugins.md        |  3 +++
 docs/manual/plugins/nodejs.md | 18 ++++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 docs/manual/plugins/nodejs.md

diff --git a/docs/manual/plugins.md b/docs/manual/plugins.md
index e56e59f..fa464d1 100644
--- a/docs/manual/plugins.md
+++ b/docs/manual/plugins.md
@@ -4,6 +4,9 @@ At times, certain plugins refuse to play nicely. Be it as a result of generating
 lua from Nix, or the state of packaging. This page shall list any plugins that
 are known to misbehave, and potential workarounds.
 
+```{=include=} chapters
+plugins/nodejs.md
+```
 <!--
 If adding a new section, uncomment this part and add your page to
 plugins/<page>.md
diff --git a/docs/manual/plugins/nodejs.md b/docs/manual/plugins/nodejs.md
new file mode 100644
index 0000000..36b4c79
--- /dev/null
+++ b/docs/manual/plugins/nodejs.md
@@ -0,0 +1,18 @@
+# NodeJS {#ch-plugins-nodejs}
+
+## eslint-plugin-prettier {#sec-eslint-plugin-prettier}
+
+When working with NodeJS, everything works as expected, but some projects have settings that can fool nvf.
+
+If [this plugin](https://github.com/prettier/eslint-plugin-prettier) or similar is included, you might get a situation where your eslint configuration diagnoses your formatting according to its own config (usually `.eslintrc.js`).
+
+The issue there is your formatting is made via prettierd.
+
+This results in auto-formating relying on your prettier config, while your eslint config diagnoses formatting [which it's not supposed to](https://prettier.io/docs/en/comparison.html))
+
+In the end, you get discrepancies between what your editor does and what it wants.
+
+Solutions are:
+
+1. Don't add a formatting config to eslint, and separate prettier and eslint.
+2. PR this repo to add an ESLint formatter and configure nvf to use it.