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

Add scopes for punctuation. #231

Merged
jasonrudolph merged 3 commits into from
Aug 9, 2019
Merged

Add scopes for punctuation. #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ff3b49
Add scopes for punctuation (fixes #22).
savetheclocktower Jul 18, 2019
a0d8941
Handle single quotes.
savetheclocktower Jul 18, 2019
c41dd49
Add unit tests.
Aug 8, 2019
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
20 changes: 20 additions & 0 deletions grammars/tree-sitter-html.cson
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,23 @@ scopes:
'attribute_name': 'entity.other.attribute-name'
'attribute_value': 'string.html'
'comment': 'comment.block.html'

'
start_tag > "<",
end_tag > "</"
': 'punctuation.definition.tag.begin'
'
start_tag > ">",
end_tag > ">"
': 'punctuation.definition.tag.end'

'attribute > "="': 'punctuation.separator.key-value.html'

# quoted_attribute_value has three child nodes: ", attribute_value, and ".
# Target the first and last.
# Single quotes and double quotes are targeted in separate selectors because
# of quote-escaping difficulties.
"quoted_attribute_value > '\"':nth-child(0)": 'punctuation.definition.string.begin'
'quoted_attribute_value > "\'":nth-child(0)': 'punctuation.definition.string.begin'
"quoted_attribute_value > '\"':nth-child(2)": 'punctuation.definition.string.end'
'quoted_attribute_value > "\'":nth-child(2)': 'punctuation.definition.string.end'
7 changes: 4 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
},
"dependencies": {
"atom-grammar-test": "^0.6.3",
"tree-sitter-html": "^0.15.0",
"tree-sitter-embedded-template": "^0.15.0"
"tree-sitter-embedded-template": "^0.15.0",
"tree-sitter-html": "^0.15.0"
},
"devDependencies": {
"coffeelint": "^1.10.1"
"coffeelint": "^1.10.1",
"dedent": "^0.7.0"
}
}
81 changes: 81 additions & 0 deletions spec/tree-sitter-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
const dedent = require('dedent')

describe('Tree-sitter HTML grammar', () => {

beforeEach(async () => {
atom.config.set('core.useTreeSitterParsers', true)
await atom.packages.activatePackage('language-html')
})

it('tokenizes punctuation in HTML tags and attributes', async () => {
const editor = await atom.workspace.open(`test.html`)

editor.setText(dedent`
<html lang="en">
<head>
<meta charset='utf-8'>
<meta name='"' content="This'll test single and double quotes.">
</head>
<body>
</html>
`)

// Tag punctuation.
expect(editor.scopeDescriptorForBufferPosition([0, 0]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.tag.begin'
)

expect(editor.scopeDescriptorForBufferPosition([0, 15]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.tag.end'
)

expect(editor.scopeDescriptorForBufferPosition([6, 0]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.tag.begin'
)

expect(editor.scopeDescriptorForBufferPosition([6, 6]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.tag.end'
)

// Attribute-value pair punctuation.
expect(editor.scopeDescriptorForBufferPosition([0, 10]).toString()).toBe(
'.text.html.basic .source.html .punctuation.separator.key-value.html'
)

expect(editor.scopeDescriptorForBufferPosition([2, 18]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.begin'
)

expect(editor.scopeDescriptorForBufferPosition([2, 24]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.end'
)

// Ensure an attribute value delimited by single-quotes won't mark a
// double-quote in the value as punctuation.
expect(editor.scopeDescriptorForBufferPosition([3, 15]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.begin'
)

expect(editor.scopeDescriptorForBufferPosition([3, 16]).toString()).toBe(
'.text.html.basic .source.html .string.html'
)

expect(editor.scopeDescriptorForBufferPosition([3, 17]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.end'
)

// Ensure an attribute value delimited by double-quotes won't mark a
// single-quote in the value as punctuation.
expect(editor.scopeDescriptorForBufferPosition([3, 27]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.begin'
)

expect(editor.scopeDescriptorForBufferPosition([3, 32]).toString()).toBe(
'.text.html.basic .source.html .string.html'
)

expect(editor.scopeDescriptorForBufferPosition([3, 66]).toString()).toBe(
'.text.html.basic .source.html .punctuation.definition.string.end'
)
})
})