https://github.com/splunk/vale-splunk-style-guide
Splunk Style Guide for the Vale linter
https://github.com/splunk/vale-splunk-style-guide
splunk vale-linter-style
Last synced: 2 months ago
JSON representation
Splunk Style Guide for the Vale linter
- Host: GitHub
- URL: https://github.com/splunk/vale-splunk-style-guide
- Owner: splunk
- License: apache-2.0
- Created: 2022-09-15T15:15:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T21:58:53.000Z (over 1 year ago)
- Last Synced: 2025-10-11T09:57:32.377Z (7 months ago)
- Topics: splunk, vale-linter-style
- Homepage: https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse
- Size: 280 KB
- Stars: 20
- Watchers: 6
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Vale](https://github.com/errata-ai/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](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse).
# Get started
1. Clone the repository.
2. Install Vale with `brew install vale` or similar commands. See [Installation](https://vale.sh/docs/vale-cli/installation/).
3. (Optional) Install the [Vale add-on for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server).
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 [Scoping](https://vale.sh/docs/topics/scoping/).
# Folder structure
- `.vale.ini` contains the Vale settings. See [Configuration](https://vale.sh/docs/topics/config/).
- `styles/Splunk` contains the Splunk rules for Vale. See [Styles](https://vale.sh/docs/topics/styles/).
# Use as a git submodule
To use the contents of this repository as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), run the following git commands from the target repo:
```bash
git submodule add git@github.com: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:
```ini
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](https://vale.sh/docs/vale-cli/overview/)
- [Regex101, a web-based regular expressions editor](https://regex101.com/)
# License
This software is licensed under the Apache License 2.0. Details can be found in the file LICENSE.