#nu-shell #source #metadata

nu-source

A source string characterizer for Nushell

38 breaking releases

0.44.0 Feb 8, 2022
0.42.0 Dec 28, 2021
0.40.0 Nov 16, 2021
0.34.0 Jul 13, 2021
0.1.0 Nov 27, 2019

#1181 in Command-line interface

Download history 213/week @ 2024-12-17 89/week @ 2024-12-24 98/week @ 2024-12-31 140/week @ 2025-01-07 186/week @ 2025-01-14 192/week @ 2025-01-21 171/week @ 2025-01-28 219/week @ 2025-02-04 256/week @ 2025-02-11 261/week @ 2025-02-18 231/week @ 2025-02-25 36/week @ 2025-03-04 147/week @ 2025-03-11 174/week @ 2025-03-18 180/week @ 2025-03-25 93/week @ 2025-04-01

594 downloads per month
Used in 32 crates (29 directly)

MIT license

46KB
1.5K SLoC

nu-source

Overview

The nu-source crate contains types and traits used for keeping track of metadata about values being processed. Nu uses Tags to keep track of where a value came from, an AnchorLocation, as well as positional information about the value, a Span. An AnchorLocation can be a Url, File, or Source text that a value was parsed from. The source Text is special in that it is a type similar to a String that comes with the ability to be cheaply cloned. A Span keeps track of a value's start and end positions. These types make up the metadata for a value and are wrapped up together in a Tagged struct, which holds everything needed to track and locate a value.

Nu's metadata system can be seen when reporting errors. In the following example Nu is able to report to the user where the typo of a column originated from.

1 | ls | get typ
  |          ^^^ did you mean 'type'?

In addition to metadata tracking, nu-source also contains types and traits related to debugging, tracing, and formatting the metadata and values it processes.

Other Resources

Dependencies

~0.5–7.5MB
~56K SLoC