File Context Printer Quickstart

This quickstart builds off Getting Started and assumes you have a native Reason project set up.

Install Pastel

To install File Context Printer in your project with esy, run

esy add @reason-native/file-context-printer

This will add @reason-native/file-context-printer into your package.json.

In order to use File Context Printer, you must add it to your build system. With dune, file-context-printer.lib must be added to the relevant dune file:

(libraries ... file-context-printer.lib)

Sample Code

Start by initializing a File Context Printer module:

module FCP =
  FileContextPrinter.Make({
    let config =
      FileContextPrinter.Config.initialize({linesBefore: 3, linesAfter: 3});
  });

From there, extract and print file context like so:

let start = (
  7, /* start line */
  1 /* start char */
);
let end = (
  7, /* start line */
  11 /* start char */
);
FCP.printFile(
  "src/file-context-printer/test/DummyFile.re",
  (start, end),
)

 4 ┆  * This source code is licensed under the ...
 5 ┆  * LICENSE file in the root directory of ...
 6 ┆  */;
 7 ┆ let myFunction = () => print_endline("do something");
 8 ┆ 
 9 ┆ let ex = (arg) => {
10 ┆     if(arg === true) {