NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-12-13 23:51:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

deploy: 13b3916c1c

Browse source
This commit is contained in:
NotAShelf 2025-12-12 11:42:51 +00:00
commit 6075277f2c
121 changed files with 49399 additions and 562075 deletions
Download patch file Download diff file Expand all files Collapse all files

179
quirks.html
View file

@ -1,56 +1,133 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Appendix A. Known Issues and Quirks</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="script/anchor-use.js" type="text/javascript"></script><script src="script/anchor-min.js" type="text/javascript"></script><script src="script/search.js" type="text/javascript"></script>
<meta name="generator" content="nixos-render-docs" />
<link rel="home" href="index.xhtml" title="nvf manual" />
<link rel="up" href="index.xhtml" title="nvf manual" /><link rel="prev" href="index.xhtml" title="nvf manual" /><link rel="next" href="options.html" title="Appendix B. nvf Configuration Options" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Appendix A. Known Issues and Quirks</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="index.xhtml">Prev</a>&nbsp;</td>
<th width="60%" align="center">&nbsp;</th>
<td width="20%" align="right">&nbsp;<a accesskey="n" href="options.html">Next</a></td>
</tr>
</table>
<hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-known-issues-quirks" class="title" >Appendix A. Known Issues and Quirks </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="quirks.html#ch-quirks-nodejs">NodeJS</a> </span></dt> </dl></div><p>At times, certain plugins and modules may refuse to play nicely with your setup,
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Known Issues and Quirks</title>
<script>
// Apply sidebar state immediately to prevent flash
(function () {
if (localStorage.getItem("sidebar-collapsed") === "true") {
document.documentElement.classList.add("sidebar-collapsed");
}
})();
</script>
<link rel="stylesheet" href="assets/style.css" />
<script defer src="assets/main.js"></script>
<script>
window.searchNamespace = window.searchNamespace || {};
window.searchNamespace.rootPath = "";
</script>
<script defer src="assets/search.js"></script>
</head>
<body>
<div class="container">
<header>
<div class="header-left">
<h1 class="site-title">
<a href="index.html">NVF</a>
</h1>
<nav class="header-nav">
<ul>
<li >
<a href="options.html">Options</a>
</li>
<li><a href="search.html">Search</a></li>
</ul>
</nav>
</div>
<div class="search-container">
<input type="text" id="search-input" placeholder="Search..." />
<div id="search-results" class="search-results"></div>
</div>
</header>
<div class="layout">
<div class="sidebar-toggle" aria-label="Toggle sidebar">
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
width="24"
height="24"
>
<path d="M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12z"></path>
</svg>
</div>
<nav class="sidebar">
<div class="docs-nav">
<h2>Documents</h2>
<ul>
<li><a href="index.html">Introduction</a></li>
<li><a href="configuring.html">Configuring nvf</a></li>
<li><a href="hacking.html">Hacking nvf</a></li>
<li><a href="tips.html">Helpful Tips</a></li>
<li><a href="quirks.html">Known Issues and Quirks</a></li>
<li><a href="release-notes.html">Release Notes</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
<div class="toc">
<h2>Contents</h2>
<ul class="toc-list">
<li><a href="#ch-known-issues-quirks">Known Issues and Quirks</a>
<ul><li><a href="#ch-quirks-nodejs">NodeJS</a>
<ul><li><a href="#sec-eslint-plugin-prettier">eslint-plugin-prettier</a>
</ul><li><a href="#ch-bugs-suggestions">Bugs &amp; Suggestions</a>
</li></ul></li>
</ul>
</div>
</nav>
<main class="content"><html><head></head><body><h1 id="ch-known-issues-quirks">Known Issues and Quirks</h1>
<p>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.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-quirks-nodejs" class="title" >NodeJS </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="quirks.html#sec-eslint-plugin-prettier">eslint-plugin-prettier</a> </span></dt> </dl></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-eslint-plugin-prettier" class="title" style="clear: both">eslint-plugin-prettier </h2> </div> </div></div><p>When working with NodeJS, everything works as expected, but some projects have
settings that can fool nvf.</p><p>If <a class="link" href="https://github.com/prettier/eslint-plugin-prettier" target="_top">this plugin</a> or similar
possible workarounds that you may apply.</p>
<h2 id="ch-quirks-nodejs">NodeJS</h2>
<h3 id="sec-eslint-plugin-prettier">eslint-plugin-prettier</h3>
<p>When working with NodeJS, everything works as expected, but some projects have
settings that can fool nvf.</p>
<p>If <a href="https://github.com/prettier/eslint-plugin-prettier">this plugin</a> or similar
is included, you might get a situation where your eslint configuration diagnoses
your formatting according to its own config (usually <code class="literal">.eslintrc.js</code>).</p><p>The issue there is your formatting is made via prettierd.</p><p>This results in auto-formatting relying on your prettier config, while your
your formatting according to its own config (usually <code>.eslintrc.js</code>).</p>
<p>The issue there is your formatting is made via prettierd.</p>
<p>This results in auto-formatting relying on your prettier config, while your
eslint config diagnoses formatting
<a class="link" href="https://prettier.io/docs/en/comparison.html" target="_top">which it’s not supposed to</a>)</p><p>In the end, you get discrepancies between what your editor does and what it
wants.</p><p>Solutions are:</p><div class="orderedlist"><ol class="orderedlist compact" type="1"><li class="listitem"><p>Don’t add a formatting config to eslint, and separate prettier and eslint.</p></li><li class="listitem"><p>PR this repo to add an ESLint formatter and configure nvf to use it.</p></li></ol></div>
</div>
<a href="https://prettier.io/docs/en/comparison.html">which it's not supposed to</a>)</p>
<p>In the end, you get discrepancies between what your editor does and what it
wants.</p>
<p>Solutions are:</p>
<ol>
<li>Don't add a formatting config to eslint, and separate prettier and eslint.</li>
<li>PR this repo to add an ESLint formatter and configure nvf to use it.</li>
</ol>
<h2 id="ch-bugs-suggestions">Bugs &amp; Suggestions</h2>
<p>Some quirks are not exactly quirks, but bugs in the module systeme. If you
notice any issues with nvf, or this documentation, then please consider
reporting them over at the <a href="https://github.com/notashelf/nvf/issues">issue tracker</a>. Issues tab, in addition to the
<a href="https://github.com/notashelf/nvf/discussions">discussions tab</a> is a good place as any to request new features.</p>
<p>You may also consider submitting bugfixes, feature additions and upstreamed
changes that you think are critical over at the <a href="https://github.com/notashelf/nvf/pulls">pull requests tab</a>.</p>
</body></html></main>
</div>
</div>
</div> <div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="index.xhtml">Prev</a>&nbsp;</td>
<td width="20%" align="center">&nbsp;</td>
<td width="40%" align="right">&nbsp;<a accesskey="n" href="options.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">nvf manual&nbsp;</td>
<td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td>
<td width="40%" align="right" valign="top">&nbsp;Appendix B. nvf Configuration Options</td>
</tr>
</table>
</div>
</body>
</html>
<footer>
<p>Generated with ndg</p>
</footer>
</div>
</body>
</html>