npmpackage.info

Gathering detailed insights and metrics for recrawl-sync

recrawl-sync

Filesystem crawler

2.2.3

MIT

TypeScript

3.77 kB

26,318,540 2.5

Installations

npm install recrawl-sync

Score

89.2

Supply Chain

67.1

Quality

74.4

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

1

Total

3

Closed

0

Merged

2

Issues

Open

3

Total

4

Closed

1

Releases

v2.0.1

Published on 01 Apr 2021

View all 1 releases

Developer

aleclarson

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.7.0

NPM Version

8.15.0 Statistics

1 Stars

70 Commits

2 Watching

4 Branches

2 Contributors

Updated on 04 Dec 2022

Bundle Size

10.07 kB

Minified

3.77 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

26,318,540

Last day

-30.6%

21,397

Compared to previous day

Last week

-4.4%

149,924

Compared to previous week

Last month

2.6%

653,728

Compared to previous month

Last year

3.5%

9,955,047

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@cush/relative glob-regex slash sucrase tslib

Dev Dependencies

@alloc/prettier-config @sucrase/jest-plugin @types/jest @types/node jest prettier typescript

Versions

recrawl

Collect the descendants of a directory.

1import { recrawl } from 'recrawl'
2
3// Create a crawl function.
4// These are the default options.
5const crawl = recrawl({
6  only: [],
7  skip: [],
8  deep: true,
9  follow: false,
10})
11
12// The result is an array when `follow` is false, else an object.
13const files = crawl(root)
14
15// Provide your own array/object.
16crawl(root, files)
17
18// Provide an iterator.
19crawl(root, (file, link) => {
20  // The `file` argument is relative to the root.
21  // The `link` argument is null for non-symlinks. It will be absolute if the target is outside the root.
22})

You can use the crawl() export if you don't want to reuse the configured crawler.

1import { crawl } from 'recrawl'
2
3crawl(root, {
4  only: [],
5  skip: [],
6  deep: true,
7  follow: false,
8})

Options

only?: (string|RegExp)[]
skip?: (string|RegExp)[]
absolute?: boolean
deep?: boolean
depth?: number
enter?: function
filter?: function
follow?: boolean|number|function
adapter?: FileAdapter

The only and skip options should be self-explanatory. Paths matching any of the only patterns are good. When only is an empty array, all paths are good. Paths matching any of the skip patterns are bad. When skip is an empty array, no paths are bad. The skip patterns override the only patterns.

The absolute option converts matching file paths into their absolute form.

To avoid crawling sub-directories, set deep to false or depth to 0. You should never define both deep and depth, because the depth option implies deep when it's greater than zero. If neither deep nor depth are defined, the default depth is infinite.

The enter option is called whenever a directory is encountered. It's passed the directory path and the current depth. You may return a falsy value to avoid crawling a directory.

The filter option is called whenever a filename is encountered. It's passed the filename and its basename. You may return a falsy value to skip a filename. The only and skip options are applied before this option is called.

To follow all symlinks, set follow to true. For greater control, use a function. It's called whenever a symlink is encountered. You may return a falsy value to avoid following a symlink. It's passed the symlink path and the current link depth. If you only need to limit the link depth, you can set follow to a number, where zero is equivalent to false.

The adapter option lets you provide your own filesystem.

Gotchas

Directory symlinks are treated the same as real directories
Directories are not affected by the only option

Pattern syntax

Recrawl has its own take on globbing.

When a path has no separators (/), only the basename is matched.

1'*.js' // matches 'a.js' and 'a/b.js'

Recursivity is implicit.

1'a/b' // identical to '**/a/b'

Use a leading separator to match against the root.

1'/*.js' // matches 'a.js' not 'a/b.js'

Use a trailing separator to match all descendants.

1'foo/' // matches 'foo/bar' and 'foo/bar/baz' etc

Regular expression syntax is supported. (except dot-all)

1'*.jsx?' // matches 'a.js' and 'b.jsx'
2'*.(js|ts)' // matches 'a.js' and 'b.ts'

Recursive globbing is supported.

1'foo/**/bar' // matches 'foo/bar' and 'foo/a/b/c/bar' etc

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

License

Determines if the project has defined a license.

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

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

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

Security-Policy

Determines if the project has published a security policy.

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

45 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.5

/10

Last Scanned on 2024-11-25

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