Skip to content

v2.0.0

Compare
Choose a tag to compare
@jdkato jdkato released this 18 Feb 22:38
· 620 commits to master since this release
b6a5536

Breaking Changes

  • Vale no longer includes write-good, proselint, or Joblint by default. These can now be installed at their own repositories, which can be found at the new styles library.
  • The built-in vale style has been re-named to Vale and now only includes two rules.

New Features

  • Vale now supports XML, including special support for DITA.

  • Vale now supports an extended selection of scopes, allowing for more detailed style creation.

  • Vale now includes a --config parameter that allows you to specify the location of a configuration file, effectively bypassing the 6-level search restriction.

  • Vale now offers a --debug flag that instructs it to print debugging information to stdout.

  • occurrence now optionally accepts a min key, allowing it to enforce a minimum number of times a particular token must appear in a given scope.

  • Vale now includes support for Sphinx's superset of reStructuredText. In order to make use of this feature, you need to define SphinxBuildPath (and, optionally, SphinxAutoBuild) in your config file:

    MinAlertLevel = suggestion
    
    # `SphinxBuildPath` is the path to your `_build` directory 
    # (relative to the `.vale.ini` file).
    SphinxBuildPath = _build
    
    # `SphinxAutoBuild` is the command that builds your site 
    # (`make html` is the default for Sphinx).
    # 
    # If this is defined, Vale will re-build your site prior to linting 
    # any content -- which makes it possible to use Sphinx and 
    # Vale in lint-on-the-fly environments (e.g., text editors) at 
    # the cost of performance.
    SphinxAutoBuild = make html
    
    [*.rst]
    BasedOnStyles = Vale

    See #147 for more information.

Bug Fixes

  • Vale now respects ICONV definitions in affix files (#148).
  • Vale now uses yuin/goldmark to process Markdown, fixing some minor CommonMark-related inconsistencies.