Struct ValeConfig 

pub struct ValeConfig {
    pub path: PathBuf,
    pub packages: Vec<String>,
    pub vocabularies: Vec<String>,
    pub disabled: Vec<String>,
}

Vale configuration

See https://vale.sh/docs/vale-ini for more information

Fields

path: PathBuf

Path to Vale configuration

packages: Vec<String>

List of Vale packages

See https://vale.sh/docs/keys/packages for more information

vocabularies: Vec<String>

List of Vale vocabularies

See https://vale.sh/docs/keys/vocab for more information

disabled: Vec<String>

List of Vale rules to disable

See https://vale.sh/docs/styles#rules for more information

Implementations

impl ValeConfig

pub fn init() -> ValeConfigBuilder

Create an instance of ValeConfig using the builder syntax

Trait Implementations

impl Clone for ValeConfig

fn clone(&self) -> ValeConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ValeConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ValeConfig

fn default() -> Self

Returns the “default value” for a type.

impl Display for ValeConfig

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StaticAnalyzer<ValeConfig> for Vale

fn resolve<'async_trait>( config: ValeConfig, is_offline: bool, skip_verify_checksum: bool, ) -> Pin<Box<dyn Future<Output = Vale> + Send + 'async_trait>>

Resolve Vale

Notes

• Will use system vale command if available
• Will use local vale binary if available (will expect local binary if offline)
• Will download vale binary if not available by other means

fn command(&self) -> String

Get command name (e.g. “vale”)

fn run<'life0, 'async_trait>( &'life0 self, path: PathBuf, content: String, output_format: Option<String>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run analyzer on content

fn download<'async_trait>( self, config: Option<ValeConfig>, skip_verify_checksum: bool, ) -> Pin<Box<dyn Future<Output = Vale> + Send + 'async_trait>>

where Self: 'async_trait,

Download binary

fn download_checksums<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = ApiResult<HashMap<String, String>>> + Send + 'async_trait>>

where Self: 'async_trait,

Download checksum values

fn extract(self, path: PathBuf, destination: Option<PathBuf>) -> PathBuf

Extract binary

fn sync<'async_trait>( self, is_offline: bool, quiet: bool, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Perform sync operation (only applies to Vale)

fn with_binary<P>(self, path: P) -> Self

where P: Into<PathBuf>,

Set binary

fn with_config(self, value: ValeConfig) -> Self

Set config

fn with_system_command(self) -> Self

Set system command

fn with_version(self, value: String) -> Self

Set version

impl StaticAnalyzerConfig for ValeConfig

fn ini<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Ini> + Send + 'async_trait>>

where Self: 'async_trait,

Convert to INI

fn resolve_package(value: impl AsRef<str>) -> String

Resolve package source: convert bare package name to download URL or pass through existing URL/path

fn save<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = ValeConfig> + Send + 'async_trait>>

where Self: 'async_trait,

Save configuration

fn with_path(self, path: PathBuf) -> Self

Set parent path of configuration