Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 23 additions & 1 deletion dist/core/rules/input-requires-label.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions src/core/rules/input-requires-label.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ export default {
nested: boolean
}> = []
let labelDepth = 0
const labelStateStack: Array<{
hasText: boolean
inputStartIndex: number
}> = []

parser.addListener('tagstart', (event) => {
const tagName = event.tagName.toLowerCase()
Expand All @@ -43,16 +47,39 @@ export default {
// implicit label (no `for`): nesting labels the input
// a self-closing <label/> opens no scope and emits no tagend
labelDepth++
labelStateStack.push({
hasText: false,
inputStartIndex: inputTags.length,
})
}
}
})

parser.addListener('tagend', (event) => {
if (event.tagName.toLowerCase() === 'label' && labelDepth > 0) {
const state = labelStateStack.pop()
if (state && !state.hasText) {
for (let i = state.inputStartIndex; i < inputTags.length; i++) {
inputTags[i].nested = false
}
} else if (state && state.hasText && labelStateStack.length > 0) {
labelStateStack[labelStateStack.length - 1].hasText = true
}
labelDepth--
}
})

parser.addListener('text', (event) => {
if (
labelDepth > 0 &&
event.raw &&
!/^\s*$/.test(event.raw) &&
labelStateStack.length > 0
) {
labelStateStack[labelStateStack.length - 1].hasText = true
}
})

parser.addListener('end', () => {
inputTags.forEach((inputTag) => {
if (!inputTag.nested && !hasMatchingLabelTag(inputTag)) {
Expand Down
61 changes: 53 additions & 8 deletions test/rules/input-requires-label.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,27 @@ describe(`Rules: ${ruleId}`, () => {
expect(messages.length).toBe(0)
})

it('Input tag nested inside label tag should result in no error', () => {
const code = '<label><input type="password" /></label>'
it('Input nested inside label with text before should result in no error', () => {
const code = '<label>Password <input type="password" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(0)
})

it('Input nested inside label with text after should result in no error', () => {
const code = '<label><input type="email" /> Email</label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(0)
})

it('Input nested inside label with text in child element should result in no error', () => {
const code = '<label><span>Email</span> <input type="email" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(0)
})

// Multiple inputs inside one label are all accepted. The HTML spec
// associates only the first labelable descendant with the label, but
// this rule is about "every input has a label nearby" for a11y, not
// strict spec conformance.
it('Multiple inputs nested inside one label should result in no error', () => {
it('Multiple inputs nested inside label with text should result in no error', () => {
const code =
'<label><input type="password" /><input type="text" /></label>'
'<label>Credentials <input type="text" /><input type="password" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(0)
})
Expand Down Expand Up @@ -136,5 +144,42 @@ describe(`Rules: ${ruleId}`, () => {
expect(messages[0].rule.id).toBe(ruleId)
expect(messages[0].type).toBe('warning')
})

it('Input nested inside label with no text should result in error', () => {
const code = '<label><input type="password" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(1)
expect(messages[0].rule.id).toBe(ruleId)
expect(messages[0].type).toBe('warning')
})

it('Input nested inside label with whitespace only should result in error', () => {
const code = '<label> <input type="text" /> </label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(1)
expect(messages[0].rule.id).toBe(ruleId)
expect(messages[0].type).toBe('warning')
})

it('Multiple inputs nested inside label with no text should result in errors', () => {
const code =
'<label><input type="text" /><input type="password" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(2)
})

it('Valid label followed by empty label should only warn for the empty one', () => {
const code =
'<label>Username <input type="text" /></label><label><input type="password" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(1)
})

it('Nested labels: outer with text should not false-warn outer input', () => {
const code =
'<label>Outer <label><input type="checkbox" /></label><input type="text" /></label>'
const messages = HTMLHint.verify(code, ruleOptions)
expect(messages.length).toBe(1)
})
})
})
Loading