Skip to content

Update method name checker to clear message #125

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

Merged
srt32 merged 1 commit into from
Mar 9, 2021
Merged

Update method name checker to clear message #125

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
6 changes: 5 additions & 1 deletion docs/_guide/anti-patterns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,14 +142,18 @@ When naming a method, you should avoid naming it something that already exists o
const goodEl = document.querySelector('.js-methodname-shadow-good-input')
const badEl = document.querySelector('.js-methodname-shadow-bad-input')
const warnEl = document.querySelector('.js-methodname-shadow-warn-input')
if (name === '') {
goodEl.hidden = true
return
}
let warning = warnings[name]
if (name !== name.toLowerCase() && name.toLowerCase() in HTMLElement.prototype) {
warning = `it is too similar to \`${name.toLowerCase()}\` which already exists`
} else if (name.startsWith('on') && !(name in HTMLElement.prototype)) {
warning = 'starting with `on` suggests a coupling between the event and the method (see below)'
}
goodEl.hidden = warning || (name in HTMLElement.prototype)
warnEl.hidden = !warning
warnEl.hidden = !warning
badEl.hidden = warning || !(name in HTMLElement.prototype)
if (warning) {
warnEl.querySelector('span').textContent = warning
Expand Down