isabella232 / alex

A Vale-compatible implementation of the guidelines enforced by the alex linter: catch insensitive, inconsiderate writing.

alex

alex: Catch insensitive, inconsiderate writing.

This repository contains a Vale-compatible implementation of the guidelines enforced by the alex (LICENSE) linter.

Getting Started

❗ alex requires Vale >= 1.7.0. ❗

Download the latest release, copy the "alex" 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 = alex

See Usage for more information.

Using the Template

This repository serves as a template for creating your own style. The following files/folders should be edited with your own infomation:

• alex: This is where your actual style should be implemented. Re-name the folder and replace its content with your .yml rule files.

• features + fixtures: This is where your tests should reside.

• LICENSE: replace with your own license information.

• .travis.yml: Replace all instances of "alex" with the name of your style. You'll also need to add your own $GITHUB_TOKEN to your Travis CI repository settings.