mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-23 05:40:44 +00:00
docs/plugins: rename to 'quirks' to be more general
This commit is contained in:
parent
318e972a77
commit
5c09def08e
3 changed files with 24 additions and 21 deletions
|
@ -1,16 +0,0 @@
|
||||||
# Plugin specific quirks {#ch-plugins}
|
|
||||||
|
|
||||||
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
|
|
||||||
```{=include=} chapters
|
|
||||||
plugins/page.md
|
|
||||||
```
|
|
||||||
-->
|
|
13
docs/manual/quirks.md
Normal file
13
docs/manual/quirks.md
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
# Known Issues and Quirks {#ch-known-issues-quirks}
|
||||||
|
|
||||||
|
At times, certain plugins and modules may refuse to play nicely with your setup,
|
||||||
|
be it a result of generating Lua from Nix, or the state of packaging. This page,
|
||||||
|
in turn, will list any known modules or plugins that are known to misbehave, and
|
||||||
|
possible workarounds that you may apply.
|
||||||
|
|
||||||
|
<!-- If adding a new known quirk, please create a new page in quirks/ and include
|
||||||
|
the name of the file here.-->
|
||||||
|
|
||||||
|
```{=include=} chapters
|
||||||
|
quirks/nodejs.md
|
||||||
|
```
|
|
@ -1,16 +1,22 @@
|
||||||
# NodeJS {#ch-plugins-nodejs}
|
# NodeJS {#ch-quirks-nodejs}
|
||||||
|
|
||||||
## eslint-plugin-prettier {#sec-eslint-plugin-prettier}
|
## eslint-plugin-prettier {#sec-eslint-plugin-prettier}
|
||||||
|
|
||||||
When working with NodeJS, everything works as expected, but some projects have settings that can fool nvf.
|
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`).
|
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.
|
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))
|
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.
|
In the end, you get discrepancies between what your editor does and what it
|
||||||
|
wants.
|
||||||
|
|
||||||
Solutions are:
|
Solutions are:
|
||||||
|
|
Loading…
Reference in a new issue