Known Issues and 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.
NodeJS
eslint-plugin-prettier
When working with NodeJS, which is obviously known for its meticulous standards, most things are bound to work as expected but some projects, tools and settings may fool the default configurations of tools provided by nvf.
If
If 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-formatting relying on your prettier configuration, while your Eslint configuration diagnoses formatting "issues" while it's not supposed to. In the end, you get discrepancies between what your editor does and what it wants.
Solutions are:
- Don't add a formatting config to Eslint, instead separate Prettier and Eslint.
- PR the repo in question to add an ESLint formatter, and configure nvf to use it.
Bugs & Suggestions
Some quirks are not exactly quirks, but bugs in the module system. If you notice any issues with nvf, or this documentation, then please consider reporting them over at the issue tracker. Issues tab, in addition to the discussions tab is a good place as any to request new features.
You may also consider submitting bug fixes, feature additions and upstreamed changes that you think are critical over at the pull requests tab.