nix-community/noogle
1
1
Fork 0
mirror of https://github.com/nix-community/noogle.git synced 2024-08-16 04:30:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Johannes Kirschbauer 2022-12-06 10:58:20 +01:00 committed by GitHub
parent 794de56abc
commit 233d910272
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,3 +1,7 @@
🚧 under construction 🚧
Any contributions are welcome
# [Noogle](https://hsjobeki.github.io/noogle/)
Noogle is a Nix API search engine. It allows you to search functions based on their types and other attributes in `nix` projects. In `nixpkgs` especially the `builtins` and `lib` attributes.
@ -16,6 +20,20 @@ The idea is to use a fork of `nixdoc`to generate json data from all functions. T
View the prototype [here](https://hsjobeki.github.io/noogle/)
## We need your help / what is missing
- Parsing `Types:` into a real type signature tree
- Upstream missing type informations (like in /lib/attrsets.nix)
- Write type signatures for the `builtins` in json
- Add path, where each function can be imported from. e.g. `lib.makeOverridable` or `lib.customisation.makeOverridable` (it is available in both sets)
- Website
- Make sure functions with missing type signatures can be found too
- Add filter by tags e.g. lib.lists
- Mobile optimization for reading on the go
- Clean up / enhance my nixdoc fork.
- Make the `sloppy` parser more error resistant
- Some valueable information can be used from the rnix AST ?
## Contrbute
### Build this page