Blame view

node_modules/babel-code-frame/README.md 1.04 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
  # babel-code-frame
  
  > Generate errors that contain a code frame that point to source locations.
  
  ## Install
  
  ```sh
  npm install --save-dev babel-code-frame
  ```
  
  ## Usage
  
  ```js
  import codeFrame from 'babel-code-frame';
  
  const rawLines = `class Foo {
    constructor()
  }`;
  const lineNumber = 2;
  const colNumber = 16;
  
  const result = codeFrame(rawLines, lineNumber, colNumber, { /* options */ });
  
  console.log(result);
  ```
  
  ```sh
    1 | class Foo {
  > 2 |   constructor()
      |                ^
    3 | }
  ```
  
  If the column number is not known, you may pass `null` instead.
  
  ## Options
  
  ### `highlightCode`
  
  `boolean`, defaults to `false`.
  
  Toggles syntax highlighting the code as JavaScript for terminals.
  
  ### `linesAbove`
  
  `number`, defaults to `2`.
  
  Adjust the number of lines to show above the error.
  
  ### `linesBelow`
  
  `number`, defaults to `3`.
  
  Adjust the number of lines to show below the error.
  
  ### `forceColor`
  
  `boolean`, defaults to `false`.
  
  Enable this to forcibly syntax highlight the code as JavaScript (for non-terminals); overrides `highlightCode`.