Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
raulkolaric wants to merge 1 commit into from
Closed

Add a warning for consecutive duplicate words #45497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions data/reusables/contributing/content-linter-rules.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down
153 changes: 153 additions & 0 deletions src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
info?: string
map?: [number, number]
}

interface DuplicateWordMatch {
firstWord: string
secondWord: string
start: number
text: string
whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
/(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
const letters = word.match(/\p{L}/gu)?.join('') || ''
return (
letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
)
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
const matches: DuplicateWordMatch[] = []

DUPLICATE_WORD_PATTERN.lastIndex = 0
let match: RegExpExecArray | null
while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
const [, firstWord, whitespace, secondWord] = match
if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

matches.push({
firstWord,
secondWord,
start: match.index,
text: match[0],
whitespaceLength: whitespace.length,
})
}

return matches
}

function reportDuplicateWords(
text: string,
sourceLine: string,
lineNumber: number,
sourceOffset: number,
onError: RuleErrorCallback,
reportedLocations: Set<string>,
): void {
for (const match of findDuplicateWords(text)) {
const expectedMatchOffset = sourceOffset + match.start
const sourceMatchOffset =
sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
? expectedMatchOffset
: sourceLine.indexOf(match.text, sourceOffset)
const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
const location = `${lineNumber}:${duplicateColumn}`
if (reportedLocations.has(location)) continue
reportedLocations.add(location)

addError(
onError,
lineNumber,
`Check whether the repeated word "${match.secondWord}" is intentional.`,
ellipsify(sourceLine),
[duplicateColumn, match.secondWord.length],
null,
)
}
}

function isSentenceLikeText(line: string): boolean {
return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
names: ['GHD068', 'consecutive-duplicate-words'],
description: 'Consecutive words must not be repeated',
tags: ['format'],
parser: 'markdownit',
function: (params: RuleParams, onError: RuleErrorCallback) => {
const reportedLocations = new Set<string>()

filterTokens(params, 'inline', (token: MarkdownItToken) => {
let currentLineNumber = token.lineNumber || 1
let sourceCursor = 0

for (const child of token.children || []) {
const childLineNumber = child.lineNumber || token.lineNumber || 1
const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

if (childLineNumber !== currentLineNumber) {
currentLineNumber = childLineNumber
sourceCursor = 0
}

const childContent = child.content || ''
const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

if (child.type === 'text' && childContent) {
const sourceOffset = childOffset >= 0 ? childOffset : 0
reportDuplicateWords(
childContent,
sourceLine,
childLineNumber,
sourceOffset,
onError,
reportedLocations,
)
}

if (childOffset >= 0) sourceCursor = childOffset + childContent.length
}
})

filterTokens(params, 'fence', (token: MarkdownItToken) => {
const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
if (language !== 'text' || !token.map) return

const contentLines = (token.content || '').split('\n')
const firstContentLineIndex = token.map[0] + 1

for (const [offset, contentLine] of contentLines.entries()) {
if (!contentLine || !isSentenceLikeText(contentLine)) continue

const sourceLineIndex = firstContentLineIndex + offset
const sourceLine = params.lines[sourceLineIndex] || contentLine
const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
reportDuplicateWords(
contentLine,
sourceLine,
sourceLineIndex + 1,
sourceOffset,
onError,
reportedLocations,
)
}
})
},
}
2 changes: 2 additions & 0 deletions src/content-linter/lib/linting-rules/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
frontmatterContentType, // GHD065
frontmatterDocsTeamMetrics, // GHD066
frontmatterRestApiCategory, // GHD067
consecutiveDuplicateWords, // GHD068

// Search-replace rules
searchReplace, // Open-source plugin
Expand Down
6 changes: 6 additions & 0 deletions src/content-linter/style/github-docs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
severity: 'error',
'partial-markdown-files': false,
},
'consecutive-duplicate-words': {
// GHD068
severity: 'warning',
'partial-markdown-files': true,
'yml-files': true,
},
}

export const githubDocsFrontmatterConfig = {
Expand Down
135 changes: 135 additions & 0 deletions src/content-linter/tests/unit/consecutive-duplicate-words.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
test('reports lowercase and case-insensitive duplicate words', async () => {
const markdown = [
'You will use use this process.',
'For more more information, see the guide.',
'This version is newer than the the published version.',
'Open the Terminal Chat chat window.',
'Create an Azure Blob Storage storage account.',
'The café café is nearby.',
].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(6)
expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
expect(errors[0].errorRange).toEqual([14, 3])
expect(errors[3].errorRange).toEqual([24, 4])
expect(errors[4].errorRange).toEqual([30, 7])
})

test('reports duplicates in common Markdown prose constructs', async () => {
const markdown = [
'# A repeated repeated heading',
'',
'* A duplicate duplicate list item.',
'',
'> A repeated repeated blockquote.',
'',
'**Terminal Chat chat** window.',
'',
'[More more information](https://example.com).',
'',
'| Value | Description |',
'| --- | --- |',
'| Test | A repeated repeated value. |',
].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(6)
expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
expect(errors[3].errorRange).toEqual([17, 4])
expect(errors[4].errorRange).toEqual([7, 4])
})

test('reports every duplicate pair on the same line', async () => {
const markdown = 'This is is wrong, and that that is also wrong.'

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(2)
expect(errors.map((error) => error.errorRange)).toEqual([
[9, 2],
[28, 4],
])
})

test('reports accurate ranges after encoded text and tabs', async () => {
const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(2)
expect(errors.map((error) => error.errorRange)).toEqual([
[19, 8],
[9, 2],
])
})

test('reports sentence-like prose in text fences', async () => {
const markdown = [
'```text',
'Currently, the option is used to to pass a token.',
'',
'view View sub-issues',
'```',
].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(1)
expect(errors[0].lineNumber).toBe(2)
expect(errors[0].errorRange).toEqual([34, 2])
})

test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
const markdown = [
'This is very, very important.',
'Follow the how-to to complete the setup.',
'Use logical OR or logical AND.',
'Replace hostname HOSTNAME in the command.',
'Click **Delete Tag TAG NAME**.',
'The API API pair is intentionally tested separately.',
'`use use` is an inline code example.',
'',
'```shell',
'python -m venv venv',
'```',
'',
'<a class="btn btn-primary">Button</a>',
].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(1)
expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
expect(errors[0].lineNumber).toBe(6)
})

test('respects Markdownlint suppression comments', async () => {
const markdown = [
'<!-- markdownlint-disable-next-line GHD068 -->',
'The words had had a deliberate meaning.',
'This is is still an error.',
].join('\n')

const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
const errors = result.markdown

expect(errors).toHaveLength(1)
expect(errors[0].lineNumber).toBe(3)
})
})
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add a warning for consecutive duplicate words#45497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

raulkolaric
wants to merge
1
commit into

from

 Closed


Add a warning for consecutive duplicate words
#45497
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
data/reusables/contributing/content-linter-rules.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@
| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type |
| GHD066 | frontmatter-docs-team-metrics | Articles whose path contains a path-enforced docsTeamMetrics value must include that value in their docsTeamMetrics frontmatter property. | error | frontmatter, docs-team-metrics |
| GHD067 | frontmatter-rest-api-category | Autogenerated REST API endpoint files must have a valid `category` frontmatter property | error | frontmatter, rest, category |
| GHD068 | consecutive-duplicate-words | Consecutive words must not be repeated | warning | format |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |
Expand Down

153 changes: 153 additions & 0 deletions
src/content-linter/lib/linting-rules/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
import { addError, ellipsify, filterTokens } from 'markdownlint-rule-helpers'

import type { MarkdownToken, Rule, RuleErrorCallback, RuleParams } from '@/content-linter/types'

interface MarkdownItToken extends MarkdownToken {
 info?: string
 map?: [number, number]
}

interface DuplicateWordMatch {
 firstWord: string
 secondWord: string
 start: number
 text: string
 whitespaceLength: number
}

const DUPLICATE_WORD_PATTERN =
 /(?<![\p{L}\p{M}'’-])([\p{L}][\p{L}\p{M}'’-]*)([^\S\r\n]+)(\1)(?![\p{L}\p{M}'’-])/giu

function isAllUppercase(word: string): boolean {
 const letters = word.match(/\p{L}/gu)?.join('') || ''
 return (
 letters.length > 0 && letters === letters.toUpperCase() && letters !== letters.toLowerCase()
 )
}

function isPlaceholderOrOperatorPair(firstWord: string, secondWord: string): boolean {
 return firstWord !== secondWord && (isAllUppercase(firstWord) || isAllUppercase(secondWord))
}

function findDuplicateWords(text: string): DuplicateWordMatch[] {
 const matches: DuplicateWordMatch[] = []

 DUPLICATE_WORD_PATTERN.lastIndex = 0
 let match: RegExpExecArray | null
 while ((match = DUPLICATE_WORD_PATTERN.exec(text)) !== null) {
 const [, firstWord, whitespace, secondWord] = match
 if (isPlaceholderOrOperatorPair(firstWord, secondWord)) continue

 matches.push({
 firstWord,
 secondWord,
 start: match.index,
 text: match[0],
 whitespaceLength: whitespace.length,
 })
 }

 return matches
}

function reportDuplicateWords(
 text: string,
 sourceLine: string,
 lineNumber: number,
 sourceOffset: number,
 onError: RuleErrorCallback,
 reportedLocations: Set<string>,
): void {
 for (const match of findDuplicateWords(text)) {
 const expectedMatchOffset = sourceOffset + match.start
 const sourceMatchOffset =
 sourceLine.slice(expectedMatchOffset, expectedMatchOffset + match.text.length) === match.text
 ? expectedMatchOffset
 : sourceLine.indexOf(match.text, sourceOffset)
 const resolvedMatchOffset = sourceMatchOffset >= 0 ? sourceMatchOffset : expectedMatchOffset
 const duplicateOffset = match.start + match.firstWord.length + match.whitespaceLength
 const duplicateColumn = resolvedMatchOffset + duplicateOffset - match.start + 1
 const location = `${lineNumber}:${duplicateColumn}`
 if (reportedLocations.has(location)) continue
 reportedLocations.add(location)

 addError(
 onError,
 lineNumber,
 `Check whether the repeated word "${match.secondWord}" is intentional.`,
 ellipsify(sourceLine),
 [duplicateColumn, match.secondWord.length],
 null,
 )
 }
}

function isSentenceLikeText(line: string): boolean {
 return /[.!?]["')\]}]*$/.test(line.trim())
}

export const consecutiveDuplicateWords: Rule = {
 names: ['GHD068', 'consecutive-duplicate-words'],
 description: 'Consecutive words must not be repeated',
 tags: ['format'],
 parser: 'markdownit',
 function: (params: RuleParams, onError: RuleErrorCallback) => {
 const reportedLocations = new Set<string>()

 filterTokens(params, 'inline', (token: MarkdownItToken) => {
 let currentLineNumber = token.lineNumber || 1
 let sourceCursor = 0

 for (const child of token.children || []) {
 const childLineNumber = child.lineNumber || token.lineNumber || 1
 const sourceLine = child.line || token.line || params.lines[childLineNumber - 1] || ''

 if (childLineNumber !== currentLineNumber) {
 currentLineNumber = childLineNumber
 sourceCursor = 0
 }

 const childContent = child.content || ''
 const childOffset = childContent ? sourceLine.indexOf(childContent, sourceCursor) : -1

 if (child.type === 'text' && childContent) {
 const sourceOffset = childOffset >= 0 ? childOffset : 0
 reportDuplicateWords(
 childContent,
 sourceLine,
 childLineNumber,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }

 if (childOffset >= 0) sourceCursor = childOffset + childContent.length
 }
 })

 filterTokens(params, 'fence', (token: MarkdownItToken) => {
 const language = token.info?.trim().split(/\s+/)[0]?.toLowerCase()
 if (language !== 'text' || !token.map) return

 const contentLines = (token.content || '').split('\n')
 const firstContentLineIndex = token.map[0] + 1

 for (const [offset, contentLine] of contentLines.entries()) {
 if (!contentLine || !isSentenceLikeText(contentLine)) continue

 const sourceLineIndex = firstContentLineIndex + offset
 const sourceLine = params.lines[sourceLineIndex] || contentLine
 const sourceOffset = Math.max(0, sourceLine.indexOf(contentLine))
 reportDuplicateWords(
 contentLine,
 sourceLine,
 sourceLineIndex + 1,
 sourceOffset,
 onError,
 reportedLocations,
 )
 }
 })
 },
}

2 changes: 2 additions & 0 deletions
src/content-linter/lib/linting-rules/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-
import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type'
import { frontmatterDocsTeamMetrics } from '@/content-linter/lib/linting-rules/frontmatter-docs-team-metrics'
import { frontmatterRestApiCategory } from '@/content-linter/lib/linting-rules/frontmatter-rest-api-category'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

const noDefaultAltText = markdownlintGitHub.find((elem: { names: string[] }) =>
 elem.names.includes('no-default-alt-text'),
Expand DownExpand Up@@ -124,6 +125,7 @@ export const gitHubDocsMarkdownlint = {
 frontmatterContentType, // GHD065
 frontmatterDocsTeamMetrics, // GHD066
 frontmatterRestApiCategory, // GHD067
 consecutiveDuplicateWords, // GHD068

 // Search-replace rules
 searchReplace, // Open-source plugin
Expand Down

6 changes: 6 additions & 0 deletions
src/content-linter/style/github-docs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,6 +192,12 @@ const githubDocsConfig = {
 severity: 'error',
 'partial-markdown-files': false,
 },
 'consecutive-duplicate-words': {
 // GHD068
 severity: 'warning',
 'partial-markdown-files': true,
 'yml-files': true,
 },
}

export const githubDocsFrontmatterConfig = {
Expand Down

135 changes: 135 additions & 0 deletions
src/content-linter/tests/unit/consecutive-duplicate-words.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
import { describe, expect, test } from 'vitest'

import { runRule } from '@/content-linter/lib/init-test'
import { consecutiveDuplicateWords } from '@/content-linter/lib/linting-rules/consecutive-duplicate-words'

describe(consecutiveDuplicateWords.names.join(' - '), () => {
 test('reports lowercase and case-insensitive duplicate words', async () => {
 const markdown = [
 'You will use use this process.',
 'For more more information, see the guide.',
 'This version is newer than the the published version.',
 'Open the Terminal Chat chat window.',
 'Create an Azure Blob Storage storage account.',
 'The café café is nearby.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 2, 3, 4, 5, 6])
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "use" is intentional.')
 expect(errors[0].errorRange).toEqual([14, 3])
 expect(errors[3].errorRange).toEqual([24, 4])
 expect(errors[4].errorRange).toEqual([30, 7])
 })

 test('reports duplicates in common Markdown prose constructs', async () => {
 const markdown = [
 '# A repeated repeated heading',
 '',
 '* A duplicate duplicate list item.',
 '',
 '> A repeated repeated blockquote.',
 '',
 '**Terminal Chat chat** window.',
 '',
 '[More more information](https://example.com).',
 '',
 '| Value | Description |',
 '| --- | --- |',
 '| Test | A repeated repeated value. |',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(6)
 expect(errors.map((error) => error.lineNumber)).toEqual([1, 3, 5, 7, 9, 13])
 expect(errors[3].errorRange).toEqual([17, 4])
 expect(errors[4].errorRange).toEqual([7, 4])
 })

 test('reports every duplicate pair on the same line', async () => {
 const markdown = 'This is is wrong, and that that is also wrong.'

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [9, 2],
 [28, 4],
 ])
 })

 test('reports accurate ranges after encoded text and tabs', async () => {
 const markdown = ['An &amp; repeated repeated phrase.', 'This is\tis wrong.'].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(2)
 expect(errors.map((error) => error.errorRange)).toEqual([
 [19, 8],
 [9, 2],
 ])
 })

 test('reports sentence-like prose in text fences', async () => {
 const markdown = [
 '```text',
 'Currently, the option is used to to pass a token.',
 '',
 'view View sub-issues',
 '```',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(2)
 expect(errors[0].errorRange).toEqual([34, 2])
 })

 test('ignores code, placeholders, operators, punctuation, and hyphenated words', async () => {
 const markdown = [
 'This is very, very important.',
 'Follow the how-to to complete the setup.',
 'Use logical OR or logical AND.',
 'Replace hostname HOSTNAME in the command.',
 'Click **Delete Tag TAG NAME**.',
 'The API API pair is intentionally tested separately.',
 '`use use` is an inline code example.',
 '',
 '```shell',
 'python -m venv venv',
 '```',
 '',
 '<a class="btn btn-primary">Button</a>',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].errorDetail).toBe('Check whether the repeated word "API" is intentional.')
 expect(errors[0].lineNumber).toBe(6)
 })

 test('respects Markdownlint suppression comments', async () => {
 const markdown = [
 '<!-- markdownlint-disable-next-line GHD068 -->',
 'The words had had a deliberate meaning.',
 'This is is still an error.',
 ].join('\n')

 const result = await runRule(consecutiveDuplicateWords, { strings: { markdown } })
 const errors = result.markdown

 expect(errors).toHaveLength(1)
 expect(errors[0].lineNumber).toBe(3)
 })
})
Loading