Hilbish/versions/doc-improvements/blog/v2.1-release/index.html

44 lines
9.6 KiB
HTML

<!doctype html><html><head><title>v2.1 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.1 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
Documentation There have been a few documentation enhancements for this release. This includes:
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly." property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
Documentation There have been a few documentation enhancements for this release. This includes:
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/doc-improvements/css/syntax.min.312e73862fbcdff2de47e47a87e03065060a993ebd316d20e86016fb17f1bbe6.css integrity="sha256-MS5zhi+83/LeR+R6h+AwZQYKmT69MW0g6GAW+xfxu+Y="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.1 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&amp;u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&amp;v=4' width=48 style=border-radius:100%>
<em class=text-muted>by <strong>sammyette</strong><time> // February 7, 2023</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.1.0 target=_blank rel=noopener>v2.1.0</a>
tag.</p></blockquote><p>Oh look! A new release of Hilbish! This time is the v2.1 release,
with a small amount of features and mainly documentation changes and
bug fixes.</p><h2 id=documentation class=heading>Documentation
<a href=#documentation class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>There have been a few documentation enhancements for this release.
This includes:</p><ul><li>Adding the return types for all functions that need them</li><li>Documenting Hilbish types like job objects and timers properly.
They now have a separate heading and listing of properties and methods.</li><li>Fixing outdated documentation</li></ul><h2 id=features class=heading>Features
<a href=#features class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=sinks class=heading>Sinks
<a href=#sinks class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>A major addition is the new &ldquo;sink&rdquo; type for commanders to write
their output to. This was the solution to pipes and other shell
operators not working with builtins. If you wrote a commander
and made it <code>print</code>, use <code>sinks.out:write</code> instead.</p><p>This is also documented at the <a href=./docs/api/commander>commander docs</a>
.</p><h3 id=doc-command class=heading><code>doc</code> command
<a href=#doc-command class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Since API documentation has been moved to an API folder and also includes
interfaces, a change has been made to get the module name from the
passed from the requested page. This means that
<code>doc api hilbish hilbish.jobs</code> is now shortened to <code>doc api hilbish.jobs</code></p><h2 id=bug-fixes class=heading>Bug Fixes
<a href=#bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Small release, small amount of bug fixes. Even though, this is the main
part of this release.</p><h3 id=completions-and-symlinks class=heading>Completions and Symlinks
<a href=#completions-and-symlinks class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Previously Hilbish completions did not work with symlinks properly.
This can be tested in the previous 2.0 release by attempting to
path complete to <code>/bin</code>. Since this is (or can be?) a symlink to
<code>/usr/bin</code>, it was not marked as a directory and therefore did not
automatically add the ending slash. This has been fixed.</p><h3 id=segfaults class=heading>Segfaults
<a href=#segfaults class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>I found that when I updated my terminal of choice (<a href=https://github.com/endaaman/tym target=_blank rel=noopener>Tym</a>
) for the new
daemon feature, Hilbish would sometimes segfault on startup. This is due
to it getting a resize event on startup while <code>bait</code> was not initialized
yet.</p><h3 id=api-fixes class=heading>API Fixes
<a href=#api-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h3><ul><li>The <code>hilbish.which</code> function works with aliases.</li><li><code>hilbish.completion.files</code> and <code>hilbish.completion.bins</code> will no longer
cause a panic with all empty arguments passed.</li></ul><h2 id=next-release class=heading>Next Release
<a href=#next-release class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Stay tuned for the v2.2 release, which will have a bigger set of features
and maybe some more bug fixes!</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>