From e97fe332b108e657682e3bdc85ea43a94be82bd3 Mon Sep 17 00:00:00 2001 From: KtorZ Date: Fri, 25 Oct 2024 11:08:05 +0200 Subject: [PATCH] Rename --filter_traces to --trace_filter It has somehow always annoyed me that we have --trace_level (with 'trace' first) and --filter_traces (with traces, plural and last). Given that these two options are almost always used together, the inconsistency is frustrating. --- CHANGELOG.md | 2 +- crates/aiken/src/cmd/build.rs | 16 ++++++++-------- crates/aiken/src/cmd/check.rs | 18 +++++++++--------- crates/aiken/src/cmd/export.rs | 12 ++++++------ crates/aiken/src/cmd/tx/simulate.rs | 2 +- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff9c757d..13500625 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ ### Changed -- N/A +- **aiken**: Rename `--filter_traces` to `--trace_filter` for more consistency with `--trace_level`. An alias for `--filter_traces` still exists for backward compatibility. @KtorZ ### Removed diff --git a/crates/aiken/src/cmd/build.rs b/crates/aiken/src/cmd/build.rs index fbe89fba..9c6b1454 100644 --- a/crates/aiken/src/cmd/build.rs +++ b/crates/aiken/src/cmd/build.rs @@ -40,8 +40,8 @@ pub struct Args { /// include both user-defined and compiler-generated traces. /// /// [optional] [default: all] - #[clap(short, long, value_parser=filter_traces_parser(), default_missing_value="all", verbatim_doc_comment)] - filter_traces: Option Tracing>, + #[clap(short = 'f', long, value_parser=trace_filter_parser(), default_missing_value="all", verbatim_doc_comment, alias="filter_traces")] + trace_filter: Option Tracing>, /// Choose the verbosity level of traces: /// @@ -65,7 +65,7 @@ pub fn exec( deny, watch, uplc, - filter_traces, + trace_filter, trace_level, env, }: Args, @@ -74,8 +74,8 @@ pub fn exec( watch_project(directory.as_deref(), watch::default_filter, 500, |p| { p.build( uplc, - match filter_traces { - Some(filter_traces) => filter_traces(trace_level), + match trace_filter { + Some(trace_filter) => trace_filter(trace_level), None => Tracing::All(trace_level), }, env.clone(), @@ -85,8 +85,8 @@ pub fn exec( with_project(directory.as_deref(), deny, |p| { p.build( uplc, - match filter_traces { - Some(filter_traces) => filter_traces(trace_level), + match trace_filter { + Some(trace_filter) => trace_filter(trace_level), None => Tracing::All(trace_level), }, env.clone(), @@ -98,7 +98,7 @@ pub fn exec( } #[allow(clippy::type_complexity)] -pub fn filter_traces_parser( +pub fn trace_filter_parser( ) -> MapValueParser fn(TraceLevel) -> Tracing> { PossibleValuesParser::new(["user-defined", "compiler-generated", "all"]).map( |s: String| match s.as_str() { diff --git a/crates/aiken/src/cmd/check.rs b/crates/aiken/src/cmd/check.rs index 7ae9b097..ed3fe619 100644 --- a/crates/aiken/src/cmd/check.rs +++ b/crates/aiken/src/cmd/check.rs @@ -1,4 +1,4 @@ -use super::build::{filter_traces_parser, trace_level_parser}; +use super::build::{trace_filter_parser, trace_level_parser}; use aiken_lang::{ ast::{TraceLevel, Tracing}, test_framework::PropertyTest, @@ -66,9 +66,9 @@ pub struct Args { /// - all: /// include both user-defined and compiler-generated traces. /// - /// [optional] [default: all] - #[clap(short, long, value_parser=filter_traces_parser(), default_missing_value="all", verbatim_doc_comment)] - filter_traces: Option Tracing>, + /// [default: all] + #[clap(short = 'f', long, value_parser=trace_filter_parser(), default_missing_value="all", verbatim_doc_comment, alias="filter_traces")] + trace_filter: Option Tracing>, /// Choose the verbosity level of traces: /// @@ -95,7 +95,7 @@ pub fn exec( match_tests, exact_match, watch, - filter_traces, + trace_filter, trace_level, seed, max_success, @@ -115,8 +115,8 @@ pub fn exec( exact_match, seed, max_success, - match filter_traces { - Some(filter_traces) => filter_traces(trace_level), + match trace_filter { + Some(trace_filter) => trace_filter(trace_level), None => Tracing::All(trace_level), }, env.clone(), @@ -131,8 +131,8 @@ pub fn exec( exact_match, seed, max_success, - match filter_traces { - Some(filter_traces) => filter_traces(trace_level), + match trace_filter { + Some(trace_filter) => trace_filter(trace_level), None => Tracing::All(trace_level), }, env.clone(), diff --git a/crates/aiken/src/cmd/export.rs b/crates/aiken/src/cmd/export.rs index 6debdcd2..1b8dcc4c 100644 --- a/crates/aiken/src/cmd/export.rs +++ b/crates/aiken/src/cmd/export.rs @@ -1,4 +1,4 @@ -use super::build::{filter_traces_parser, trace_level_parser}; +use super::build::{trace_filter_parser, trace_level_parser}; use aiken_lang::ast::{TraceLevel, Tracing}; use aiken_project::{options::Options, watch::with_project}; use std::path::PathBuf; @@ -33,8 +33,8 @@ pub struct Args { /// include both user-defined and compiler-generated traces. /// /// [optional] [default: all] - #[clap(short, long, value_parser=filter_traces_parser(), default_missing_value="all", verbatim_doc_comment)] - filter_traces: Option Tracing>, + #[clap(short = 'f', long, value_parser=trace_filter_parser(), default_missing_value="all", verbatim_doc_comment, alias = "filter_traces")] + trace_filter: Option Tracing>, /// Choose the verbosity level of traces: /// @@ -57,7 +57,7 @@ pub fn exec( directory, module, name, - filter_traces, + trace_filter, trace_level, }: Args, ) -> miette::Result<()> { @@ -67,8 +67,8 @@ pub fn exec( let export = p.export( &module, &name, - match filter_traces { - Some(filter_traces) => filter_traces(trace_level), + match trace_filter { + Some(trace_filter) => trace_filter(trace_level), None => Tracing::All(trace_level), }, )?; diff --git a/crates/aiken/src/cmd/tx/simulate.rs b/crates/aiken/src/cmd/tx/simulate.rs index d57a35fd..d89e7b00 100644 --- a/crates/aiken/src/cmd/tx/simulate.rs +++ b/crates/aiken/src/cmd/tx/simulate.rs @@ -1,8 +1,8 @@ use miette::IntoDiagnostic; use owo_colors::{OwoColorize, Stream::Stderr}; use pallas_primitives::{ - Fragment, conway::{Redeemer, TransactionInput, TransactionOutput}, + Fragment, }; use pallas_traverse::{Era, MultiEraTx}; use std::{fmt, fs, path::PathBuf, process};