annotate-code

beautifully annotate source code with a message, given an index, like a parser or compiler

npm i annotate-code

pnpm add annotate-code

yarn add annotate-code

Examples

# basic

# view source

example/basic.ts

import { annotate } from 'annotate-code'

const input = `01234
6789 and a 2
line 3
and 4
another 5
error should be here 6
and 7
more 8
lines 9
`

const message = 'some error message'

let i = 0
const print = (m: string) => {
  console.log(++i + ' -------------------------------------')
  console.log(m)
}

print(
  annotate({
    message,
    index: 48,
    size: 6,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    input,
  }).message
)

print(
  annotate({
    message,
    index: input.length,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    input,
    linesAfter: 5,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    input,
    linesAfter: 100,
  }).message
)

print(
  annotate({
    message,
    index: input.length,
    linesBefore: 5,
    input,
  }).message
)

print(
  annotate({
    message,
    index: input.length,
    linesBefore: 100,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 7,
    linesAfter: 100,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 5,
    linesBefore: 2,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    linesAfter: 1,
    input,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    linesAfter: 1,
    input: `12345`,
  }).message
)

print(
  annotate({
    message,
    index: 0,
    input: ``,
  }).message
)

print(
  annotate({
    message,
    index: 1,
    input: ``,
  }).message
)

print(
  annotate({
    message,
    index: -1,
    input: `abc`,
  }).message
)

API

# annotate({ index, input, linesAfter, linesBefore, message, showLineNumbers, size }) – Annotates a source code string given an index and a message.

src/index.ts#L44

# settings
{

# index – The index position

src/index.ts#L55

number

# input – The code to annotate

src/index.ts#L54

string

# linesAfter – How many lines after to show

src/index.ts#L57

number

# linesBefore – How many lines before to show

src/index.ts#L56

number

# message – The message to display

src/index.ts#L53

string

# showLineNumbers – Whether to show line numbers

src/index.ts#L59

boolean

# size – The size of the arrows ^^^^

src/index.ts#L58

number

}

annotate({ index, input, linesAfter, linesBefore, message, showLineNumbers, size })  =>

{
# col

src/index.ts#L62

number

# line

src/index.ts#L61

number

# message

src/index.ts#L63

string

}

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas