oakmac/parinfer

refactor tests / testing approach

Open

#13 opened on Sep 6, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (0 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

re: https://github.com/shaunlebron/parinfer/issues/168

I would like to move away from the "test cases in markdown files with custom parsing" approach.

I think the custom annotation syntax is valuable for seeing how Parinfer operates. The way it is currently parsed and used by the test suite is pretty opaque right now; I think the implementation could be cleaner.

Implementation TODO

  • separate the annotation syntax parsing / reconstruction into it's own library with dedicated test suite (possibly a separate repo?)
  • create a kidif file for each test case
  • give each test case a stable id (use the 1000's for indent mode, 2000's for paren mode, 3000's for smart mode)
    • done with PR #14
  • write a script that builds a markdown file from the test cases for readability / exploring how Parinfer works

Contributor guide

Research direction
Review the current test suite in the repository, understand how test cases are parsed from markdown, and design a new approach using kidif files. Look at the linked issue #168 and the kidif.js library for reference.
Tech stack
javascript
Domain
testing
Issue type
Refactor
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScripttesting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60