From d125b9b3535750bc7d36764c14b9cb40445978ed Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Wed, 17 Sep 2025 11:35:54 -0700 Subject: [PATCH 1/2] Create listpunctuation.yml --- styles/Datadog/listpunctuation.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 styles/Datadog/listpunctuation.yml diff --git a/styles/Datadog/listpunctuation.yml b/styles/Datadog/listpunctuation.yml new file mode 100644 index 0000000..4b8152e --- /dev/null +++ b/styles/Datadog/listpunctuation.yml @@ -0,0 +1,28 @@ +# Rule 1: Detect list items without ending punctuation +# This helps identify when list items might need periods for consistency +extends: existence +message: "List item without ending punctuation. Consider adding a period if other items in the list have periods." +link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#lists" +level: suggestion +scope: raw +ignorecase: false +tokens: + # Match bulleted list items that don't end with punctuation + - '^(?:\s*)(?:[\•\-\*\+])\s+[^.!?]*[a-zA-Z0-9)]\s*$' + # Match numbered list items that don't end with punctuation + - '^(?:\s*)(?:\d+\.)\s+[^.!?]*[a-zA-Z0-9)]\s*$' + +--- +# Rule 2: Detect list items with ending punctuation +# This helps identify when list items might not need periods for consistency +extends: existence +message: "List item with ending punctuation. Consider removing the period if other items in the list don't have periods." +link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#lists" +level: suggestion +scope: raw +ignorecase: false +tokens: + # Match bulleted list items that end with punctuation + - '^(?:\s*)(?:[\•\-\*\+])\s+[^.!?]*[.!?]\s*$' + # Match numbered list items that end with punctuation + - '^(?:\s*)(?:\d+\.)\s+[^.!?]*[.!?]\s*$' \ No newline at end of file From 61f3bab1446170c83ccceaeec07d68850c77bf43 Mon Sep 17 00:00:00 2001 From: Rosa Trieu Date: Wed, 17 Sep 2025 11:47:04 -0700 Subject: [PATCH 2/2] update rule --- .vale.ini | 3 ++- styles/Datadog/listpunctuation.yml | 31 +++++++----------------------- 2 files changed, 9 insertions(+), 25 deletions(-) diff --git a/.vale.ini b/.vale.ini index 922a5e0..7c4c6e6 100644 --- a/.vale.ini +++ b/.vale.ini @@ -31,4 +31,5 @@ Datadog.spaces = YES Datadog.tense = YES Datadog.words = YES Datadog.quotes = YES -Datadog.aws = YES \ No newline at end of file +Datadog.aws = YES +Datadog.listpunctuation = YES \ No newline at end of file diff --git a/styles/Datadog/listpunctuation.yml b/styles/Datadog/listpunctuation.yml index 4b8152e..bcdd573 100644 --- a/styles/Datadog/listpunctuation.yml +++ b/styles/Datadog/listpunctuation.yml @@ -1,28 +1,11 @@ -# Rule 1: Detect list items without ending punctuation -# This helps identify when list items might need periods for consistency extends: existence -message: "List item without ending punctuation. Consider adding a period if other items in the list have periods." +message: "List items should have consistent punctuation." link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#lists" -level: suggestion +level: warning scope: raw -ignorecase: false +ignorecase: true tokens: - # Match bulleted list items that don't end with punctuation - - '^(?:\s*)(?:[\•\-\*\+])\s+[^.!?]*[a-zA-Z0-9)]\s*$' - # Match numbered list items that don't end with punctuation - - '^(?:\s*)(?:\d+\.)\s+[^.!?]*[a-zA-Z0-9)]\s*$' - ---- -# Rule 2: Detect list items with ending punctuation -# This helps identify when list items might not need periods for consistency -extends: existence -message: "List item with ending punctuation. Consider removing the period if other items in the list don't have periods." -link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#lists" -level: suggestion -scope: raw -ignorecase: false -tokens: - # Match bulleted list items that end with punctuation - - '^(?:\s*)(?:[\•\-\*\+])\s+[^.!?]*[.!?]\s*$' - # Match numbered list items that end with punctuation - - '^(?:\s*)(?:\d+\.)\s+[^.!?]*[.!?]\s*$' \ No newline at end of file + # Match bulleted list items starting with - + - '^\s*-\s+.*$' + # Match numbered list items + - '^\s*\d+\.\s+.*$' \ No newline at end of file