jdkato / INI

A Vale-compatible implementation of the Inclusive Naming Initiative guidelines.

INI

This repository contains a Vale-compatible implementation of the guidelines created by the Inclusive Naming Initiative.

Getting Started

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles
MinAlertLevel = suggestion

Packages = https://github.com/jdkato/INI/releases/download/v0.1.1/INI.zip

[*]
BasedOnStyles = Vale, INI

See Packages for more information.

Creating a Release

To create a new release, follow the steps outlined at Managing releases in a repository.

The Vale package, INI.zip, will be uploaded automatically by the GitHub CI workflow (.github/workflows/release.yml).

Repository Structure

INI

The INI directory contains the actual Vale-compatible implementation of the INI guidelines.

script

The script directory contains a script that can be used to generate an approximate implementation of the INI guidelines from their actual JSON source.

Some details have been changed in the INI release directory to better accommodate the Vale CLI.

testdata

The testdata directory contains a set of test cases that can be used to validate the INI implementation. Each subdirectory contains a set of test cases for a specific rule.

These tests are run automatically by the GitHub CI system (see .github/workflows/test.yml).