Changelog

All notable changes to the Documentarian.Vale module are documented in this file.

This changelog’s format is based on Keep a Changelog and this project adheres to Semantic Versioning.

For releases before 1.0.0, this project uses the following convention:

While the major version is 0, the code is considered unstable.
The minor version is incremented when a backwards-incompatible change is introduced.
The patch version is incremented when a backwards-compatible change or bug fix is introduced.

2 minute read

Unreleased

Replaced an implicit dependency on the powershell-yaml module with an explicit dependency on YaYaml - this resolves the YamlDotNet dependency conflict that prevents the module from being used with PlatyPS. Only the dependency is changed, not the functionality.

Extended verbose output for New-ValeConfigurationto provide information about the created configuration file and adding messaging for the configuration’s initial sync.

Corrected the scoring for the GunningFog rule, ensuring that results for the Get-ProseReadability command are right. Before this fix, the command would sometimes return an invalid negative score.

Renamed Install-WorkspaceVale to Install-Vale and added the Scope parameter, enabling users to install Vale to their home directory as well as the workspace. This change ensures that the other module commands are also able to use Vale when installed to your home directory, not just the PATH or workspace.
Updated the logic for discovering Vale in the workspace to recursively search up the file tree from the current working directory instead of only searching the current directory. This makes the commands available from arbitrarily deep folders when using Vale installed to the workspace.