eipw 0.11.0

Ethereum Improvement Proposal linter that's one more than eipv
/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

use eipw_lint::config::DefaultOptions;
use eipw_snippets::Message;

use clap::{Parser, ValueEnum};

use eipw_lint::reporters::{AdditionalHelp, Count, Json, Reporter, Text};
use eipw_lint::Linter;

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

use sysexits::ExitCode;

#[derive(Debug, Parser)]
#[command(version, about)]
struct Opts {
    /// Print the default configuration.
    #[clap(exclusive(true), long)]
    defaults: bool,

    /// List all available lints.
    #[clap(exclusive(true), long)]
    list_lints: bool,

    /// Print the supported configuration schema version.
    #[cfg(feature = "schema-version")]
    #[clap(exclusive(true), long)]
    schema_version: bool,

    /// Files and/or directories to check.
    #[cfg_attr(feature = "schema-version", clap(required_unless_present_any(["list_lints", "defaults", "schema_version"])))]
    #[cfg_attr(not(feature = "schema-version"), clap(required_unless_present_any(["list_lints", "defaults"])))]
    sources: Vec<PathBuf>,

    /// Output format.
    #[clap(long, value_enum, default_value_t)]
    format: Format,

    /// Do not enable the default lints.
    #[clap(long)]
    no_default_lints: bool,

    /// Lints to enable as errors.
    #[clap(long, short('D'))]
    deny: Vec<String>,

    /// Lints to enable as warnings.
    #[clap(long, short('W'))]
    warn: Vec<String>,

    /// Lints to disable.
    #[clap(long, short('A'))]
    allow: Vec<String>,

    /// Path to file defining alternate default lints.
    #[clap(long, short('c'))]
    config: Option<PathBuf>,
}

#[derive(Default, ValueEnum, Clone, Debug)]
enum Format {
    #[default]
    Text,
    Json,
}

#[derive(Debug)]
enum EitherReporter {
    Text(Text<String>),
    Json(Json),
}

impl Reporter for EitherReporter {
    fn report(&self, snippet: Message<'_>) -> Result<(), eipw_lint::reporters::Error> {
        match self {
            Self::Text(s) => s.report(snippet),
            Self::Json(j) => j.report(snippet),
        }
    }
}

fn defaults() {
    let options = DefaultOptions::<String>::default();

    let output = toml::to_string_pretty(&options).unwrap();

    println!("{output}\n");
}

fn list_lints() {
    let options = DefaultOptions::<String>::default();
    println!("Available lints:");

    for (slug, _) in options.lints {
        println!("\t{}", slug);
    }

    println!();
}

#[cfg(target_arch = "wasm32")]
async fn read_config(_path: &Path) -> Result<DefaultOptions, toml::de::Error> {
    todo!()
}

#[cfg(not(target_arch = "wasm32"))]
async fn read_config(path: &Path) -> Result<DefaultOptions, toml::de::Error> {
    let contents = tokio::fs::read_to_string(path)
        .await
        .expect("couldn't read config file");

    toml::from_str(&contents)
}

async fn try_read_config(path: &Path) -> Result<DefaultOptions, ExitCode> {
    let error = match read_config(path).await {
        Ok(o) => return Ok(o),
        Err(e) => e,
    };

    eprintln!("Error(s) encountered in configuration file:");
    eprintln!("{}", error);

    Err(ExitCode::Config)
}

#[cfg(target_arch = "wasm32")]
async fn collect_sources(_sources: Vec<PathBuf>) -> Result<Vec<PathBuf>, std::io::Error> {
    todo!()
}

#[cfg(not(target_arch = "wasm32"))]
async fn collect_sources(sources: Vec<PathBuf>) -> Result<Vec<PathBuf>, std::io::Error> {
    use std::ffi::OsStr;
    use tokio::fs;

    let mut output = Vec::with_capacity(sources.len());

    for source in sources.into_iter() {
        let metadata = fs::metadata(&source).await?;
        if metadata.is_file() {
            output.push(source.clone());
        }

        if !metadata.is_dir() {
            continue;
        }

        let mut entries = fs::read_dir(&source).await?;

        while let Some(entry) = entries.next_entry().await? {
            let path = entry.path();
            let metadata = fs::metadata(&path).await?;
            if !metadata.is_file() {
                continue;
            }

            if path.extension() != Some(OsStr::new("md")) {
                continue;
            }

            output.push(path);
        }
    }

    Ok(output)
}

#[cfg_attr(target_arch = "wasm32", tokio::main(flavor = "current_thread"))]
#[cfg_attr(not(target_arch = "wasm32"), tokio::main)]
async fn run(opts: Opts) -> Result<(), ExitCode> {
    if opts.list_lints {
        list_lints();
        return Ok(());
    }

    if opts.defaults {
        defaults();
        return Ok(());
    }

    #[cfg(feature = "schema-version")]
    if opts.schema_version {
        println!("{}", DefaultOptions::<String>::schema_version());
        return Ok(());
    }

    let stdout = std::io::stdout();

    let sources = collect_sources(opts.sources).await.unwrap();

    let reporter = match opts.format {
        Format::Json => EitherReporter::Json(Json::default()),
        Format::Text => EitherReporter::Text(Text::default()),
    };

    let reporter = AdditionalHelp::new(reporter, |t: &str| {
        Ok(format!("see https://ethereum.github.io/eipw/{}/", t))
    });
    let reporter = Count::new(reporter);

    let mut options: DefaultOptions = Default::default();
    let mut linter;
    if let Some(ref path) = opts.config {
        options = try_read_config(path).await?;
        linter = Linter::with_options(reporter, options.clone());
    } else {
        linter = Linter::new(reporter);
    }

    if opts.no_default_lints {
        linter = linter.clear_lints();
    }

    for allow in opts.allow {
        linter = linter.allow(&allow);
    }

    if !opts.warn.is_empty() {
        for warn in opts.warn {
            let (k, v) = options.lints.remove_entry(warn.as_str()).unwrap();
            linter = linter.warn(k, v.into_lint().unwrap());
        }
    }

    if !opts.deny.is_empty() {
        for deny in opts.deny {
            let (k, v) = options.lints.remove_entry(deny.as_str()).unwrap();
            linter = linter.deny(k, v.into_lint().unwrap());
        }
    }

    for source in &sources {
        linter = linter.check_file(source);
    }

    let reporter = linter.run().await.unwrap();

    let n_errors = reporter.counts().error;

    match reporter.into_inner().into_inner() {
        EitherReporter::Json(j) => serde_json::to_writer_pretty(&stdout, &j).unwrap(),
        EitherReporter::Text(t) => print!("{}", t.into_inner()),
    }

    if n_errors > 0 {
        eprintln!("validation failed with {} errors :(", n_errors);
        Err(ExitCode::DataErr)
    } else {
        Ok(())
    }
}

fn main() {
    let opts = match Opts::try_parse() {
        Ok(o) => o,
        Err(e) => {
            e.print().unwrap();
            std::process::exit(ExitCode::Usage.into());
        }
    };

    if let Err(e) = run(opts) {
        std::process::exit(e.into());
    }
}