ec4rs 1.2.0

EditorConfig For Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# ec4rs: EditorConfig For Rust

An
[EditorConfig](https://editorconfig.org/)
[core](https://editorconfig-specification.readthedocs.io/#terminology)
in safe Rust.
See [the Github repo](https://github.com/TheDaemoness/ec4rs)
for more information.

## Basic Example Usage

The most common usecase for `ec4rs` involves
determining how an editor/linter/etc should be configured
for a file at a given path.

The simplest way to load these is using [`properties_of`].
This function, if successful, will return a [`Properties`],
a map of config keys to values for a file at the provided path.
In order to get values for tab width and indent size that are compliant
with the standard, [`use_fallbacks`][Properties::use_fallbacks]
should be called before retrieving them.

From there, `Properties` offers several methods for retrieving values:

```
// Read the EditorConfig files that would apply to a file at the given path.
let mut cfg = ec4rs::properties_of("src/main.rs").unwrap_or_default();
// Convenient access to ec4rs's property parsers.
use ec4rs::property::*;
// Use fallback values for tab width and/or indent size.
cfg.use_fallbacks();

// Let ec4rs do the parsing for you.
let indent_style: IndentStyle = cfg.get::<IndentStyle>()
    .unwrap_or(IndentStyle::Tabs);

// Get a string value, with a default.
let charset: &str = cfg.get_raw::<Charset>()
    .filter_unset() // Handle the special "unset" value.
    .into_option()
    .unwrap_or("utf-8");

// Parse a non-standard property.
let hard_wrap = cfg.get_raw_for_key("max_line_length")
    .into_str()
    .parse::<usize>();
```

## Features

**allow-empty-values**: Consider lines with a key but no value as valid.
This is likely to be explicitly allowed in a future version of the
EditorConfig specification, but `ec4rs` currently by default treats such lines
as invalid, necessitating this feature flag to reduce behavioral breakage.

**language-tags**: Use the `language-tags` crate, which adds parsing for the
`spelling_language` property.

**track-source**: Allow [`RawValue`][crate::rawvalue::RawValue]
to store the file and line number it originates from.
[`ConfigParser`] will add this information where applicable.