Skip to content
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

GlobalEventHandlers have different docs URL on mdn then attribute #77

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

GlobalEventHandlers have different docs URL on mdn then attribute #77

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f5a14d2
fixed Global Attributes Doc URL on global events
lalitsom Sep 24, 2017
6c5e3ee
removed trailing white space
lalitsom Sep 24, 2017
c88e105
removed a bug because of no description in on* event
lalitsom Sep 25, 2017
233a85d
added space after comma
lalitsom Sep 25, 2017
37cc7fc
added test assertions for onabort and aria-busy in provider-spec.coffee
lalitsom Sep 25, 2017
42cbb7c
changed aria to ar in assertions
lalitsom Sep 25, 2017
38f7700
added assertion aria-
lalitsom Sep 25, 2017
fdebb55
removed aria- assertion
lalitsom Sep 25, 2017
287d3d0
added docs for aria-attribute and role
lalitsom Sep 25, 2017
7056e19
added tests for role attribute and removed description parameter
lalitsom Sep 25, 2017
7d5dbd9
filter suggestions list by prefix
lalitsom Sep 27, 2017
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
14 changes: 11 additions & 3 deletions lib/provider.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ module.exports =
displayText: attribute
type: 'attribute'
description: description ? "Global #{attribute} attribute"
descriptionMoreURL: if description then @getGlobalAttributeDocsURL(attribute) else null
descriptionMoreURL: @getGlobalAttributeDocsURL(attribute, description)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description is not used and can be removed


getAttributeValueCompletions: ({prefix, editor, bufferPosition}) ->
completions = []
Expand Down Expand Up @@ -180,8 +180,16 @@ module.exports =
getLocalAttributeDocsURL: (attribute, tag) ->
"#{@getTagDocsURL(tag)}#attr-#{attribute}"

getGlobalAttributeDocsURL: (attribute) ->
"https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/#{attribute}"
getGlobalAttributeDocsURL: (attribute, description) ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description is not used and can be removed

if attribute.startsWith('on')
"https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/#{attribute}"
else if attribute.startsWith('aria-')
# As of September 2017, MDN does not have pages for ARIA attributes
"https://www.w3.org/TR/wai-aria-1.1/##{attribute}"
else if attribute.startsWith('role')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

attribute is 'role'

"https://www.w3.org/TR/wai-aria-1.1/#usage_intro"
else
"https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/#{attribute}"

firstCharsEqual = (str1, str2) ->
str1[0].toLowerCase() is str2[0].toLowerCase()
4 changes: 2 additions & 2 deletions spec/provider-spec.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,15 +294,15 @@ describe "HTML autocompletions", ->
expect(-> completions = getCompletions()).not.toThrow()
expect(completions[0].displayText).toBe 'onafterprint'

it "does not provide a descriptionMoreURL if the attribute does not have a unique description", ->
it "provide a descriptionMoreURL if the attribute does not have a unique description but starts with on*", ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"provide" -> "provides"

Similar tests can also be added now for aria- and role.

editor.setText('<input on')
editor.setCursorBufferPosition([0, 9])

completions = getCompletions()

expect(completions[0].displayText).toBe 'onabort'
expect(completions[0].description).toBe 'Global onabort attribute'
expect(completions[0].descriptionMoreURL).toBeNull()
expect(completions[0].descriptionMoreURL.endsWith('/Web/API/GlobalEventHandlers/onabort')).toBe true

it "autocompletes attribute values without a prefix", ->
editor.setText('<marquee behavior=""')
Expand Down