avajs/ava

Make line number selection work with TS and JSX syntax

Open

#3065 opened on Jul 10, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (20,600 stars) (1,408 forks)batch import
enhancementhelp wantedscope:globbingscope:internalsscope:typescript

Description

Line number selection relies on parsing the test file. This only supports JS syntax:

https://github.com/avajs/ava/blob/ac0d75d05d28e511b1b3654b09d11d602e360179/lib/worker/line-numbers.js#L9-L18

Acorn has a plugin for JSX. If we want to use that we need to decide whether to add it to AVA's dependencies or how else we register it.

There is no plugin for TypeScript. We'd have to work out a solution so that line number selection can work without using @ava/typescript. See https://github.com/avajs/ava/issues/3064 for making it work with @ava/typescript.

Contributor guide

Tech stack
javascripttypescript
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScript parsingAcorn plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the current line number selection code in lib/worker/line numbers.js which uses Acorn for JS parsing. Consider adding acorn jsx as a dependency to support JSX syntax. For TypeScript, explore using a lightweight TypeScript parser like @typescript eslint/typescript estree or a separate parsing step. Look at issue #3064 for integration with @ava/typescript. Test the solution with sample files containing TSX and JSX.