npmpackage.info

vinyl-paths

Get the file paths in a `vinyl` stream

5.0.0

MIT

JavaScript

391.00 B

13,037,302 3.5

Installations

npm install vinyl-paths

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=14.16

Node Version

14.19.3

NPM Version

8.3.2 Score

Supply Chain

82.6

Quality

75.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

4

Closed

2

Merged

2

Issues

Open

0

Total

8

Closed

8

Releases

v5.0.0

Published on 26 Jul 2022

v4.0.0

Published on 15 Aug 2021

v3.0.1

Published on 13 Nov 2019

v3.0.0

Published on 28 May 2019

View all 4 releases

Contributors

Unable to fetch Contributors

View all 4 contributors

Languages

JavaScript

JavaScript (100%)

Developer

sindresorhus

Download Statistics

Total Downloads

13,037,302

Last Day

1,199

Last Week

5,982

Last Month

58,149

Last Year

997,361

GitHub Statistics

61 Stars

20 Commits

5 Forks

7 Watching

1 Branches

4 Contributors

Bundle Size

684.00 B

Minified

391.00 B

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/sindresorhus

Maintainers

Package Meta Information

Latest Version

5.0.0

Package Id

vinyl-paths@5.0.0

Unpacked Size

3.97 kB

Size

2.04 kB

File Count

NPM Version

8.3.2

Node Version

14.19.3

Total Downloads

Cumulative downloads

Total Downloads

13,037,302

Last day

-12.8%

1,199

Compared to previous day

Last week

-53.2%

5,982

Compared to previous week

Last month

-23.5%

58,149

Compared to previous month

Last year

-29%

997,361

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

easy-transform-stream

Dev Dependencies

ava p-event vinyl xo

Versions

vinyl-paths

Get the file paths in a vinyl stream

Useful when you need to use the file paths from a Gulp pipeline in an async Node.js package.

Simply pass an async function such as del and this package will provide each path in the stream as the first argument.

Install

1npm install vinyl-paths

Usage

1// gulpfile.js
2import gulp from 'gulp';
3import stripDebug from 'gulp-strip-debug';
4import del from 'del';
5import vinylPaths from 'vinyl-paths';
6
7// Log file paths in the stream
8export function log() {
9	return gulp.src('app/*')
10		.pipe(stripDebug())
11		.pipe(vinylPaths(async paths => {
12			console.log('Paths:', paths);
13		});
14}
15
16// Delete files in the stream
17export function delete() {
18	return gulp.src('app/*')
19		.pipe(stripDebug())
20		.pipe(vinylPaths(del));
21}
22
23// Or if you need to use the paths after the pipeline
24export function delete2() {
25	return new Promise((resolve, reject) => {
26		const vp = vinylPaths();
27
28		gulp.src('app/*')
29			.pipe(vp)
30			.pipe(gulp.dest('dist'))
31			.on('end', async () => {
32				try {
33					await del(vp.paths);
34					resolve();
35				} catch (error) {
36					reject(error);
37				}
38			});
39	});
40}

You should only use a vanilla Node.js package like this if you're already using other plugins in the pipeline, otherwise just use the module directly as gulp.src is costly. Remember that Gulp tasks can return promises as well as streams!

API

vinylPaths(callback?)

The optional callback will receive a file path for every file and is expected to return a promise. An array of the file paths so far is available as a paths property on the stream.

callback(path)

gulp-revert-path - Revert the previous file.path change

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.

1

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

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

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

Score

3.5

/10

Last Scanned on 2024-12-30

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

Other packages similar to vinyl-paths

@types/vinyl-paths

5.0.0

TypeScript definitions for vinyl-paths

@ryancavanaugh/vinyl-paths

0.0.13-alpha

Type definitions for vinyl-paths from https://www.github.com/DefinitelyTyped/DefinitelyTyped

retyped-vinyl-paths-tsd-ambient

0.0.0-0

TypeScript typings for vinyl-paths

byted-people-vinyl-paths

1.0.0-occupy

vinyl-paths

Installations

Developer Guide

No

ESM

>=14.16

14.19.3

8.3.2

Score

Pull Requests

0

4

2

2

Issues

0

8

8

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

sindresorhus

Download Statistics

GitHub Statistics

Bundle Size

684.00 B

391.00 B

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

13,037,302

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

vinyl-paths

Install

Usage

API

vinylPaths(callback?)

callback(path)

Related

10

10

10

10

1

0

0

0

0

0

0

0

0

3.5

/10

Other packages similar to vinyl-paths