Right now they replace the curren tab. Also when hovering them no preview is shown in the browsers bottom.

https://github.com/NixOS/nixpkgs/blob/master/lib/strings-with-deps.nix

I think the types are

type TextEntryName = string;
type TextEntry = { deps :: [TextEntryName]; text :: string; supportsDryActivation? :: boolean; };
type TextEntries = { "$textEntryName" :: TextEntry };

textClosureList :: TextEntries -> (TextEntry | TextEntryName) -> TextEntries;
textClosureMap :: (TextEntry -> string) -> TextEntries -> [TextEntryName] -> string;
noDepEntry :: string -> TextEntry;
fullDepEntry :: string -> [TextEntryName] -> TextEntry;
packEntry :: [TextEntryName] -> TextEntry;
stringAfter :: [TextEntryName] -> string -> TextEntry;

Not sure how to denote types and that supportsDryActivation is an optional property

related: #25

Being new to nix, I'm so grateful to have a way to search by function signature and have already found this very useful. Thank you!

I was surprised that searching by fully qualified function name didn't work, for example I wanted to look at builtins.elem. It shows up if I search for a -> [b] -> bool, but searching for elem gives me 7 pages of results and builtins.elem gives 0 results. While I don't haskell, if keeping similarity to Hoogle is of concern, searching for elem seems to yield expected results.

If there's the possibility of adding a feature to search by function name in addition to signature I think it would be helpful. Thank again for providing an already very useful site!

What happened
Clicking a "browse source code" link on a builtin function's documentation opens an invalid link in the nixpkgs repo.

Steps to Reproduce
Steps to reproduce the behavior:

1. Go to a builtin function's documentation.
2. Click on "Browse source code".
3. Note that the opened page does not exist.

Expected behavior
Either

• No link should be shown in the documentation
• The link should open the C++ code implementing the builtin
• The link should open the nix code where the builtin is stubbed & documented

the fetch functions are in pkgs, not lib, and they're a bit mysterious :-)

Is your feature request related to a problem? Please describe.

With the new design, it takes quite some clicks to filter the functions for the desired input/output combination.

I really liked that the old design was really fast to handle when filtering for input/output type.

Describe the solution you'd like

Maybe noogle could use buttons on the horizontal (like the blue "any" element) instead of a drop down menu?
That would safe 2 clicks when selecting input and output (one on each drop down menu line to open the drop down options)

It would also be nice to enable selection of multiple types for input/output, and using buttons instead of drop down could be a first step in this direction. ;)

Describe alternatives you've considered

Moving the input/output selection from behind the "settings" symbol in the search bar to a place where it is directly accessible could be an alternative/additional solution to save a click.

Describe the solution you'd like

I would love to be able to interact with Noogle as a command-line tool so I don't have to switch to my browser and open the website.

Describe alternatives you've considered

A couple CLI tools like this exist already, but I far prefer the information and UI of Noogle in the browser.

• https://github.com/lf-/nix-doc – good, but a bit "noisy". doesn't have the type info afaik
• https://github.com/mlvzk/manix – unmaintained
• (i think there's another one out there?)

Additional context

This request might be totally out of scope since an interactive CLI is not a website.

I'd love deprecated items to show up as such. For example, It seems that this one is deprecated, because the source file it's implemented in is lib/deprecated.nix.

Is your feature request related to a problem? Please describe.

1. visit https://noogle.dev/?selected=%22lib.sources.cleanSourceWith%22&term=%22cleansourcewith%22
2. visit https://noogle.dev/?selected=%22builtins.baseNameOf%22&term=%22basenameof%22
3. hit back in the browser history
4. the UI is not updated

Describe the solution you'd like
I would like to be brought back to the previously selected entry.

Additional context
Tested in both FF and Chrome.

As nixos modules have an interface like declaration we could display interfaces for nixos modules like „drv-parts“ which is an interface for mkDerivation and derivation

Need to fork nixpkgs and make mkOptionType noogle compatible

The trivial builders are easy to be added. But the comments there are not complete nor make sense to render as markdown.

1. Fork nixpkgs and fix the doc-strings
2. Create dataset for noogle
3. Create PR in nixpkgs

Currently you can't bookmark or share a page with someone because the current information are not stored in the URL.

Edit: apparently there is a share button next to search bar which I missed first because of the not so great contrast. It would be nice if there would be no need for such button and the URL is just always updated.

What happened

entry for lib.pipe shows documentation of lib.lists.unique

Steps to Reproduce

https://noogle.dev/f/lib/pipe

Screenshots

Expected behavior
A clear and concise description of what you expected to happen.

Desktop (please complete the following information):

• OS: x86_64-linux
• Browser chrome
• Version 122.0.6261.111

https://nixos.org/manual/nix/stable/language/builtins.html#builtins-getFlake

mkDerivation is only one of the important stdenv

It would be super nice to display them here

Clicking on the search result of mapAttrs' leads to 404. This page:

https://noogle.dev/f/lib/mapAttrs'%20(Prime)

mkOverride, mkDefault etc. from https://github.com/NixOS/nixpkgs/blob/master/lib/modules.nix are missing in Noogle. It would be nice to see them too.

What happened
I tried to set up a shortcut to prompt for text and then open the URL https://noogle.dev/?term=<text I entered> but found it didn't work as expected. By trial and error, I found I needed to surround the search text with URL-encoded double quotes %22 to make it work.

Steps to Reproduce
Steps to reproduce the behavior:

1. Enter https://noogle.dev/?term=getattrs in browser location bar and press enter
2. Noogle loads with empty search box and no results, the same as simply opening https://noogle.dev
3. Enter https://noogle.dev/?term=%22getattrs%22 in browser location bar and press enter
4. Noogle correctly shows search results for getattrs

Expected behavior
Noogle should perform the search given in the URL in both cases.

Desktop (please complete the following information):

• OS: Linux
• Browser Chromium
• Version 118

When only displaying 8 results per page, you can't really search through all your search results to find exactly what you want. I would propose to increase the default and maybe add a view which just display everything.
Also the pager is not nice to use. It only displays the first, last, current and current-1 and current+1. If you want to navigate from the 7th to the 20th page you need to click a lot.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update all dependencies (@emotion/react, @mui/icons-material, @mui/material, @mui/material-nextjs, @next/mdx, @types/node, @types/react, @types/react-dom, @types/react-highlight, @types/seedrandom, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, cachix/cachix-action, cachix/install-nix-action, clap, eslint, eslint-config-next, expect-test, highlight.js, next, react-markdown, react-minisearch, regex, remark-rehype, serde, serde_json, serde_with, serde_yaml, usehooks-ts)
• chore(deps): lock file maintenance

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

nixos also has some important lib functions, that are not yet documented

• nixosOptionsDoc
• systemd-lib
  • unitConfig
  • makeUnit
  • makeJobScript
  • ...etc.
• make-iso9660Image
• ...etc.

Building system images is not very well described and requires a lot of research.

If your Feature is adding / extending more functions

Something I liked about the old site was it had a type of the results in the description. It was nice to see what the function or such required to be called from the site. But I would like something similar in the new site.

What happened
Navigating to the front page or pkgs.fetchFromGitHub flashes website.

Steps to Reproduce
Steps to reproduce the behavior:

See video

Expected behavior
Background should stay in the theme color.

Screenshots

Desktop (please complete the following information):

• OS: Windows
• Browser Chrome
• Version 120.0.6099.200

Is your feature request related to a problem? Please describe.
I'd like a search functions that build derivations, like the functions that return derivation for python, rust, vim-plugins, ...
(the trivial builders are already indexed so that's good, but I think we can do better!)

This would potentially need special support from nixpkgs, to have (in the documentation?) structured metadata about what that function helps to build, like Rust Package, Python Package, Python Environment, Vim Plugin, Nvim Config.
Might need to add more usability & attrset option documentation to those as well.

Relevant RFC on docstring format: NixOS/rfcs#145

Describe the solution you'd like
Ability to filter by ecosystem (rust, python, java, ..)
Ability to filter by category of well-known things to build (config, env, pkg/module, plugin, misc, ..)

See usage documentation (& attribute docs?) or at least link to documentation (potentially generated from structured doc metadata?)
...

Describe alternatives you've considered
Grepping nixpkgs, looking at existing packages

Is your feature request related to a problem? Please describe.
It is not clear what is format to distinguish part of Nix expression and output of evaluation. See question in NixOS/nixpkgs#225496 (comment)

From lib.attrsets.foldAttrs:

Example

foldAttrs (item: acc: [item] ++ acc) [] [{ a = 2; } { a = 3; }]
=> { a = [ 2 3 ]; }

From lib.attrsets.foldlAttrs

Example

foldlAttrs
  (acc: name: value: {
    sum = acc.sum + value;
    names = acc.names ++ [name];
  })
  { sum = 0; names = []; }
  {
    foo = 1;
    bar = 10;
  }
->
  {
    sum = 11;
    names = ["bar" "foo"];
  }

foldlAttrs
  (throw "function not needed")
  123
  {};
->
  123

Notice that in first example it is => (looks like double line arrow pointing to right) that separates expression to run from expected output. While second one uses -> (looks like single line arrow to right).

Describe the solution you'd like
Before growing coverage of comment-based documentation it worth to agree on some format.

I have nothing specific, but something popular might be more preferred. E.g. >>> prefix for what needs to be evaluated as Nix expression.

E.g. Haddoc/doctest uses prefix

-- | Compute Fibonacci numbers
--
-- Examples:
--
-- >>> fib 10
-- 55

Same in Python doctest

 """Compute and return the sum of two numbers.

 Usage examples:
 >>> add(4.0, 2.0)
 6.0
 >>> add(4, 2)
 6.0
 """

Most search engines offer a way to be added to the search bar in Firefox. For example, https://search.nixos.org/packages does. It would be great if noogle had that as well.

As people request more and more functions that are not documented or pieces of documentation missing.

I'd like to use gray-matter to extend existing documentation for functions. Or inject missing documentation. Until PRs about that would get accepted. Also, i'd like to keep controversial content locally.

Hello!

I am one of the moderators of the nixos discord (https://discord.gg/RbvHtGa), and we thought it would be nice to integrate noogle into a bot, so people can /search <function_name>

From what I get from the readme, noogle is build as a static webpage, so could it be possible to get a machine-readadable format (e.g. json) that we can embed into the bot?

Maybe this already exists, or could be possible to implement?

Is your feature request related to a problem? Please describe.
When visiting noogle.dev, I'd like the main search input to be autofocused, so I can start searching immediately.

Describe the solution you'd like
Use the autofocus HTML attribute.

Describe alternatives you've considered
Leave as is, which is still fine.

Additional context
None.

What happened
lib.generators.toJSON's documentation says its short form is lib.toJSON, but they actually have different signatures
The same thing happens for functions like lib.modules.importJSON

Steps to Reproduce
Steps to reproduce the behavior:

1. search for lib.generators.toJSON
2. profit

Expected behavior
lib.generators.toJSON should not show a short form of lib.toJSON

Screenshots

Desktop (please complete the following information):

• OS: x86_64 NixOS
• Browser: Firefox
• Version: 112.0.2

If your Feature is adding / extending more functions
https://github.com/hsjobeki/nixpkgs/blob/migrate-doc-comments/lib/modules.nix#L1086C1-L1093C1

Is your feature request related to a problem? Please describe.
Functions that set priority (e.g. mkOptionDefault and`mkVMOverride) are not documented on noogle. Leading to empty pages when searched.

Describe the solution you'd like
One solution could be to create a category that manually describe the function, and append at the bottom, under a "Priority" title instead of "Detected Type", the priority it will set when used.

Describe alternatives you've considered
N/A

Additional context

show first n examples of funciton usage in nixpkgs, for that we need some way that searches nixpkgs and outputs a json

What happened
The indentation of markdown code blocks seems to get lost, here are two examples:

Expected behavior
Keep the indentation as in the doc comment.

Screenshots

https://noogle.dev/f/lib/packagesFromDirectoryRecursive
https://github.com/NixOS/nixpkgs/blob/master/lib/filesystem.nix#L174-L206

https://noogle.dev/f/lib/fileset/toSource
https://github.com/NixOS/nixpkgs/blob/master/lib/fileset/default.nix#L275-L280

Desktop (please complete the following information):

• OS: NixOS
• Browser Chromium
• Version 121.0.6167.85
• Screen resolution (optional)

What happened
https://noogle.dev/?term=%22fetchurl%22 source code link returns 404

Steps to Reproduce
Steps to reproduce the behavior:

1. Go to https://noogle.dev/?term=%22fetchurl%22
2. Click on https://github.com/NixOS/nixpkgs/blob/master/builtins
3. 404

Expected behavior
No or Correct link

Screenshots

Desktop (please complete the following information):

• OS: NixOS
• Chromium

I want to help to fix this but I need a pointer where to look at first.

https://noogle.dev/f/pkgs/fetchFromGitHub.

See the wrong source location