12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340 |
- const fs = require('fs');
- const path = require('path');
- const dedent = require('dedent');
- const TextBuffer = require('text-buffer');
- const { Point, Range } = TextBuffer;
- const CSON = require('season');
- const TextEditor = require('../src/text-editor');
- const ScopeResolver = require('../src/scope-resolver.js');
- const WASMTreeSitterGrammar = require('../src/wasm-tree-sitter-grammar');
- const WASMTreeSitterLanguageMode = require('../src/wasm-tree-sitter-language-mode');
- const Random = require('random-seed');
- const { getRandomBufferRange, buildRandomLines } = require('./helpers/random');
- function wait(ms) {
- return new Promise((resolve) => {
- setTimeout(resolve, ms);
- });
- }
- let PATH = path.resolve( path.join(__dirname, '..', 'packages') );
- function resolve(modulePath) {
- return require.resolve(`${PATH}/${modulePath}`)
- }
- const jsGrammarPath = resolve(
- 'language-javascript/grammars/modern-tree-sitter-javascript.cson'
- );
- let jsConfig = CSON.readFileSync(jsGrammarPath);
- const jsRegexGrammarPath = resolve(
- 'language-javascript/grammars/modern-tree-sitter-regex.cson'
- );
- let jsRegexConfig = CSON.readFileSync(jsRegexGrammarPath);
- async function getAllCapturesWithScopeResolver(grammar, languageMode, scopeResolver, layer = null) {
- let query = await grammar.getQuery('highlightsQuery');
- layer = layer ?? languageMode.rootLanguageLayer;
- let { start, end } = languageMode.buffer.getRange();
- let { tree } = layer;
- return {
- captures: query.captures(tree.rootNode, { startPosition: start, endPosition: end }),
- scopeResolver
- };
- }
- function makeScopeResolver(languageMode, layer) {
- layer = layer ?? languageMode.rootLanguageLayer;
- return new ScopeResolver(
- layer,
- (name) => languageMode.idForScope(name),
- );
- }
- async function getAllCaptures(grammar, languageMode, layer = null) {
- layer = layer ?? languageMode.rootLanguageLayer;
- let scopeResolver = makeScopeResolver(languageMode, layer);
- return getAllCapturesWithScopeResolver(grammar, languageMode, scopeResolver, layer);
- }
- async function getAllMatchesWithScopeResolver(...args) {
- let { captures, scopeResolver } = await getAllCapturesWithScopeResolver(...args);
- let matches = [];
- for (let capture of captures) {
- let range = scopeResolver.store(capture);
- if (range) {
- matches.push(capture);
- }
- }
- return matches;
- }
- async function getAllMatches(...args) {
- let { captures, scopeResolver } = await getAllCaptures(...args);
- let matches = [];
- for (let capture of captures) {
- let range = scopeResolver.store(capture);
- if (range) {
- matches.push(capture);
- }
- }
- return matches;
- }
- function stringForNodeRange(node) {
- return `${node.startIndex}-${node.endIndex}`;
- }
- function rangeFromDescriptor(rawRange) {
- let { startPosition, endPosition } = rawRange;
- let start = Point.fromObject(startPosition, true);
- let end = Point.fromObject(endPosition, true);
- return new Range(start, end);
- }
- describe('ScopeResolver', () => {
- let editor, buffer, grammar;
- beforeEach(async () => {
- grammar = new WASMTreeSitterGrammar(atom.grammars, jsGrammarPath, jsConfig);
- editor = await atom.workspace.open('');
- buffer = editor.getBuffer();
- atom.grammars.addGrammar(grammar);
- atom.config.set('core.useTreeSitterParsers', true);
- });
- afterEach(() => {
- ScopeResolver.clearConfigCache();
- });
- it('resolves all scopes in absence of any tests or adjustments', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string) @string
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node } = capture;
- let range = scopeResolver.store(capture);
- expect(stringForNodeRange(range))
- .toBe(stringForNodeRange(node));
- }
- });
- it('provides the grammar with the text of leaf nodes only', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (expression_statement) @not_leaf_node
- (call_expression) @also_not_leaf_node
- (identifier) @leaf_node
- (property_identifier) @also_leaf_node
- `);
- let tokens = [];
- const original = grammar.idForScope.bind(grammar);
- grammar.idForScope = function (scope, text) {
- if (text) {
- tokens.push(text);
- }
- return original(scope, text);
- };
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText('aa.bb(cc.dd());');
- await languageMode.ready;
- // If non-leaf nodes are included, this list would included things like
- // 'aa.bb()' and `cc.dd()`
- expect(tokens).toEqual([
- 'aa',
- 'bb',
- 'cc',
- 'dd',
- ]);
- });
- it('interpolates magic tokens in scope names', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (lexical_declaration kind: _ @declaration._TYPE_)
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- let bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let names = captures.map(({ name, node }) => {
- return ScopeResolver.interpolateName(name, node)
- });
- names.sort();
- expect(names).toEqual([
- 'declaration.const',
- 'declaration.let'
- ]);
- });
- it('does not apply any scopes when @_IGNORE_ is used', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (lexical_declaration kind: _ @_IGNORE_
- (#match? @_IGNORE_ "const"))
- (lexical_declaration kind: _ @let
- (#match? @let "let"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- let bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- if (name === '_IGNORE_') {
- expect(!!result).toBe(false);
- } else {
- expect(!!result).toBe(true);
- }
- }
- });
- it('does not apply any scopes when multiple @_IGNORE_s are used', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (variable_declarator
- (identifier) @_IGNORE_.identifier
- (string) @_IGNORE_.string
- )
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- let bar = false
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- if (name.startsWith('_IGNORE_')) {
- expect(!!result).toBe(false);
- } else {
- expect(!!result).toBe(true);
- }
- }
- });
- describe('adjustments', () => {
- it('adjusts ranges with (#set! adjust.startAt)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((try_statement) @try.plus.brace
- (#set! adjust.endAt
- firstChild.nextSibling.firstChild.endPosition))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- try { x++ } catch (e) {}
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let capture = captures[0];
- let range = scopeResolver.store(capture);
- expect(buffer.getTextInRange(rangeFromDescriptor(range)))
- .toBe('try {');
- });
- it('adjusts ranges with (#set! adjust.endAt)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((object) @object.interior
- (#set! adjust.startAt firstChild.endPosition)
- (#set! adjust.endAt lastChild.startPosition))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- {from: 'x', to: 'y'}
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let capture = captures[0];
- let range = scopeResolver.store(capture);
- expect(
- buffer.getTextInRange(rangeFromDescriptor(range))
- ).toBe(`from: 'x', to: 'y'`);
- });
- it('adjusts ranges with (#set! adjust.offset(Start|End))', async () => {
- // Same result as the previous test, but with a different technique.
- await grammar.setQueryForTest('highlightsQuery', `
- ((object) @object.interior
- (#set! adjust.offsetStart 1)
- (#set! adjust.offsetEnd -1))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- {from: 'x', to: 'y'}
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let capture = captures[0];
- let range = scopeResolver.store(capture);
- expect(
- buffer.getTextInRange(rangeFromDescriptor(range))
- ).toBe(`from: 'x', to: 'y'`);
- });
- it('prevents adjustments outside the original capture', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((comment) @too-early
- (#set! adjust.startAt previousSibling.startPosition))
- ((comment) @too-late
- (#set! adjust.endAt nextSibling.endPosition))
- ((comment) @offset-too-early
- (#set! adjust.offsetStart -10))
- ((comment) @offset-too-late
- (#set! adjust.offsetEnd 10))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- let foo = "this is a line above a comment"
- // this is a comment that wants to fly too close to the sun
- let bar = "this is a line below a comment"
- `);
- // Prevent an exception from being thrown before we can even check the
- // scopeResolver.
- spyOn(languageMode, 'isRowCommented').andReturn(false);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- expect(() => {
- scopeResolver.store(capture);
- }).toThrow();
- }
- });
- it("adjusts a range around a regex match with `adjust.startAndEndAroundFirstMatchOf`", async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((comment) @todo
- (#set! adjust.startAndEndAroundFirstMatchOf "\\\\sTODO(?=:)"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // TODO: Do something
- // TODO (don't actually do it)
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let capture = captures[0];
- let range = scopeResolver.store(capture);
- let matched = [];
- for (let capture of captures) {
- range = scopeResolver.store(capture);
- if (range) { matched.push(range); }
- }
- expect(matched.length).toBe(1);
- expect(
- buffer.getTextInRange(rangeFromDescriptor(matched[0]))
- ).toBe(` TODO`);
- });
- });
- describe('tests', () => {
- it('rejects scopes for ranges that have already been claimed by another capture with (#set! capture.final)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string) @string0
- ((string) @string1
- (#set! capture.final))
- (string) @string2
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { name } = capture;
- let result = scopeResolver.store(capture);
- if (name === 'string0') {
- expect(!!result).toBe(true);
- }
- if (name === 'string1') {
- expect(!!result).toBe(true);
- }
- if (name === 'string2') {
- expect(!!result).toBe(false);
- }
- }
- });
- it('temporarily supports the deprecated (#set! test.final true)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string) @string0
- ((string) @string1
- (#set! test.final true))
- (string) @string2
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- if (name === 'string0') {
- expect(!!result).toBe(true);
- }
- if (name === 'string1') {
- expect(!!result).toBe(true);
- }
- if (name === 'string2') {
- expect(!!result).toBe(false);
- }
- }
- });
- it('rejects scopes for ranges that have already been claimed by another capture with (#set! capture.final)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string) @string0
- ((string) @string1
- (#set! capture.final))
- (string) @string2
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- if (name === 'string0') {
- expect(!!result).toBe(true);
- }
- if (name === 'string1') {
- expect(!!result).toBe(true);
- }
- if (name === 'string2') {
- expect(!!result).toBe(false);
- }
- }
- });
- it('rejects scopes for ranges that have already been claimed if set with (#set! capture.shy true)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string "\\"") @string.double
- ((string) @string.other (#set! capture.shy true))
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- const bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let first = true;
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- // First string.other should fail; second should succeed.
- if (name === 'string.other') {
- let expected = first ? false : true;
- first = false;
- expect(!!result).toBe(expected);
- }
- }
- });
- it('temporarily supports the deprecated (#set! test.shy true)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (comment) @comment
- (string "\\"") @string.double
- ((string) @string.other (#set! test.shy true))
- "=" @operator
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- const bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let first = true;
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- // First string.other should fail; second should succeed.
- if (name === 'string.other') {
- let expected = first ? false : true;
- first = false;
- expect(!!result).toBe(expected);
- }
- }
- });
- it('rejects scopes for ranges that fail test.first or test.last', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((string_fragment) @impossible.first
- (#is? test.first true))
- ((string_fragment) @impossible.last
- (#is? test.last true))
- ((string) "'" @punctuation.first
- (#is? test.first true))
- ((string) "'" @punctuation.last
- (#is? test.last true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- const bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- // Impossible for string_fragment to be the first or last child.
- if (name.startsWith('impossible')) {
- expect(!!result).toBe(false);
- }
- if (name === 'punctuation.first') {
- expect(node.id).toBe(node.parent.lastChild.id);
- } else if (name === 'punctuation.last') {
- expect(node.id).toBe(node.parent.firstChild.id);
- }
- }
- });
- it('temporarily supports the deprecated (#set! test.onlyIfFirst) and (#set! test.onlyIfLast)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((string_fragment) @impossible.first
- (#is? test.onlyIfFirst true))
- ((string_fragment) @impossible.last
- (#is? test.onlyIfLast true))
- ((string) "'" @punctuation.first
- (#is? test.onlyIfFirst true))
- ((string) "'" @punctuation.last
- (#is? test.onlyIfLast true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- // this is a comment
- const foo = "ahaha";
- const bar = 'troz'
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- for (let capture of captures) {
- let { node, name } = capture;
- let result = scopeResolver.store(capture);
- // Impossible for string_fragment to be the first or last child.
- if (name.startsWith('impossible')) {
- expect(!!result).toBe(false);
- }
- if (name === 'punctuation.first') {
- expect(node.id).toBe(node.parent.lastChild.id);
- } else if (name === 'punctuation.last') {
- expect(node.id).toBe(node.parent.firstChild.id);
- }
- }
- });
- it('supports test.firstOfType and test.lastOfType', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (formal_parameters (identifier) @first-param
- (#is? test.firstOfType identifier))
- (formal_parameters (identifier) @last-param
- (#is? test.lastOfType identifier))
- (formal_parameters "," @first-comma
- (#is? test.firstOfType ","))
- (formal_parameters "," @last-comma
- (#is? test.lastOfType ","))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud, troz) {}
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let matched = [];
- for (let capture of captures) {
- let range = scopeResolver.store(capture);
- if (range) { matched.push([capture, range]); }
- }
- expect(matched.length).toBe(4);
- expect(matched.map(pair => {
- return pair[0].name;
- })).toEqual(["first-param", "first-comma", "last-comma", "last-param"]);
- });
- it('supports test.lastTextOnRow', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ("||" @hanging-logical-operator
- (#is? test.lastTextOnRow true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- let x = foo ||
- bar;
- let y = foo || bar;
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let matched = [];
- for (let capture of captures) {
- let range = scopeResolver.store(capture);
- if (range) { matched.push(capture); }
- }
- expect(matched.length).toBe(1);
- expect(matched[0].node.startPosition.row).toBe(0);
- expect(matched.map(capture => capture.name)).toEqual(
- ["hanging-logical-operator"]);
- });
- it('supports test.firstTextOnRow', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ("||" @hanging-logical-operator
- (#is? test.firstTextOnRow true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- let x = foo
- || bar;
- let y = foo || bar;
- `);
- await languageMode.ready;
- let { scopeResolver, captures } = await getAllCaptures(grammar, languageMode);
- let matched = [];
- for (let capture of captures) {
- let range = scopeResolver.store(capture);
- if (range) { matched.push(capture); }
- }
- expect(matched.length).toBe(1);
- expect(matched[0].node.startPosition.row).toBe(1);
- expect(matched.map(capture => capture.name)).toEqual(
- ["hanging-logical-operator"]);
- });
- it('supports test.descendantOfType', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ("," @comma-inside-function
- (#is? test.descendantOfType function_declaration))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- let foo, bar, baz;
- function foo (one, two, three) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- expect(matched.every(cap => {
- return cap.node.startPosition.row === 1;
- })).toBe(true);
- });
- it('supports test.descendantOfType (multiple values)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ("," @comma-inside-function
- (#is? test.descendantOfType "function_declaration generator_function_declaration"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- let foo, bar, baz;
- function foo (one, two, three) {}
- function* bar(one, two, three) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(4);
- expect(matched.every((cap, index) => {
- let expectedRow = index >= 2 ? 2 : 1;
- return cap.node.startPosition.row === expectedRow;
- })).toBe(true);
- });
- it('supports test.ancestorOfType', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((function_declaration) @function-with-semicolons
- (#is? test.ancestorOfType ";"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo () {}
- function bar () {
- console.log(false);
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- expect(matched[0].node.text.includes("function bar")).toBe(true);
- });
- it('supports test.ancestorOfType (multiple values)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((function_declaration) @function-with-semicolons-or-booleans
- (#is? test.ancestorOfType "; false"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo () {}
- function bar () {
- console.log(false);
- }
- function baz () {
- console.log(false)
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- expect(matched[0].node.text.includes("function ba")).toBe(true);
- expect(matched[1].node.text.includes("function ba")).toBe(true);
- });
- it('supports test.descendantOfNodeWithData (without value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((function_declaration) @_IGNORE_
- (#match? @_IGNORE_ "foo")
- (#set! isSpecialFunction true))
- ("," @special-comma
- (#is? test.descendantOfNodeWithData isSpecialFunction))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {}
- function bar (lorem, ipsum, dolor) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- expect(matched.every(cap => {
- return cap.node.startPosition.row === 0 &&
- cap.node.text === ",";
- })).toBe(true);
- });
- it('supports test.descendantOfNodeWithData (with right value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((function_declaration) @_IGNORE_
- (#match? @_IGNORE_ "foo" )
- (#set! isSpecialFunction "troz"))
- ("," @special-comma
- (#is? test.descendantOfNodeWithData "isSpecialFunction troz"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {}
- function bar (lorem, ipsum, dolor) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- expect(matched.every(cap => {
- return cap.node.startPosition.row === 0 &&
- cap.node.text === ",";
- })).toBe(true);
- });
- it('supports test.descendantOfNodeWithData (with wrong value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((function_declaration) @_IGNORE_
- (#match? @_IGNORE_ "foo")
- (#set! isSpecialFunction "troz"))
- ("," @special-comma
- (#is? test.descendantOfNodeWithData "isSpecialFunction zort"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {}
- function bar (lorem, ipsum, dolor) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- // Wrong value, so test shouldn't pass.
- expect(matched.length).toBe(0);
- });
- it('supports test.type', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (formal_parameters _ @function-comma
- (#is? test.type ","))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- expect(matched.every(cap => {
- return cap.node.text === ",";
- })).toBe(true);
- });
- it('supports test.type with multiple types', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- (formal_parameters _ @thing
- (#is? test.type ", identifier"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {}
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(5);
- });
- it('supports test.hasError', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((statement_block) @messed-up-statement-block
- (#is? test.hasError true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if !troz zort();
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- expect(matched.every(cap => {
- return cap.name === 'messed-up-statement-block' && cap.node.hasError;
- })).toBe(true);
- });
- it('supports test.root', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((_) @is-root
- (#is? test.root true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (!troz) { zort(); }
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- expect(matched.every(cap => {
- return cap.name === 'is-root' && cap.node.type === 'program' &&
- !cap.node.parent;
- })).toBe(true);
- });
- it('supports test.lastTextOnRow', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ("||" @orphaned-operator
- (#is? test.lastTextOnRow true))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true ||
- false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- for (let cap of matched) {
- expect(cap.name).toBe('orphaned-operator');
- expect(cap.node.type).toBe('||');
- expect(cap.node.startPosition.row).toBe(2);
- }
- });
- it('supports test.rangeWithData (without value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((true) @_IGNORE_ (#set! isTrue true))
- ([ (true) (false) ] @optimistic-boolean
- (#is? test.rangeWithData isTrue))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- for (let cap of matched) {
- expect(cap.name).toBe('optimistic-boolean');
- expect(cap.node.text).toBe('true');
- }
- });
- it('supports test.rangeWithData (with right value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((true) @_IGNORE_ (#set! isTrue "exactly"))
- ([ (true) (false) ] @optimistic-boolean
- (#is? test.rangeWithData "isTrue exactly"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(2);
- for (let cap of matched) {
- expect(cap.name).toBe('optimistic-boolean');
- expect(cap.node.text).toBe('true');
- }
- });
- it('supports test.rangeWithData (with wrong value)', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((true) @_IGNORE_ (#set! isTrue "perhaps"))
- ([ (true) (false) ] @optimistic-boolean
- (#is? test.rangeWithData "isTrue exactly"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- // Values don't match, so the test shouldn't pass.
- expect(matched.length).toBe(0);
- });
- it('supports test.startsOnSameRowAs', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((false) @non-hanging-false
- (#is? test.startsOnSameRowAs parent.startPosition))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true ||
- false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- for (let cap of matched) {
- expect(cap.name).toBe('non-hanging-false');
- expect(cap.node.text).toBe('false');
- expect(cap.node.startPosition.row).toBe(1);
- }
- });
- it('supports test.endsOnSameRowAs', async () => {
- await grammar.setQueryForTest('highlightsQuery', `
- ((true) @non-hanging-true
- (#is? test.endsOnSameRowAs parent.endPosition))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true ||
- false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(1);
- for (let cap of matched) {
- expect(cap.name).toBe('non-hanging-true');
- expect(cap.node.text).toBe('true');
- expect(cap.node.startPosition.row).toBe(1);
- }
- });
- it('supports test.config (with no arguments)', async () => {
- atom.config.set('core.careAboutBooleans', true);
- await grammar.setQueryForTest('highlightsQuery', `
- ([(true) (false)] @boolean
- (#is? test.config core.careAboutBooleans))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer, config: atom.config });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(4);
- atom.config.set('core.careAboutBooleans', false);
- matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(0);
- });
- it('supports test.config (with boolean arguments)', async () => {
- atom.config.set('core.careAboutBooleans', true);
- await grammar.setQueryForTest('highlightsQuery', `
- ([(true) (false)] @boolean
- (#is? test.config "core.careAboutBooleans true"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer, config: atom.config });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(4);
- atom.config.set('core.careAboutBooleans', false);
- matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(0);
- });
- it('supports test.config (with number arguments)', async () => {
- atom.config.set('core.careAboutBooleans', 0);
- await grammar.setQueryForTest('highlightsQuery', `
- ([(true) (false)] @boolean
- (#is? test.config "core.careAboutBooleans 0"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer, config: atom.config });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(4);
- atom.config.set('core.careAboutBooleans', 1);
- matched = await getAllMatches(grammar, languageMode);
- expect(matched.length).toBe(0);
- });
- it('supports test.config (with string arguments)', async () => {
- atom.config.set('core.careAboutBooleans', "something");
- await grammar.setQueryForTest('highlightsQuery', `
- ([(true) (false)] @boolean
- (#is? test.config "core.careAboutBooleans something"))
- `);
- const languageMode = new WASMTreeSitterLanguageMode({ grammar, buffer, config: atom.config });
- buffer.setLanguageMode(languageMode);
- buffer.setText(dedent`
- function foo (bar, baz, thud) {
- if (true || false) { console.log('logic!'); }
- return true || false;
- }
- `);
- await languageMode.ready;
- let scopeResolver = makeScopeResolver(languageMode);
- let matched = await getAllMatchesWithScopeResolver(grammar, languageMode, scopeResolver);
- expect(matched.length).toBe(4);
- atom.config.set('core.careAboutBooleans', "something-else");
- matched = await getAllMatchesWithScopeResolver(grammar, languageMode, scopeResolver);
- expect(matched.length).toBe(0);
- atom.config.set(
- 'core.careAboutBooleans',
- 'something',
- { scope: [grammar.scopeName] }
- );
- matched = await getAllMatchesWithScopeResolver(grammar, languageMode, scopeResolver);
- expect(matched.length).toBe(4);
- atom.config.set('core.careAboutBooleans', "something");
- atom.config.set(
- 'core.careAboutBooleans',
- 'something-else',
- { scope: [grammar.scopeName] }
- );
- matched = await getAllMatchesWithScopeResolver(grammar, languageMode, scopeResolver);
- expect(matched.length).toBe(0);
- });
- it('supports test.injection', async () => {
- jasmine.useRealClock();
- await grammar.setQueryForTest('highlightsQuery', `
- ((escape_sequence) @regex-escape
- (#is? test.injection true))
- `);
- let regexGrammar = new WASMTreeSitterGrammar(atom.grammars, jsRegexGrammarPath, jsRegexConfig);
- await regexGrammar.setQueryForTest('highlightsQuery', `
- ((control_escape) @regex-escape
- (#is? test.injection true))
- `);
- atom.grammars.addGrammar(regexGrammar);
- grammar.addInjectionPoint({
- type: 'regex_pattern',
- language: () => 'js-regex',
- content: (node) => node,
- languageScope: null
- });
- const languageMode = new WASMTreeSitterLanguageMode({
- grammar,
- buffer,
- config: atom.config,
- grammars: atom.grammars
- });
- buffer.setText(String.raw`
- function foo (bar, baz, thud) {
- let newline = "\n";
- let newlineRegex = /lor\nem/;
- }
- `);
- buffer.setLanguageMode(languageMode);
- await languageMode.ready;
- let layers = languageMode.getAllLanguageLayers();
- expect(layers.length).toBe(2);
- let matched = [];
- for (let layer of layers) {
- let results = await getAllMatches(layer.grammar, languageMode, layer);
- matched.push(...results);
- }
- expect(matched.length).toBe(1);
- for (let cap of matched) {
- expect(cap.node.startPosition.row).toBe(3);
- }
- });
- });
- });
|