unist icon indicating copy to clipboard operation
unist copied to clipboard

What is a `column` or `offset`, exactly?

Open wooorm opened this issue 2 years ago • 0 comments

Initial checklist

Problem

…or are they supposed to be vague and should we reflect that?

For ASCII characters, such info is pretty clear. But once you get to other unicode characters, taking emoji as a well-known example, it gets complex. And, unist is designed for other programming languages too, practically now with Rust, we may need to choose how to represent this across languages.

There are two main ways that positional info like this is used:

  1. to access the source string: if there is something appearing from 1000 to 1002, a user will want to do doc.slice(1000, 1002) to access that thing. In Rust, 1000 and 1002, in an example of &doc[1000..1002], will yield a different result
  2. to point a code editor to such a thing, for warnings and such, so that the squigly lines, or “jump to” are correct

To make the first easy and fast, it makes a lot of sense to use the positions that are based on how the host language stores strings. But that means markdown-rs and micromark will yield different results. Quickly checking VS Code, injecting 👨‍👩‍👧‍👦 into the document, seems to increment by 7, which equals [...'👨‍👩‍👧‍👦'].length. So that’s different from what markdown-rs and micromark use. We can also be vague about this here in the spec, and replace the section added in https://github.com/syntax-tree/unist/commit/49032b9 to reflect that. Or we could adhere to that?

Solution

  • a) Make vague
  • b) make everything consistent

Alternatives

?

wooorm avatar Feb 04 '23 14:02 wooorm