IBM

A Vale-compatible implementation of IBM's Developer Editorial Style Guide.

Getting Started

:exclamation: IBM requires Vale >= 1.7.0. :exclamation:

Download the latest release, copy the "IBM" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = IBM

See Usage for more information.

Repository Structure

/IBM

The YAML-based rule implementations that make up our style.

/fixtures

The individual unit tests. Each directory should be named after a rule found in /Microsoft and include its own .vale.ini file that isolates its target rule.

/features

The Cucumber Step Definitions we use to test our fixtures. Essentially, we use the aruba framework to test Vale's output after running it on each of our fixture directories.

Extension Points