nu-lint 1.1.0

Linter for Nu shell scripts that helpfully suggests improvements
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

use std::{
    fs,
    path::{Path, PathBuf},
};

use crate::{LintError, LintLevel, config::Config};

pub const DISABLE_RULE_COMMAND: &str = "nu-lint.disableRule";

/// Execute the disable rule action by writing to the config file.
/// Returns the path that was modified on success.
pub fn execute_disable_rule(
    workspace_root: Option<&Path>,
    rule_id: &str,
) -> Result<PathBuf, LintError> {
    let base_dir = workspace_root
        .map(Path::to_path_buf)
        .or_else(dirs::home_dir)
        .ok_or(LintError::NoConfigLocation)?;
    let config_path = base_dir.join(".nu-lint.toml");

    let content = fs::read_to_string(&config_path).unwrap_or_default();

    let mut config = if content.is_empty() {
        Config::default()
    } else {
        Config::load_from_str(&content)?
    };

    if config.rules.get(rule_id) == Some(&LintLevel::Off) {
        return Ok(config_path);
    }

    config.rules.insert(rule_id.to_string(), LintLevel::Off);

    let new_content =
        toml::to_string_pretty(&config).map_err(|source| LintError::ConfigSerialize { source })?;

    fs::write(&config_path, &new_content).map_err(|source| LintError::Io {
        path: config_path.clone(),
        source,
    })?;

    tracing::info!("Disabled rule '{}' in {}", rule_id, config_path.display());

    Ok(config_path)
}