mirror of https://github.com/nix-community/noogle.git synced 2024-10-03 20:18:05 +03:00

History

Johannes Kirschbauer bdbd37bd60 Improve reference handling and fallbacks (#348 ) * Pesto: handle single line comment The first single line comment is displayed as a fallback if no other documentation could be found * Website: Handle bare-urls, dont sanitize foreign cross references		2024-09-20 10:53:29 +02:00
..
src	Improve reference handling and fallbacks (#348 )	2024-09-20 10:53:29 +02:00
test_data	Improve reference handling and fallbacks (#348 )	2024-09-20 10:53:29 +02:00
.envrc	simplify .envrc	2024-04-29 21:18:47 +00:00
.gitignore	test & refacotring	2024-01-07 17:20:35 +01:00
Cargo.lock	extract type from markdown: pesto	2024-01-07 17:20:35 +01:00
Cargo.toml	extract type from markdown: pesto	2024-01-07 17:20:35 +01:00
flake-module.nix	update to upstream master @ ce223671c8bb53623f634a3961ffc0c8b621e337	2024-01-09 19:04:23 +01:00
json.json	fix: alias breakage of lib.pipe	2024-03-21 15:10:36 +00:00
README.md	Pesto: handle callPackage and makeOverridable edge cases	2024-09-19 11:23:11 +02:00

Pesto

Pesto gives you the extra sauce on top of your lambda noodles.

From a given lambda position extract doc comments and some metadata.

Plugin for Noogle

Extract 'nixdoc style comments' or doc-comment (RFC145) from a given file position.

Usage:

pesto --file "attrsets.nix" --line "11" --column "3"
->
{
    "doc": "content",
    "arguments": {},
    "countApplied": 3
}

Generating test dataset

nix build .#pasta -L

Which can the be passed

cargo run -- --pos-file result --format json ./out.json

It is recommended to remove all unneeded entries and operate on minimal list that contains only one entry.