leftxs / vale-splunk-style-guide

Splunk Style Guide for the Vale linter

Vale is an open source prose linter that can check the content of documents in several formats against style guide rules. The goal of a prose linter is automating style guide checks in docs-as-code environments, so that style issues are detected before deploy or while editing documentation in a code editor. This repo contains a set of linting rules for Vale based on the Splunk Style Guide.

Get started

1. Clone the repository.
2. Install Vale with brew install vale or similar commands. See Installation.
3. (Optional) Install the Vale add-on for Visual Studio Code.
4. (Optional) Set vale.core.useCLI to true in the extension settings.
5. Run vale . from the root folder of the repo, or save/edit a file using Visual Studio Code.

For more information, see Usage.

Folder structure

• .vale.ini contains the Vale settings. See Configuration.
• styles/Splunk contains the Splunk rules for Vale. See Styles.

Use as a git submodule

To use the contents of this repository as a git submodule, run the following git commands from the target repo:

git submodule add [e-mail]:splunk/vale-splunk-style-guide.git
git submodule update --init --recursive
git commit -m "Added the Vale submodule to the project."
git push

Copy the sample .vale.ini file to the root of your repository, and change the path to point to the submodule:

StylesPath = vale/styles

To update the submodule, run the following git command from the root folder of the repository:

git submodule update --remote --merge

Resources

• Vale's official documentation
• Regex101, a web-based regular expressions editor

License

This software is licensed under the Apache License 2.0. Details can be found in the file LICENSE.