mirror of
https://github.com/github/codeql-action.git
synced 2025-12-27 01:30:10 +08:00
bea5e4b220
The [release notes](https://github.com/avajs/ava/releases/tag/v4.3.3) mention compatibility with Node 18.8.
66 lines
960 B
Markdown
66 lines
960 B
Markdown
# code-excerpt 
|
|
|
|
> Extract code excerpts
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save code-excerpt
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import codeExcerpt from 'code-excerpt';
|
|
|
|
const source = `
|
|
'use strict';
|
|
|
|
function someFunc() {}
|
|
|
|
module.exports = () => {
|
|
const a = 1;
|
|
const b = 2;
|
|
const c = 3;
|
|
|
|
someFunc();
|
|
};
|
|
`.trim();
|
|
|
|
const excerpt = codeExcerpt(source, 5);
|
|
//=> [
|
|
// {line: 2, value: ''},
|
|
// {line: 3, value: 'function someFunc() {}'},
|
|
// {line: 4, value: ''},
|
|
// {line: 5, value: 'module.exports = () => {'},
|
|
// {line: 6, value: ' const a = 1;'},
|
|
// {line: 7, value: ' const b = 2;'},
|
|
// {line: 8, value: ' const c = 3;'}
|
|
// ]
|
|
```
|
|
|
|
## API
|
|
|
|
### codeExcerpt(source, line, [options])
|
|
|
|
#### source
|
|
|
|
Type: `string`
|
|
|
|
Source code.
|
|
|
|
#### line
|
|
|
|
Type: `number`
|
|
|
|
Line number to extract excerpt for.
|
|
|
|
#### options
|
|
|
|
##### around
|
|
|
|
Type: `number`<br>
|
|
Default: `3`
|
|
|
|
Number of surrounding lines to extract.
|