kolchfa-aws c9da6c07ad
Add style workflow (#3909)
* Tweak rules

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Rule changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove the following and simple

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revised rules and added tests

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Soft rollout with only spelling and terms

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add Vale to readme

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Only lint modified and added files

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove run on workflow dispatch

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Removed only added and modified files

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added please

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed min alert level to warning

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Don't fail on error and minor changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove fail on error

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Attempt to have vale not fail

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fixed links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update README.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update README.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -04:00

25 lines
847 B
YAML

extends: script
message: "Do not stack headings. Insert an introductory sentence between headings."
level: error
link: https://github.com/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#formatting-and-organization
scope: raw
script: |
text := import("text")
matches := []
// Replace code blocks with dummy text to avoid processing comments
document := text.re_replace("(?s) *(```.*?```)", scope, "text")
isHeading := false
for line in text.split(document, "\n") {
if text.trim_space(line) != "" {
if text.has_prefix(line, "#") {
if isHeading == true {
start := text.index(scope, line)
matches = append(matches, {begin: start, end: start + len(line)})
}
isHeading = true // new section; reset count
} else {
isHeading = false
}
}
}