Installations

npm install code-excerpt

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

0

Total

1

Closed

1

Releases

4

v4.0.0

Published on 06 Feb 2022

v3.0.0

Published on 16 Jun 2020

2.0.0

Published on 05 Jan 2017

1.1.0

Published on 05 Jan 2017

View all 4 releases

Developer

vadimdemedes

Developer Guide

BETA

Module System

ESM

Min. Node Version

^12.20.0 || ^14.13.1 || >=16.0.0

Typescript Support

Yes

Node Version

14.19.0

NPM Version

6.14.16 Statistics

8 Stars

29 Commits

1 Forks

3 Watching

1 Branches

2 Contributors

Updated on 18 Jun 2022

Languages

JavaScript (69.3%)

TypeScript (30.7%)

Total Downloads

Cumulative downloads

Total Downloads

125,300,064

Last day

3.9%

220,557

Compared to previous day

Last week

5.7%

1,168,834

Compared to previous week

Last month

12%

4,873,141

Compared to previous month

Last year

56.9%

44,110,181

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

convert-to-spaces

Dev Dependencies

6

@sindresorhus/tsconfig @vdemedes/prettier-config ava prettier typescript xo

Versions

code-excerpt

Extract code excerpts

Install

$ npm install --save code-excerpt

Usage

1import codeExcerpt from 'code-excerpt';
2
3const source = `
4'use strict';
5
6function someFunc() {}
7
8module.exports = () => {
9	const a = 1;
10	const b = 2;
11	const c = 3;
12
13	someFunc();
14};
15`.trim();
16
17const excerpt = codeExcerpt(source, 5);
18//=> [
19//	{line: 2, value: ''},
20//	{line: 3, value: 'function someFunc() {}'},
21//	{line: 4, value: ''},
22//	{line: 5, value: 'module.exports = () => {'},
23//	{line: 6, value: '  const a = 1;'},
24//	{line: 7, value: '  const b = 2;'},
25//	{line: 8, value: '  const c = 3;'}
26// ]

API

codeExcerpt(source, line, [options])

source

Type: string

Source code.

line

Type: number

Line number to extract excerpt for.

options

around

Type: number
Default: 3

Number of surrounding lines to extract.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More