beautifully annotate source code with a message, given an index, like a parser or compiler
npm install annotate-codebeautifully 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 |
`` const input = 01234 const message = 'some error message' let i = 0 print( print( print( print( print( print( print( print( print( print( print( print( print( print(#
basic
#
example/basic.ts view sourcets
import { annotate } from 'annotate-code'
6789 and a 2
line 3
and 4
another 5
error should be here 6
and 7
more 8
lines 9
const print = (m: string) => {
console.log(++i + ' -------------------------------------')
console.log(m)
}
annotate({
message,
index: 48,
size: 6,
input,
}).message
)
annotate({
message,
index: 0,
input,
}).message
)
annotate({
message,
index: input.length,
input,
}).message
)
annotate({
message,
index: 0,
input,
linesAfter: 5,
}).message
)
annotate({
message,
index: 0,
input,
linesAfter: 100,
}).message
)
annotate({
message,
index: input.length,
linesBefore: 5,
input,
}).message
)
annotate({
message,
index: input.length,
linesBefore: 100,
input,
}).message
)
annotate({
message,
index: 7,
linesAfter: 100,
input,
}).message
)
annotate({
message,
index: 5,
linesBefore: 2,
input,
}).message
)
annotate({
message,
index: 0,
linesAfter: 1,
input,
}).message
)
annotate({
message,
index: 0,
linesAfter: 1,
input: 12345,
}).message
)
annotate({
message,
index: 0,
input: ,
}).message
)
annotate({
message,
index: 1,
input: ,
}).message
)
annotate({
message,
index: -1,
input: abc,``
}).message
)
{ #
src/index.ts#L44 annotate({ index, input, linesAfter, linesBefore, message, showLineNumbers, size }) – Annotates a source code string given an index and a message.
#
settings
annotate({ index, input, linesAfter, linesBefore, message, showLineNumbers, size }) =>
}
All contributions are welcome!