commonmark / commonmark/cmark

Identify the position in the source file as offset

Open
#253 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
2k
Forks
691
Avg merge
1d 16h
Merged PRs (30d)
1

Description

When parsing using the AST, we can use cmark_node_get_start_line (and friends) to get the start/end lines and columns of a node. Would it be possible to also read the offset in the buffer? I could recompute this myself, but I think it'd be more robust to build this into the library (if people find this an interesting feature).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the AST position APIs, including cmark_node_get_start_line and related start/end line and column accessors, through the parser and node data structures. Determine how a source-buffer offset should be represented and exposed, then add coverage showing that reported offsets match the corresponding node positions.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.